From f89c250c8e210b376e40a1b522bd51d553c1e7e5 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Wed, 15 Nov 2023 14:43:30 +0100 Subject: [PATCH 01/63] Change workflow type --- .github/workflows/base_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/base_schema.yml b/.github/workflows/base_schema.yml index b27f7e1..574dbb4 100644 --- a/.github/workflows/base_schema.yml +++ b/.github/workflows/base_schema.yml @@ -1,7 +1,7 @@ name: Update Admin API on: - workflow_call: + workflow_dispatch: inputs: shopware_version: description: "Shopware version" From c13b4fccee1732a95625ddda4d06a19832490247 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Fri, 17 Nov 2023 11:43:18 +0100 Subject: [PATCH 02/63] Add workflow call --- .github/workflows/base_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/base_schema.yml b/.github/workflows/base_schema.yml index 574dbb4..b27f7e1 100644 --- a/.github/workflows/base_schema.yml +++ b/.github/workflows/base_schema.yml @@ -1,7 +1,7 @@ name: Update Admin API on: - workflow_dispatch: + workflow_call: inputs: shopware_version: description: "Shopware version" From 21a2bfb9e2c505f696ec75cb432a18fd246d1c31 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 09:41:30 +0100 Subject: [PATCH 03/63] [create-pull-request] automated change (#102) Co-authored-by: shopwareBot --- adminapi.json | 11414 +++++++++++++++++++++++------------------------- 1 file changed, 5343 insertions(+), 6071 deletions(-) diff --git a/adminapi.json b/adminapi.json index ec8fec6..7b158b0 100644 --- a/adminapi.json +++ b/adminapi.json @@ -3,7 +3,7 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.9999999.9999999-dev" + "version": "6.5.6.1" }, "servers": [ { @@ -3494,14 +3494,14 @@ } } }, - "/app-shipping-method": { + "/app-template": { "get": { "tags": [ - "App Shipping Method" + "App Template" ], - "summary": "List with basic information of App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "getAppShippingMethodList", + "summary": "List with basic information of App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppTemplateList", "parameters": [ { "name": "limit", @@ -3530,7 +3530,7 @@ ], "responses": { "200": { - "description": "List of App Shipping Method resources.", + "description": "List of App Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3549,7 +3549,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } ] @@ -3563,16 +3563,16 @@ "type": "object", "properties": { "first": { - "example": "/app-shipping-method?limit=25" + "example": "/app-template?limit=25" }, "last": { - "example": "/app-shipping-method?limit=25&page=11" + "example": "/app-template?limit=25&page=11" }, "next": { - "example": "/app-shipping-method?limit=25&page=4" + "example": "/app-template?limit=25&page=4" }, "prev": { - "example": "/app-shipping-method?limit=25&page=2" + "example": "/app-template?limit=25&page=2" } } } @@ -3593,7 +3593,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3608,11 +3608,11 @@ }, "post": { "tags": [ - "App Shipping Method" + "App Template" ], - "summary": "Create a new App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "createAppShippingMethod", + "summary": "Create a new App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createAppTemplate", "parameters": [ { "name": "_response", @@ -3634,7 +3634,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" }, "included": { "type": "array", @@ -3648,14 +3648,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -3667,7 +3667,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3676,7 +3676,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3690,19 +3690,19 @@ } } }, - "/app-shipping-method/{id}": { + "/app-template/{id}": { "get": { "tags": [ - "App Shipping Method" + "App Template" ], - "summary": "Detailed information about a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "getAppShippingMethod", + "summary": "Detailed information about a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_shipping_method", + "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", @@ -3712,7 +3712,7 @@ ], "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -3724,7 +3724,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3733,7 +3733,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3748,16 +3748,16 @@ }, "delete": { "tags": [ - "App Shipping Method" + "App Template" ], - "summary": "Delete a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "deleteAppShippingMethod", + "summary": "Delete a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteAppTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_shipping_method", + "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", @@ -3788,16 +3788,16 @@ }, "patch": { "tags": [ - "App Shipping Method" + "App Template" ], - "summary": "Partially update information about a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "updateAppShippingMethod", + "summary": "Partially update information about a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateAppTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_shipping_method", + "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", @@ -3815,14 +3815,14 @@ } ], "requestBody": { - "description": "Partially update information about a App Shipping Method resource.", + "description": "Partially update information about a App Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" }, "included": { "type": "array", @@ -3836,14 +3836,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -3855,7 +3855,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3864,7 +3864,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3881,14 +3881,14 @@ } } }, - "/app-template": { + "/category": { "get": { "tags": [ - "App Template" + "Category" ], - "summary": "List with basic information of App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppTemplateList", + "summary": "List with basic information of Category resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCategoryList", "parameters": [ { "name": "limit", @@ -3917,7 +3917,7 @@ ], "responses": { "200": { - "description": "List of App Template resources.", + "description": "List of Category resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3936,7 +3936,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } ] @@ -3950,16 +3950,16 @@ "type": "object", "properties": { "first": { - "example": "/app-template?limit=25" + "example": "/category?limit=25" }, "last": { - "example": "/app-template?limit=25&page=11" + "example": "/category?limit=25&page=11" }, "next": { - "example": "/app-template?limit=25&page=4" + "example": "/category?limit=25&page=4" }, "prev": { - "example": "/app-template?limit=25&page=2" + "example": "/category?limit=25&page=2" } } } @@ -3980,7 +3980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -3995,11 +3995,11 @@ }, "post": { "tags": [ - "App Template" + "Category" ], - "summary": "Create a new App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createAppTemplate", + "summary": "Create a new Category resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCategory", "parameters": [ { "name": "_response", @@ -4021,7 +4021,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" }, "included": { "type": "array", @@ -4035,14 +4035,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } }, "responses": { "200": { - "description": "Detail of AppTemplate", + "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { @@ -4054,7 +4054,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -4063,7 +4063,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -4077,19 +4077,19 @@ } } }, - "/app-template/{id}": { + "/category/{id}": { "get": { "tags": [ - "App Template" + "Category" ], - "summary": "Detailed information about a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppTemplate", + "summary": "Detailed information about a Category resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_template", + "description": "Identifier for the category", "required": true, "schema": { "type": "string", @@ -4099,7 +4099,7 @@ ], "responses": { "200": { - "description": "Detail of AppTemplate", + "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { @@ -4111,7 +4111,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -4120,7 +4120,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -4135,16 +4135,16 @@ }, "delete": { "tags": [ - "App Template" + "Category" ], - "summary": "Delete a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteAppTemplate", + "summary": "Delete a Category resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_template", + "description": "Identifier for the category", "required": true, "schema": { "type": "string", @@ -4175,16 +4175,16 @@ }, "patch": { "tags": [ - "App Template" + "Category" ], - "summary": "Partially update information about a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateAppTemplate", + "summary": "Partially update information about a Category resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_template", + "description": "Identifier for the category", "required": true, "schema": { "type": "string", @@ -4202,14 +4202,14 @@ } ], "requestBody": { - "description": "Partially update information about a App Template resource.", + "description": "Partially update information about a Category resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" }, "included": { "type": "array", @@ -4223,14 +4223,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } }, "responses": { "200": { - "description": "Detail of AppTemplate", + "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { @@ -4242,7 +4242,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -4251,7 +4251,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/Category" } } } @@ -4268,14 +4268,14 @@ } } }, - "/category": { + "/cms-block": { "get": { "tags": [ - "Category" + "Cms Block" ], - "summary": "List with basic information of Category resources.", + "summary": "List with basic information of Cms Block resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCategoryList", + "operationId": "getCmsBlockList", "parameters": [ { "name": "limit", @@ -4304,7 +4304,7 @@ ], "responses": { "200": { - "description": "List of Category resources.", + "description": "List of Cms Block resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4323,7 +4323,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } ] @@ -4337,16 +4337,16 @@ "type": "object", "properties": { "first": { - "example": "/category?limit=25" + "example": "/cms-block?limit=25" }, "last": { - "example": "/category?limit=25&page=11" + "example": "/cms-block?limit=25&page=11" }, "next": { - "example": "/category?limit=25&page=4" + "example": "/cms-block?limit=25&page=4" }, "prev": { - "example": "/category?limit=25&page=2" + "example": "/cms-block?limit=25&page=2" } } } @@ -4367,7 +4367,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4382,11 +4382,11 @@ }, "post": { "tags": [ - "Category" + "Cms Block" ], - "summary": "Create a new Category resources.", + "summary": "Create a new Cms Block resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCategory", + "operationId": "createCmsBlock", "parameters": [ { "name": "_response", @@ -4408,7 +4408,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" }, "included": { "type": "array", @@ -4422,14 +4422,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } }, "responses": { "200": { - "description": "Detail of Category", + "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -4441,7 +4441,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4450,7 +4450,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4464,19 +4464,19 @@ } } }, - "/category/{id}": { + "/cms-block/{id}": { "get": { "tags": [ - "Category" + "Cms Block" ], - "summary": "Detailed information about a Category resource.", + "summary": "Detailed information about a Cms Block resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCategory", + "operationId": "getCmsBlock", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the category", + "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", @@ -4486,7 +4486,7 @@ ], "responses": { "200": { - "description": "Detail of Category", + "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -4498,7 +4498,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4507,7 +4507,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4522,16 +4522,16 @@ }, "delete": { "tags": [ - "Category" + "Cms Block" ], - "summary": "Delete a Category resource.", + "summary": "Delete a Cms Block resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCategory", + "operationId": "deleteCmsBlock", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the category", + "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", @@ -4562,16 +4562,16 @@ }, "patch": { "tags": [ - "Category" + "Cms Block" ], - "summary": "Partially update information about a Category resource.", + "summary": "Partially update information about a Cms Block resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCategory", + "operationId": "updateCmsBlock", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the category", + "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", @@ -4589,14 +4589,14 @@ } ], "requestBody": { - "description": "Partially update information about a Category resource.", + "description": "Partially update information about a Cms Block resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" }, "included": { "type": "array", @@ -4610,14 +4610,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } }, "responses": { "200": { - "description": "Detail of Category", + "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -4629,7 +4629,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4638,7 +4638,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4655,14 +4655,14 @@ } } }, - "/cms-block": { + "/cms-page": { "get": { "tags": [ - "Cms Block" + "Cms Page" ], - "summary": "List with basic information of Cms Block resources.", + "summary": "List with basic information of Cms Page resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsBlockList", + "operationId": "getCmsPageList", "parameters": [ { "name": "limit", @@ -4691,7 +4691,7 @@ ], "responses": { "200": { - "description": "List of Cms Block resources.", + "description": "List of Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4710,7 +4710,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } ] @@ -4724,16 +4724,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-block?limit=25" + "example": "/cms-page?limit=25" }, "last": { - "example": "/cms-block?limit=25&page=11" + "example": "/cms-page?limit=25&page=11" }, "next": { - "example": "/cms-block?limit=25&page=4" + "example": "/cms-page?limit=25&page=4" }, "prev": { - "example": "/cms-block?limit=25&page=2" + "example": "/cms-page?limit=25&page=2" } } } @@ -4754,7 +4754,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -4769,11 +4769,11 @@ }, "post": { "tags": [ - "Cms Block" + "Cms Page" ], - "summary": "Create a new Cms Block resources.", + "summary": "Create a new Cms Page resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsBlock", + "operationId": "createCmsPage", "parameters": [ { "name": "_response", @@ -4795,7 +4795,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" }, "included": { "type": "array", @@ -4809,14 +4809,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } }, "responses": { "200": { - "description": "Detail of CmsBlock", + "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4828,7 +4828,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -4837,7 +4837,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -4851,19 +4851,19 @@ } } }, - "/cms-block/{id}": { + "/cms-page/{id}": { "get": { "tags": [ - "Cms Block" + "Cms Page" ], - "summary": "Detailed information about a Cms Block resource.", + "summary": "Detailed information about a Cms Page resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsBlock", + "operationId": "getCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_block", + "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", @@ -4873,7 +4873,7 @@ ], "responses": { "200": { - "description": "Detail of CmsBlock", + "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4885,7 +4885,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -4894,7 +4894,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -4909,16 +4909,16 @@ }, "delete": { "tags": [ - "Cms Block" + "Cms Page" ], - "summary": "Delete a Cms Block resource.", + "summary": "Delete a Cms Page resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsBlock", + "operationId": "deleteCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_block", + "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", @@ -4949,16 +4949,16 @@ }, "patch": { "tags": [ - "Cms Block" + "Cms Page" ], - "summary": "Partially update information about a Cms Block resource.", + "summary": "Partially update information about a Cms Page resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsBlock", + "operationId": "updateCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_block", + "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", @@ -4976,14 +4976,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Block resource.", + "description": "Partially update information about a Cms Page resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" }, "included": { "type": "array", @@ -4997,14 +4997,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } }, "responses": { "200": { - "description": "Detail of CmsBlock", + "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -5016,7 +5016,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -5025,7 +5025,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/CmsPage" } } } @@ -5042,14 +5042,14 @@ } } }, - "/cms-page": { + "/cms-section": { "get": { "tags": [ - "Cms Page" + "Cms Section" ], - "summary": "List with basic information of Cms Page resources.", + "summary": "List with basic information of Cms Section resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsPageList", + "operationId": "getCmsSectionList", "parameters": [ { "name": "limit", @@ -5078,7 +5078,7 @@ ], "responses": { "200": { - "description": "List of Cms Page resources.", + "description": "List of Cms Section resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5097,7 +5097,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } ] @@ -5111,16 +5111,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-page?limit=25" + "example": "/cms-section?limit=25" }, "last": { - "example": "/cms-page?limit=25&page=11" + "example": "/cms-section?limit=25&page=11" }, "next": { - "example": "/cms-page?limit=25&page=4" + "example": "/cms-section?limit=25&page=4" }, "prev": { - "example": "/cms-page?limit=25&page=2" + "example": "/cms-section?limit=25&page=2" } } } @@ -5141,7 +5141,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5156,11 +5156,11 @@ }, "post": { "tags": [ - "Cms Page" + "Cms Section" ], - "summary": "Create a new Cms Page resources.", + "summary": "Create a new Cms Section resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsPage", + "operationId": "createCmsSection", "parameters": [ { "name": "_response", @@ -5182,7 +5182,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" }, "included": { "type": "array", @@ -5196,14 +5196,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } }, "responses": { "200": { - "description": "Detail of CmsPage", + "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -5215,7 +5215,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5224,7 +5224,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5238,19 +5238,19 @@ } } }, - "/cms-page/{id}": { + "/cms-section/{id}": { "get": { "tags": [ - "Cms Page" + "Cms Section" ], - "summary": "Detailed information about a Cms Page resource.", + "summary": "Detailed information about a Cms Section resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsPage", + "operationId": "getCmsSection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_page", + "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", @@ -5260,7 +5260,7 @@ ], "responses": { "200": { - "description": "Detail of CmsPage", + "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -5272,7 +5272,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5281,7 +5281,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5296,16 +5296,16 @@ }, "delete": { "tags": [ - "Cms Page" + "Cms Section" ], - "summary": "Delete a Cms Page resource.", + "summary": "Delete a Cms Section resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsPage", + "operationId": "deleteCmsSection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_page", + "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", @@ -5336,16 +5336,16 @@ }, "patch": { "tags": [ - "Cms Page" + "Cms Section" ], - "summary": "Partially update information about a Cms Page resource.", + "summary": "Partially update information about a Cms Section resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsPage", + "operationId": "updateCmsSection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_page", + "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", @@ -5363,14 +5363,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Page resource.", + "description": "Partially update information about a Cms Section resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" }, "included": { "type": "array", @@ -5384,14 +5384,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } }, "responses": { "200": { - "description": "Detail of CmsPage", + "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -5403,7 +5403,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5412,7 +5412,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5429,14 +5429,14 @@ } } }, - "/cms-section": { + "/cms-slot": { "get": { "tags": [ - "Cms Section" + "Cms Slot" ], - "summary": "List with basic information of Cms Section resources.", + "summary": "List with basic information of Cms Slot resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSectionList", + "operationId": "getCmsSlotList", "parameters": [ { "name": "limit", @@ -5465,7 +5465,7 @@ ], "responses": { "200": { - "description": "List of Cms Section resources.", + "description": "List of Cms Slot resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5484,7 +5484,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } ] @@ -5498,16 +5498,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-section?limit=25" + "example": "/cms-slot?limit=25" }, "last": { - "example": "/cms-section?limit=25&page=11" + "example": "/cms-slot?limit=25&page=11" }, "next": { - "example": "/cms-section?limit=25&page=4" + "example": "/cms-slot?limit=25&page=4" }, "prev": { - "example": "/cms-section?limit=25&page=2" + "example": "/cms-slot?limit=25&page=2" } } } @@ -5528,7 +5528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5543,11 +5543,11 @@ }, "post": { "tags": [ - "Cms Section" + "Cms Slot" ], - "summary": "Create a new Cms Section resources.", + "summary": "Create a new Cms Slot resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsSection", + "operationId": "createCmsSlot", "parameters": [ { "name": "_response", @@ -5569,7 +5569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" }, "included": { "type": "array", @@ -5583,14 +5583,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } }, "responses": { "200": { - "description": "Detail of CmsSection", + "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -5602,7 +5602,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5611,7 +5611,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5625,19 +5625,19 @@ } } }, - "/cms-section/{id}": { + "/cms-slot/{id}": { "get": { "tags": [ - "Cms Section" + "Cms Slot" ], - "summary": "Detailed information about a Cms Section resource.", + "summary": "Detailed information about a Cms Slot resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSection", + "operationId": "getCmsSlot", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_section", + "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", @@ -5647,7 +5647,7 @@ ], "responses": { "200": { - "description": "Detail of CmsSection", + "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -5659,7 +5659,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5668,7 +5668,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5683,16 +5683,16 @@ }, "delete": { "tags": [ - "Cms Section" + "Cms Slot" ], - "summary": "Delete a Cms Section resource.", + "summary": "Delete a Cms Slot resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsSection", + "operationId": "deleteCmsSlot", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_section", + "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", @@ -5723,16 +5723,16 @@ }, "patch": { "tags": [ - "Cms Section" + "Cms Slot" ], - "summary": "Partially update information about a Cms Section resource.", + "summary": "Partially update information about a Cms Slot resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsSection", + "operationId": "updateCmsSlot", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_section", + "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", @@ -5750,14 +5750,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Section resource.", + "description": "Partially update information about a Cms Slot resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" }, "included": { "type": "array", @@ -5771,14 +5771,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } }, "responses": { "200": { - "description": "Detail of CmsSection", + "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -5790,7 +5790,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5799,7 +5799,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5816,14 +5816,14 @@ } } }, - "/cms-slot": { + "/country": { "get": { "tags": [ - "Cms Slot" + "Country" ], - "summary": "List with basic information of Cms Slot resources.", + "summary": "List with basic information of Country resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSlotList", + "operationId": "getCountryList", "parameters": [ { "name": "limit", @@ -5852,7 +5852,7 @@ ], "responses": { "200": { - "description": "List of Cms Slot resources.", + "description": "List of Country resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5871,7 +5871,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } ] @@ -5885,16 +5885,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-slot?limit=25" + "example": "/country?limit=25" }, "last": { - "example": "/cms-slot?limit=25&page=11" + "example": "/country?limit=25&page=11" }, "next": { - "example": "/cms-slot?limit=25&page=4" + "example": "/country?limit=25&page=4" }, "prev": { - "example": "/cms-slot?limit=25&page=2" + "example": "/country?limit=25&page=2" } } } @@ -5915,7 +5915,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -5930,11 +5930,11 @@ }, "post": { "tags": [ - "Cms Slot" + "Country" ], - "summary": "Create a new Cms Slot resources.", + "summary": "Create a new Country resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsSlot", + "operationId": "createCountry", "parameters": [ { "name": "_response", @@ -5956,7 +5956,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" }, "included": { "type": "array", @@ -5970,14 +5970,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } }, "responses": { "200": { - "description": "Detail of CmsSlot", + "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { @@ -5989,7 +5989,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -5998,7 +5998,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -6012,19 +6012,19 @@ } } }, - "/cms-slot/{id}": { + "/country/{id}": { "get": { "tags": [ - "Cms Slot" + "Country" ], - "summary": "Detailed information about a Cms Slot resource.", + "summary": "Detailed information about a Country resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSlot", + "operationId": "getCountry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_slot", + "description": "Identifier for the country", "required": true, "schema": { "type": "string", @@ -6034,7 +6034,7 @@ ], "responses": { "200": { - "description": "Detail of CmsSlot", + "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { @@ -6046,7 +6046,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -6055,7 +6055,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -6070,16 +6070,16 @@ }, "delete": { "tags": [ - "Cms Slot" + "Country" ], - "summary": "Delete a Cms Slot resource.", + "summary": "Delete a Country resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsSlot", + "operationId": "deleteCountry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_slot", + "description": "Identifier for the country", "required": true, "schema": { "type": "string", @@ -6110,16 +6110,16 @@ }, "patch": { "tags": [ - "Cms Slot" + "Country" ], - "summary": "Partially update information about a Cms Slot resource.", + "summary": "Partially update information about a Country resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsSlot", + "operationId": "updateCountry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_slot", + "description": "Identifier for the country", "required": true, "schema": { "type": "string", @@ -6137,14 +6137,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Slot resource.", + "description": "Partially update information about a Country resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" }, "included": { "type": "array", @@ -6158,14 +6158,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } }, "responses": { "200": { - "description": "Detail of CmsSlot", + "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { @@ -6177,7 +6177,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -6186,7 +6186,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/Country" } } } @@ -6203,14 +6203,14 @@ } } }, - "/country": { + "/country-state": { "get": { "tags": [ - "Country" + "Country State" ], - "summary": "List with basic information of Country resources.", + "summary": "List with basic information of Country State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCountryList", + "operationId": "getCountryStateList", "parameters": [ { "name": "limit", @@ -6239,7 +6239,7 @@ ], "responses": { "200": { - "description": "List of Country resources.", + "description": "List of Country State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6258,7 +6258,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } ] @@ -6272,16 +6272,16 @@ "type": "object", "properties": { "first": { - "example": "/country?limit=25" + "example": "/country-state?limit=25" }, "last": { - "example": "/country?limit=25&page=11" + "example": "/country-state?limit=25&page=11" }, "next": { - "example": "/country?limit=25&page=4" + "example": "/country-state?limit=25&page=4" }, "prev": { - "example": "/country?limit=25&page=2" + "example": "/country-state?limit=25&page=2" } } } @@ -6302,7 +6302,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6317,11 +6317,11 @@ }, "post": { "tags": [ - "Country" + "Country State" ], - "summary": "Create a new Country resources.", + "summary": "Create a new Country State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCountry", + "operationId": "createCountryState", "parameters": [ { "name": "_response", @@ -6343,7 +6343,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" }, "included": { "type": "array", @@ -6357,14 +6357,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } }, "responses": { "200": { - "description": "Detail of Country", + "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -6376,7 +6376,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6385,7 +6385,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6399,19 +6399,19 @@ } } }, - "/country/{id}": { + "/country-state/{id}": { "get": { "tags": [ - "Country" + "Country State" ], - "summary": "Detailed information about a Country resource.", + "summary": "Detailed information about a Country State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCountry", + "operationId": "getCountryState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country", + "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", @@ -6421,7 +6421,7 @@ ], "responses": { "200": { - "description": "Detail of Country", + "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -6433,7 +6433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6442,7 +6442,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6457,16 +6457,16 @@ }, "delete": { "tags": [ - "Country" + "Country State" ], - "summary": "Delete a Country resource.", + "summary": "Delete a Country State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCountry", + "operationId": "deleteCountryState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country", + "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", @@ -6497,16 +6497,16 @@ }, "patch": { "tags": [ - "Country" + "Country State" ], - "summary": "Partially update information about a Country resource.", + "summary": "Partially update information about a Country State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCountry", + "operationId": "updateCountryState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country", + "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", @@ -6524,14 +6524,14 @@ } ], "requestBody": { - "description": "Partially update information about a Country resource.", + "description": "Partially update information about a Country State resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" }, "included": { "type": "array", @@ -6545,14 +6545,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } }, "responses": { "200": { - "description": "Detail of Country", + "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -6564,7 +6564,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6573,7 +6573,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CountryState" } } } @@ -6590,14 +6590,14 @@ } } }, - "/country-state": { + "/currency": { "get": { "tags": [ - "Country State" + "Currency" ], - "summary": "List with basic information of Country State resources.", + "summary": "List with basic information of Currency resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCountryStateList", + "operationId": "getCurrencyList", "parameters": [ { "name": "limit", @@ -6626,7 +6626,7 @@ ], "responses": { "200": { - "description": "List of Country State resources.", + "description": "List of Currency resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6645,7 +6645,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } ] @@ -6659,16 +6659,16 @@ "type": "object", "properties": { "first": { - "example": "/country-state?limit=25" + "example": "/currency?limit=25" }, "last": { - "example": "/country-state?limit=25&page=11" + "example": "/currency?limit=25&page=11" }, "next": { - "example": "/country-state?limit=25&page=4" + "example": "/currency?limit=25&page=4" }, "prev": { - "example": "/country-state?limit=25&page=2" + "example": "/currency?limit=25&page=2" } } } @@ -6689,7 +6689,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6704,11 +6704,11 @@ }, "post": { "tags": [ - "Country State" + "Currency" ], - "summary": "Create a new Country State resources.", + "summary": "Create a new Currency resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCountryState", + "operationId": "createCurrency", "parameters": [ { "name": "_response", @@ -6730,7 +6730,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" }, "included": { "type": "array", @@ -6744,14 +6744,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } }, "responses": { "200": { - "description": "Detail of CountryState", + "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -6763,7 +6763,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6772,7 +6772,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6786,19 +6786,19 @@ } } }, - "/country-state/{id}": { + "/currency/{id}": { "get": { "tags": [ - "Country State" + "Currency" ], - "summary": "Detailed information about a Country State resource.", + "summary": "Detailed information about a Currency resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCountryState", + "operationId": "getCurrency", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country_state", + "description": "Identifier for the currency", "required": true, "schema": { "type": "string", @@ -6808,7 +6808,7 @@ ], "responses": { "200": { - "description": "Detail of CountryState", + "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -6820,7 +6820,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6829,7 +6829,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6844,16 +6844,16 @@ }, "delete": { "tags": [ - "Country State" + "Currency" ], - "summary": "Delete a Country State resource.", + "summary": "Delete a Currency resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCountryState", + "operationId": "deleteCurrency", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country_state", + "description": "Identifier for the currency", "required": true, "schema": { "type": "string", @@ -6884,16 +6884,16 @@ }, "patch": { "tags": [ - "Country State" + "Currency" ], - "summary": "Partially update information about a Country State resource.", + "summary": "Partially update information about a Currency resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCountryState", + "operationId": "updateCurrency", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country_state", + "description": "Identifier for the currency", "required": true, "schema": { "type": "string", @@ -6911,14 +6911,14 @@ } ], "requestBody": { - "description": "Partially update information about a Country State resource.", + "description": "Partially update information about a Currency resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" }, "included": { "type": "array", @@ -6932,14 +6932,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } }, "responses": { "200": { - "description": "Detail of CountryState", + "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -6951,7 +6951,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6960,7 +6960,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Currency" } } } @@ -6977,14 +6977,14 @@ } } }, - "/currency": { + "/currency-country-rounding": { "get": { "tags": [ - "Currency" + "Currency Country Rounding" ], - "summary": "List with basic information of Currency resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCurrencyList", + "summary": "List with basic information of Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "getCurrencyCountryRoundingList", "parameters": [ { "name": "limit", @@ -7013,7 +7013,7 @@ ], "responses": { "200": { - "description": "List of Currency resources.", + "description": "List of Currency Country Rounding resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7032,7 +7032,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } ] @@ -7046,16 +7046,16 @@ "type": "object", "properties": { "first": { - "example": "/currency?limit=25" + "example": "/currency-country-rounding?limit=25" }, "last": { - "example": "/currency?limit=25&page=11" + "example": "/currency-country-rounding?limit=25&page=11" }, "next": { - "example": "/currency?limit=25&page=4" + "example": "/currency-country-rounding?limit=25&page=4" }, "prev": { - "example": "/currency?limit=25&page=2" + "example": "/currency-country-rounding?limit=25&page=2" } } } @@ -7076,7 +7076,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7091,11 +7091,11 @@ }, "post": { "tags": [ - "Currency" + "Currency Country Rounding" ], - "summary": "Create a new Currency resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCurrency", + "summary": "Create a new Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "createCurrencyCountryRounding", "parameters": [ { "name": "_response", @@ -7117,7 +7117,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" }, "included": { "type": "array", @@ -7131,14 +7131,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } }, "responses": { "200": { - "description": "Detail of Currency", + "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -7150,7 +7150,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7159,7 +7159,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7173,19 +7173,19 @@ } } }, - "/currency/{id}": { + "/currency-country-rounding/{id}": { "get": { "tags": [ - "Currency" + "Currency Country Rounding" ], - "summary": "Detailed information about a Currency resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCurrency", + "summary": "Detailed information about a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "getCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency", + "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", @@ -7195,7 +7195,7 @@ ], "responses": { "200": { - "description": "Detail of Currency", + "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -7207,7 +7207,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7216,7 +7216,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7231,16 +7231,16 @@ }, "delete": { "tags": [ - "Currency" + "Currency Country Rounding" ], - "summary": "Delete a Currency resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCurrency", + "summary": "Delete a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "deleteCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency", + "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", @@ -7271,16 +7271,16 @@ }, "patch": { "tags": [ - "Currency" + "Currency Country Rounding" ], - "summary": "Partially update information about a Currency resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCurrency", + "summary": "Partially update information about a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "updateCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency", + "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", @@ -7298,14 +7298,14 @@ } ], "requestBody": { - "description": "Partially update information about a Currency resource.", + "description": "Partially update information about a Currency Country Rounding resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" }, "included": { "type": "array", @@ -7319,14 +7319,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } }, "responses": { "200": { - "description": "Detail of Currency", + "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -7338,7 +7338,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7347,7 +7347,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7364,14 +7364,14 @@ } } }, - "/currency-country-rounding": { + "/custom-entity": { "get": { "tags": [ - "Currency Country Rounding" + "Custom Entity" ], - "summary": "List with basic information of Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "getCurrencyCountryRoundingList", + "summary": "List with basic information of Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "getCustomEntityList", "parameters": [ { "name": "limit", @@ -7400,7 +7400,7 @@ ], "responses": { "200": { - "description": "List of Currency Country Rounding resources.", + "description": "List of Custom Entity resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7419,7 +7419,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } ] @@ -7433,16 +7433,16 @@ "type": "object", "properties": { "first": { - "example": "/currency-country-rounding?limit=25" + "example": "/custom-entity?limit=25" }, "last": { - "example": "/currency-country-rounding?limit=25&page=11" + "example": "/custom-entity?limit=25&page=11" }, "next": { - "example": "/currency-country-rounding?limit=25&page=4" + "example": "/custom-entity?limit=25&page=4" }, "prev": { - "example": "/currency-country-rounding?limit=25&page=2" + "example": "/custom-entity?limit=25&page=2" } } } @@ -7463,7 +7463,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7478,11 +7478,11 @@ }, "post": { "tags": [ - "Currency Country Rounding" + "Custom Entity" ], - "summary": "Create a new Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "createCurrencyCountryRounding", + "summary": "Create a new Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "createCustomEntity", "parameters": [ { "name": "_response", @@ -7504,7 +7504,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" }, "included": { "type": "array", @@ -7518,14 +7518,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } }, "responses": { "200": { - "description": "Detail of CurrencyCountryRounding", + "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -7537,7 +7537,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7546,7 +7546,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7560,19 +7560,19 @@ } } }, - "/currency-country-rounding/{id}": { + "/custom-entity/{id}": { "get": { "tags": [ - "Currency Country Rounding" + "Custom Entity" ], - "summary": "Detailed information about a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "getCurrencyCountryRounding", + "summary": "Detailed information about a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "getCustomEntity", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency_country_rounding", + "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", @@ -7582,7 +7582,7 @@ ], "responses": { "200": { - "description": "Detail of CurrencyCountryRounding", + "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -7594,7 +7594,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7603,7 +7603,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7618,16 +7618,16 @@ }, "delete": { "tags": [ - "Currency Country Rounding" + "Custom Entity" ], - "summary": "Delete a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "deleteCurrencyCountryRounding", + "summary": "Delete a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "deleteCustomEntity", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency_country_rounding", + "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", @@ -7658,16 +7658,16 @@ }, "patch": { "tags": [ - "Currency Country Rounding" + "Custom Entity" ], - "summary": "Partially update information about a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "updateCurrencyCountryRounding", + "summary": "Partially update information about a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "updateCustomEntity", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency_country_rounding", + "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", @@ -7685,14 +7685,14 @@ } ], "requestBody": { - "description": "Partially update information about a Currency Country Rounding resource.", + "description": "Partially update information about a Custom Entity resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" }, "included": { "type": "array", @@ -7706,14 +7706,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } }, "responses": { "200": { - "description": "Detail of CurrencyCountryRounding", + "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -7725,7 +7725,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7734,7 +7734,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7751,14 +7751,14 @@ } } }, - "/custom-entity": { + "/custom-field": { "get": { "tags": [ - "Custom Entity" + "Custom Field" ], - "summary": "List with basic information of Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "getCustomEntityList", + "summary": "List with basic information of Custom Field resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomFieldList", "parameters": [ { "name": "limit", @@ -7787,7 +7787,7 @@ ], "responses": { "200": { - "description": "List of Custom Entity resources.", + "description": "List of Custom Field resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7806,7 +7806,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } ] @@ -7820,16 +7820,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-entity?limit=25" + "example": "/custom-field?limit=25" }, "last": { - "example": "/custom-entity?limit=25&page=11" + "example": "/custom-field?limit=25&page=11" }, "next": { - "example": "/custom-entity?limit=25&page=4" + "example": "/custom-field?limit=25&page=4" }, "prev": { - "example": "/custom-entity?limit=25&page=2" + "example": "/custom-field?limit=25&page=2" } } } @@ -7850,7 +7850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -7865,11 +7865,11 @@ }, "post": { "tags": [ - "Custom Entity" + "Custom Field" ], - "summary": "Create a new Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "createCustomEntity", + "summary": "Create a new Custom Field resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomField", "parameters": [ { "name": "_response", @@ -7891,7 +7891,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" }, "included": { "type": "array", @@ -7905,14 +7905,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "200": { - "description": "Detail of CustomEntity", + "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -7924,7 +7924,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -7933,7 +7933,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -7947,19 +7947,19 @@ } } }, - "/custom-entity/{id}": { + "/custom-field/{id}": { "get": { "tags": [ - "Custom Entity" + "Custom Field" ], - "summary": "Detailed information about a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "getCustomEntity", + "summary": "Detailed information about a Custom Field resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_entity", + "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", @@ -7969,7 +7969,7 @@ ], "responses": { "200": { - "description": "Detail of CustomEntity", + "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -7981,7 +7981,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -7990,7 +7990,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -8005,16 +8005,16 @@ }, "delete": { "tags": [ - "Custom Entity" + "Custom Field" ], - "summary": "Delete a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "deleteCustomEntity", + "summary": "Delete a Custom Field resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_entity", + "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", @@ -8045,16 +8045,16 @@ }, "patch": { "tags": [ - "Custom Entity" + "Custom Field" ], - "summary": "Partially update information about a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "updateCustomEntity", + "summary": "Partially update information about a Custom Field resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_entity", + "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", @@ -8072,14 +8072,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Entity resource.", + "description": "Partially update information about a Custom Field resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" }, "included": { "type": "array", @@ -8093,14 +8093,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "200": { - "description": "Detail of CustomEntity", + "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -8112,7 +8112,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -8121,7 +8121,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CustomField" } } } @@ -8138,14 +8138,14 @@ } } }, - "/custom-field": { + "/custom-field-set": { "get": { "tags": [ - "Custom Field" + "Custom Field Set" ], - "summary": "List with basic information of Custom Field resources.", + "summary": "List with basic information of Custom Field Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldList", + "operationId": "getCustomFieldSetList", "parameters": [ { "name": "limit", @@ -8174,7 +8174,7 @@ ], "responses": { "200": { - "description": "List of Custom Field resources.", + "description": "List of Custom Field Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8193,7 +8193,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } ] @@ -8207,16 +8207,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-field?limit=25" + "example": "/custom-field-set?limit=25" }, "last": { - "example": "/custom-field?limit=25&page=11" + "example": "/custom-field-set?limit=25&page=11" }, "next": { - "example": "/custom-field?limit=25&page=4" + "example": "/custom-field-set?limit=25&page=4" }, "prev": { - "example": "/custom-field?limit=25&page=2" + "example": "/custom-field-set?limit=25&page=2" } } } @@ -8237,7 +8237,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8252,11 +8252,11 @@ }, "post": { "tags": [ - "Custom Field" + "Custom Field Set" ], - "summary": "Create a new Custom Field resources.", + "summary": "Create a new Custom Field Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomField", + "operationId": "createCustomFieldSet", "parameters": [ { "name": "_response", @@ -8278,7 +8278,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" }, "included": { "type": "array", @@ -8292,14 +8292,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } }, "responses": { "200": { - "description": "Detail of CustomField", + "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -8311,7 +8311,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8320,7 +8320,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8334,19 +8334,19 @@ } } }, - "/custom-field/{id}": { + "/custom-field-set/{id}": { "get": { "tags": [ - "Custom Field" + "Custom Field Set" ], - "summary": "Detailed information about a Custom Field resource.", + "summary": "Detailed information about a Custom Field Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomField", + "operationId": "getCustomFieldSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field", + "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", @@ -8356,7 +8356,7 @@ ], "responses": { "200": { - "description": "Detail of CustomField", + "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -8368,7 +8368,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8377,7 +8377,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8392,16 +8392,16 @@ }, "delete": { "tags": [ - "Custom Field" + "Custom Field Set" ], - "summary": "Delete a Custom Field resource.", + "summary": "Delete a Custom Field Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomField", + "operationId": "deleteCustomFieldSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field", + "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", @@ -8432,16 +8432,16 @@ }, "patch": { "tags": [ - "Custom Field" + "Custom Field Set" ], - "summary": "Partially update information about a Custom Field resource.", + "summary": "Partially update information about a Custom Field Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomField", + "operationId": "updateCustomFieldSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field", + "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", @@ -8459,14 +8459,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Field resource.", + "description": "Partially update information about a Custom Field Set resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" }, "included": { "type": "array", @@ -8480,14 +8480,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } }, "responses": { "200": { - "description": "Detail of CustomField", + "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -8499,7 +8499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8508,7 +8508,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8525,14 +8525,14 @@ } } }, - "/custom-field-set": { + "/custom-field-set-relation": { "get": { "tags": [ - "Custom Field Set" + "Custom Field Set Relation" ], - "summary": "List with basic information of Custom Field Set resources.", + "summary": "List with basic information of Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetList", + "operationId": "getCustomFieldSetRelationList", "parameters": [ { "name": "limit", @@ -8561,7 +8561,7 @@ ], "responses": { "200": { - "description": "List of Custom Field Set resources.", + "description": "List of Custom Field Set Relation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8580,7 +8580,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } ] @@ -8594,16 +8594,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-field-set?limit=25" + "example": "/custom-field-set-relation?limit=25" }, "last": { - "example": "/custom-field-set?limit=25&page=11" + "example": "/custom-field-set-relation?limit=25&page=11" }, "next": { - "example": "/custom-field-set?limit=25&page=4" + "example": "/custom-field-set-relation?limit=25&page=4" }, "prev": { - "example": "/custom-field-set?limit=25&page=2" + "example": "/custom-field-set-relation?limit=25&page=2" } } } @@ -8624,7 +8624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8639,11 +8639,11 @@ }, "post": { "tags": [ - "Custom Field Set" + "Custom Field Set Relation" ], - "summary": "Create a new Custom Field Set resources.", + "summary": "Create a new Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomFieldSet", + "operationId": "createCustomFieldSetRelation", "parameters": [ { "name": "_response", @@ -8665,7 +8665,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" }, "included": { "type": "array", @@ -8679,14 +8679,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSet", + "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -8698,7 +8698,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8707,7 +8707,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8721,19 +8721,19 @@ } } }, - "/custom-field-set/{id}": { + "/custom-field-set-relation/{id}": { "get": { "tags": [ - "Custom Field Set" + "Custom Field Set Relation" ], - "summary": "Detailed information about a Custom Field Set resource.", + "summary": "Detailed information about a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSet", + "operationId": "getCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set", + "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", @@ -8743,7 +8743,7 @@ ], "responses": { "200": { - "description": "Detail of CustomFieldSet", + "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -8755,7 +8755,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8764,7 +8764,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8779,16 +8779,16 @@ }, "delete": { "tags": [ - "Custom Field Set" + "Custom Field Set Relation" ], - "summary": "Delete a Custom Field Set resource.", + "summary": "Delete a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomFieldSet", + "operationId": "deleteCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set", + "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", @@ -8819,16 +8819,16 @@ }, "patch": { "tags": [ - "Custom Field Set" + "Custom Field Set Relation" ], - "summary": "Partially update information about a Custom Field Set resource.", + "summary": "Partially update information about a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomFieldSet", + "operationId": "updateCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set", + "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", @@ -8846,14 +8846,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Field Set resource.", + "description": "Partially update information about a Custom Field Set Relation resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" }, "included": { "type": "array", @@ -8867,14 +8867,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSet", + "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -8886,7 +8886,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8895,7 +8895,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -8912,14 +8912,14 @@ } } }, - "/custom-field-set-relation": { + "/customer": { "get": { "tags": [ - "Custom Field Set Relation" + "Customer" ], - "summary": "List with basic information of Custom Field Set Relation resources.", + "summary": "List with basic information of Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetRelationList", + "operationId": "getCustomerList", "parameters": [ { "name": "limit", @@ -8948,7 +8948,7 @@ ], "responses": { "200": { - "description": "List of Custom Field Set Relation resources.", + "description": "List of Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8967,7 +8967,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } ] @@ -8981,16 +8981,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-field-set-relation?limit=25" + "example": "/customer?limit=25" }, "last": { - "example": "/custom-field-set-relation?limit=25&page=11" + "example": "/customer?limit=25&page=11" }, "next": { - "example": "/custom-field-set-relation?limit=25&page=4" + "example": "/customer?limit=25&page=4" }, "prev": { - "example": "/custom-field-set-relation?limit=25&page=2" + "example": "/customer?limit=25&page=2" } } } @@ -9011,7 +9011,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9026,11 +9026,11 @@ }, "post": { "tags": [ - "Custom Field Set Relation" + "Customer" ], - "summary": "Create a new Custom Field Set Relation resources.", + "summary": "Create a new Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomFieldSetRelation", + "operationId": "createCustomer", "parameters": [ { "name": "_response", @@ -9052,7 +9052,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" }, "included": { "type": "array", @@ -9066,14 +9066,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSetRelation", + "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -9085,7 +9085,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9094,7 +9094,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9108,19 +9108,19 @@ } } }, - "/custom-field-set-relation/{id}": { + "/customer/{id}": { "get": { "tags": [ - "Custom Field Set Relation" + "Customer" ], - "summary": "Detailed information about a Custom Field Set Relation resource.", + "summary": "Detailed information about a Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetRelation", + "operationId": "getCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set_relation", + "description": "Identifier for the customer", "required": true, "schema": { "type": "string", @@ -9130,7 +9130,7 @@ ], "responses": { "200": { - "description": "Detail of CustomFieldSetRelation", + "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -9142,7 +9142,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9151,7 +9151,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9166,16 +9166,16 @@ }, "delete": { "tags": [ - "Custom Field Set Relation" + "Customer" ], - "summary": "Delete a Custom Field Set Relation resource.", + "summary": "Delete a Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomFieldSetRelation", + "operationId": "deleteCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set_relation", + "description": "Identifier for the customer", "required": true, "schema": { "type": "string", @@ -9206,16 +9206,16 @@ }, "patch": { "tags": [ - "Custom Field Set Relation" + "Customer" ], - "summary": "Partially update information about a Custom Field Set Relation resource.", + "summary": "Partially update information about a Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomFieldSetRelation", + "operationId": "updateCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set_relation", + "description": "Identifier for the customer", "required": true, "schema": { "type": "string", @@ -9233,14 +9233,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Field Set Relation resource.", + "description": "Partially update information about a Customer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" }, "included": { "type": "array", @@ -9254,14 +9254,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSetRelation", + "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -9273,7 +9273,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9282,7 +9282,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/Customer" } } } @@ -9299,14 +9299,14 @@ } } }, - "/customer": { + "/customer-address": { "get": { "tags": [ - "Customer" + "Customer Address" ], - "summary": "List with basic information of Customer resources.", + "summary": "List with basic information of Customer Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerList", + "operationId": "getCustomerAddressList", "parameters": [ { "name": "limit", @@ -9335,7 +9335,7 @@ ], "responses": { "200": { - "description": "List of Customer resources.", + "description": "List of Customer Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9354,7 +9354,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } ] @@ -9368,16 +9368,16 @@ "type": "object", "properties": { "first": { - "example": "/customer?limit=25" + "example": "/customer-address?limit=25" }, "last": { - "example": "/customer?limit=25&page=11" + "example": "/customer-address?limit=25&page=11" }, "next": { - "example": "/customer?limit=25&page=4" + "example": "/customer-address?limit=25&page=4" }, "prev": { - "example": "/customer?limit=25&page=2" + "example": "/customer-address?limit=25&page=2" } } } @@ -9398,7 +9398,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9413,11 +9413,11 @@ }, "post": { "tags": [ - "Customer" + "Customer Address" ], - "summary": "Create a new Customer resources.", + "summary": "Create a new Customer Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomer", + "operationId": "createCustomerAddress", "parameters": [ { "name": "_response", @@ -9439,7 +9439,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" }, "included": { "type": "array", @@ -9453,14 +9453,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of Customer", + "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9472,7 +9472,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9481,7 +9481,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9495,19 +9495,19 @@ } } }, - "/customer/{id}": { + "/customer-address/{id}": { "get": { "tags": [ - "Customer" + "Customer Address" ], - "summary": "Detailed information about a Customer resource.", + "summary": "Detailed information about a Customer Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomer", + "operationId": "getCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer", + "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", @@ -9517,7 +9517,7 @@ ], "responses": { "200": { - "description": "Detail of Customer", + "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9529,7 +9529,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9538,7 +9538,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9553,16 +9553,16 @@ }, "delete": { "tags": [ - "Customer" + "Customer Address" ], - "summary": "Delete a Customer resource.", + "summary": "Delete a Customer Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomer", + "operationId": "deleteCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer", + "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", @@ -9593,16 +9593,16 @@ }, "patch": { "tags": [ - "Customer" + "Customer Address" ], - "summary": "Partially update information about a Customer resource.", + "summary": "Partially update information about a Customer Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomer", + "operationId": "updateCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer", + "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", @@ -9620,14 +9620,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer resource.", + "description": "Partially update information about a Customer Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" }, "included": { "type": "array", @@ -9641,14 +9641,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of Customer", + "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9660,7 +9660,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9669,7 +9669,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9686,14 +9686,14 @@ } } }, - "/customer-address": { + "/customer-group": { "get": { "tags": [ - "Customer Address" + "Customer Group" ], - "summary": "List with basic information of Customer Address resources.", + "summary": "List with basic information of Customer Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerAddressList", + "operationId": "getCustomerGroupList", "parameters": [ { "name": "limit", @@ -9722,7 +9722,7 @@ ], "responses": { "200": { - "description": "List of Customer Address resources.", + "description": "List of Customer Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9741,7 +9741,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } ] @@ -9755,16 +9755,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-address?limit=25" + "example": "/customer-group?limit=25" }, "last": { - "example": "/customer-address?limit=25&page=11" + "example": "/customer-group?limit=25&page=11" }, "next": { - "example": "/customer-address?limit=25&page=4" + "example": "/customer-group?limit=25&page=4" }, "prev": { - "example": "/customer-address?limit=25&page=2" + "example": "/customer-group?limit=25&page=2" } } } @@ -9785,7 +9785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -9800,11 +9800,11 @@ }, "post": { "tags": [ - "Customer Address" + "Customer Group" ], - "summary": "Create a new Customer Address resources.", + "summary": "Create a new Customer Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomerAddress", + "operationId": "createCustomerGroup", "parameters": [ { "name": "_response", @@ -9826,7 +9826,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" }, "included": { "type": "array", @@ -9840,14 +9840,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } }, "responses": { "200": { - "description": "Detail of CustomerAddress", + "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -9859,7 +9859,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -9868,7 +9868,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -9882,19 +9882,19 @@ } } }, - "/customer-address/{id}": { + "/customer-group/{id}": { "get": { "tags": [ - "Customer Address" + "Customer Group" ], - "summary": "Detailed information about a Customer Address resource.", + "summary": "Detailed information about a Customer Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerAddress", + "operationId": "getCustomerGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_address", + "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", @@ -9904,7 +9904,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerAddress", + "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -9916,7 +9916,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -9925,7 +9925,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -9940,16 +9940,16 @@ }, "delete": { "tags": [ - "Customer Address" + "Customer Group" ], - "summary": "Delete a Customer Address resource.", + "summary": "Delete a Customer Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomerAddress", + "operationId": "deleteCustomerGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_address", + "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", @@ -9980,16 +9980,16 @@ }, "patch": { "tags": [ - "Customer Address" + "Customer Group" ], - "summary": "Partially update information about a Customer Address resource.", + "summary": "Partially update information about a Customer Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomerAddress", + "operationId": "updateCustomerGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_address", + "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", @@ -10007,14 +10007,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Address resource.", + "description": "Partially update information about a Customer Group resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" }, "included": { "type": "array", @@ -10028,14 +10028,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } }, "responses": { "200": { - "description": "Detail of CustomerAddress", + "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -10047,7 +10047,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -10056,7 +10056,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -10073,14 +10073,14 @@ } } }, - "/customer-group": { + "/customer-recovery": { "get": { "tags": [ - "Customer Group" + "Customer Recovery" ], - "summary": "List with basic information of Customer Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerGroupList", + "summary": "List with basic information of Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getCustomerRecoveryList", "parameters": [ { "name": "limit", @@ -10109,7 +10109,7 @@ ], "responses": { "200": { - "description": "List of Customer Group resources.", + "description": "List of Customer Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10128,7 +10128,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } ] @@ -10142,16 +10142,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-group?limit=25" + "example": "/customer-recovery?limit=25" }, "last": { - "example": "/customer-group?limit=25&page=11" + "example": "/customer-recovery?limit=25&page=11" }, "next": { - "example": "/customer-group?limit=25&page=4" + "example": "/customer-recovery?limit=25&page=4" }, "prev": { - "example": "/customer-group?limit=25&page=2" + "example": "/customer-recovery?limit=25&page=2" } } } @@ -10172,7 +10172,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10187,11 +10187,11 @@ }, "post": { "tags": [ - "Customer Group" + "Customer Recovery" ], - "summary": "Create a new Customer Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomerGroup", + "summary": "Create a new Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createCustomerRecovery", "parameters": [ { "name": "_response", @@ -10213,7 +10213,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" }, "included": { "type": "array", @@ -10227,14 +10227,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } }, "responses": { "200": { - "description": "Detail of CustomerGroup", + "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10246,7 +10246,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10255,7 +10255,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10269,19 +10269,19 @@ } } }, - "/customer-group/{id}": { + "/customer-recovery/{id}": { "get": { "tags": [ - "Customer Group" + "Customer Recovery" ], - "summary": "Detailed information about a Customer Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerGroup", + "summary": "Detailed information about a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getCustomerRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_group", + "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", @@ -10291,7 +10291,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerGroup", + "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10303,7 +10303,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10312,7 +10312,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10327,16 +10327,16 @@ }, "delete": { "tags": [ - "Customer Group" + "Customer Recovery" ], - "summary": "Delete a Customer Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomerGroup", + "summary": "Delete a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteCustomerRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_group", + "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", @@ -10367,16 +10367,16 @@ }, "patch": { "tags": [ - "Customer Group" + "Customer Recovery" ], - "summary": "Partially update information about a Customer Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomerGroup", + "summary": "Partially update information about a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateCustomerRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_group", + "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", @@ -10394,14 +10394,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Group resource.", + "description": "Partially update information about a Customer Recovery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" }, "included": { "type": "array", @@ -10415,14 +10415,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } }, "responses": { "200": { - "description": "Detail of CustomerGroup", + "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10434,7 +10434,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10443,7 +10443,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10460,14 +10460,14 @@ } } }, - "/customer-recovery": { + "/customer-wishlist": { "get": { "tags": [ - "Customer Recovery" + "Customer Wishlist" ], - "summary": "List with basic information of Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getCustomerRecoveryList", + "summary": "List with basic information of Customer Wishlist resources.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlistList", "parameters": [ { "name": "limit", @@ -10496,7 +10496,7 @@ ], "responses": { "200": { - "description": "List of Customer Recovery resources.", + "description": "List of Customer Wishlist resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10515,7 +10515,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } ] @@ -10529,16 +10529,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-recovery?limit=25" + "example": "/customer-wishlist?limit=25" }, "last": { - "example": "/customer-recovery?limit=25&page=11" + "example": "/customer-wishlist?limit=25&page=11" }, "next": { - "example": "/customer-recovery?limit=25&page=4" + "example": "/customer-wishlist?limit=25&page=4" }, "prev": { - "example": "/customer-recovery?limit=25&page=2" + "example": "/customer-wishlist?limit=25&page=2" } } } @@ -10559,7 +10559,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10574,11 +10574,11 @@ }, "post": { "tags": [ - "Customer Recovery" + "Customer Wishlist" ], - "summary": "Create a new Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createCustomerRecovery", + "summary": "Create a new Customer Wishlist resources.", + "description": "Available since: 6.3.4.0", + "operationId": "createCustomerWishlist", "parameters": [ { "name": "_response", @@ -10600,7 +10600,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" }, "included": { "type": "array", @@ -10614,14 +10614,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } }, "responses": { "200": { - "description": "Detail of CustomerRecovery", + "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -10633,7 +10633,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10642,7 +10642,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10656,19 +10656,19 @@ } } }, - "/customer-recovery/{id}": { + "/customer-wishlist/{id}": { "get": { "tags": [ - "Customer Recovery" + "Customer Wishlist" ], - "summary": "Detailed information about a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getCustomerRecovery", + "summary": "Detailed information about a Customer Wishlist resource.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_recovery", + "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", @@ -10678,7 +10678,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerRecovery", + "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -10690,7 +10690,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10699,7 +10699,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10714,16 +10714,16 @@ }, "delete": { "tags": [ - "Customer Recovery" + "Customer Wishlist" ], - "summary": "Delete a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteCustomerRecovery", + "summary": "Delete a Customer Wishlist resource.", + "description": "Available since: 6.3.4.0", + "operationId": "deleteCustomerWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_recovery", + "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", @@ -10754,16 +10754,16 @@ }, "patch": { "tags": [ - "Customer Recovery" + "Customer Wishlist" ], - "summary": "Partially update information about a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateCustomerRecovery", + "summary": "Partially update information about a Customer Wishlist resource.", + "description": "Available since: 6.3.4.0", + "operationId": "updateCustomerWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_recovery", + "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", @@ -10781,14 +10781,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Recovery resource.", + "description": "Partially update information about a Customer Wishlist resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" }, "included": { "type": "array", @@ -10802,14 +10802,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } }, "responses": { "200": { - "description": "Detail of CustomerRecovery", + "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -10821,7 +10821,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10830,7 +10830,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10847,14 +10847,14 @@ } } }, - "/customer-wishlist": { + "/customer-wishlist-product": { "get": { "tags": [ - "Customer Wishlist" + "Customer Wishlist Product" ], - "summary": "List with basic information of Customer Wishlist resources.", + "summary": "List with basic information of Customer Wishlist Product resources.", "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistList", + "operationId": "getCustomerWishlistProductList", "parameters": [ { "name": "limit", @@ -10883,7 +10883,7 @@ ], "responses": { "200": { - "description": "List of Customer Wishlist resources.", + "description": "List of Customer Wishlist Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10902,7 +10902,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } ] @@ -10916,16 +10916,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-wishlist?limit=25" + "example": "/customer-wishlist-product?limit=25" }, "last": { - "example": "/customer-wishlist?limit=25&page=11" + "example": "/customer-wishlist-product?limit=25&page=11" }, "next": { - "example": "/customer-wishlist?limit=25&page=4" + "example": "/customer-wishlist-product?limit=25&page=4" }, "prev": { - "example": "/customer-wishlist?limit=25&page=2" + "example": "/customer-wishlist-product?limit=25&page=2" } } } @@ -10946,7 +10946,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -10961,11 +10961,11 @@ }, "post": { "tags": [ - "Customer Wishlist" + "Customer Wishlist Product" ], - "summary": "Create a new Customer Wishlist resources.", + "summary": "Create a new Customer Wishlist Product resources.", "description": "Available since: 6.3.4.0", - "operationId": "createCustomerWishlist", + "operationId": "createCustomerWishlistProduct", "parameters": [ { "name": "_response", @@ -10987,7 +10987,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" }, "included": { "type": "array", @@ -11001,14 +11001,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlist", + "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11020,7 +11020,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11029,7 +11029,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11043,19 +11043,19 @@ } } }, - "/customer-wishlist/{id}": { + "/customer-wishlist-product/{id}": { "get": { "tags": [ - "Customer Wishlist" + "Customer Wishlist Product" ], - "summary": "Detailed information about a Customer Wishlist resource.", + "summary": "Detailed information about a Customer Wishlist Product resource.", "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlist", + "operationId": "getCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist", + "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", @@ -11065,7 +11065,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerWishlist", + "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11077,7 +11077,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11086,7 +11086,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11101,16 +11101,16 @@ }, "delete": { "tags": [ - "Customer Wishlist" + "Customer Wishlist Product" ], - "summary": "Delete a Customer Wishlist resource.", + "summary": "Delete a Customer Wishlist Product resource.", "description": "Available since: 6.3.4.0", - "operationId": "deleteCustomerWishlist", + "operationId": "deleteCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist", + "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", @@ -11141,16 +11141,16 @@ }, "patch": { "tags": [ - "Customer Wishlist" + "Customer Wishlist Product" ], - "summary": "Partially update information about a Customer Wishlist resource.", + "summary": "Partially update information about a Customer Wishlist Product resource.", "description": "Available since: 6.3.4.0", - "operationId": "updateCustomerWishlist", + "operationId": "updateCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist", + "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", @@ -11168,14 +11168,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Wishlist resource.", + "description": "Partially update information about a Customer Wishlist Product resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" }, "included": { "type": "array", @@ -11189,14 +11189,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlist", + "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11208,7 +11208,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11217,7 +11217,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11234,14 +11234,14 @@ } } }, - "/customer-wishlist-product": { + "/delivery-time": { "get": { "tags": [ - "Customer Wishlist Product" + "Delivery Time" ], - "summary": "List with basic information of Customer Wishlist Product resources.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistProductList", + "summary": "List with basic information of Delivery Time resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDeliveryTimeList", "parameters": [ { "name": "limit", @@ -11270,7 +11270,7 @@ ], "responses": { "200": { - "description": "List of Customer Wishlist Product resources.", + "description": "List of Delivery Time resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11289,7 +11289,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } ] @@ -11303,16 +11303,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-wishlist-product?limit=25" + "example": "/delivery-time?limit=25" }, "last": { - "example": "/customer-wishlist-product?limit=25&page=11" + "example": "/delivery-time?limit=25&page=11" }, "next": { - "example": "/customer-wishlist-product?limit=25&page=4" + "example": "/delivery-time?limit=25&page=4" }, "prev": { - "example": "/customer-wishlist-product?limit=25&page=2" + "example": "/delivery-time?limit=25&page=2" } } } @@ -11333,7 +11333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11348,11 +11348,11 @@ }, "post": { "tags": [ - "Customer Wishlist Product" + "Delivery Time" ], - "summary": "Create a new Customer Wishlist Product resources.", - "description": "Available since: 6.3.4.0", - "operationId": "createCustomerWishlistProduct", + "summary": "Create a new Delivery Time resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDeliveryTime", "parameters": [ { "name": "_response", @@ -11374,7 +11374,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" }, "included": { "type": "array", @@ -11388,14 +11388,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlistProduct", + "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11407,7 +11407,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11416,7 +11416,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11430,19 +11430,19 @@ } } }, - "/customer-wishlist-product/{id}": { + "/delivery-time/{id}": { "get": { "tags": [ - "Customer Wishlist Product" + "Delivery Time" ], - "summary": "Detailed information about a Customer Wishlist Product resource.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistProduct", + "summary": "Detailed information about a Delivery Time resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDeliveryTime", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist_product", + "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", @@ -11452,7 +11452,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerWishlistProduct", + "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11464,7 +11464,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11473,7 +11473,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11488,16 +11488,16 @@ }, "delete": { "tags": [ - "Customer Wishlist Product" + "Delivery Time" ], - "summary": "Delete a Customer Wishlist Product resource.", - "description": "Available since: 6.3.4.0", - "operationId": "deleteCustomerWishlistProduct", + "summary": "Delete a Delivery Time resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDeliveryTime", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist_product", + "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", @@ -11528,16 +11528,16 @@ }, "patch": { "tags": [ - "Customer Wishlist Product" + "Delivery Time" ], - "summary": "Partially update information about a Customer Wishlist Product resource.", - "description": "Available since: 6.3.4.0", - "operationId": "updateCustomerWishlistProduct", + "summary": "Partially update information about a Delivery Time resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDeliveryTime", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist_product", + "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", @@ -11555,14 +11555,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Wishlist Product resource.", + "description": "Partially update information about a Delivery Time resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" }, "included": { "type": "array", @@ -11576,14 +11576,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlistProduct", + "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11595,7 +11595,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11604,7 +11604,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11621,14 +11621,14 @@ } } }, - "/delivery-time": { + "/document": { "get": { "tags": [ - "Delivery Time" + "Document" ], - "summary": "List with basic information of Delivery Time resources.", + "summary": "List with basic information of Document resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDeliveryTimeList", + "operationId": "getDocumentList", "parameters": [ { "name": "limit", @@ -11657,7 +11657,7 @@ ], "responses": { "200": { - "description": "List of Delivery Time resources.", + "description": "List of Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11676,7 +11676,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } ] @@ -11690,16 +11690,16 @@ "type": "object", "properties": { "first": { - "example": "/delivery-time?limit=25" + "example": "/document?limit=25" }, "last": { - "example": "/delivery-time?limit=25&page=11" + "example": "/document?limit=25&page=11" }, "next": { - "example": "/delivery-time?limit=25&page=4" + "example": "/document?limit=25&page=4" }, "prev": { - "example": "/delivery-time?limit=25&page=2" + "example": "/document?limit=25&page=2" } } } @@ -11720,7 +11720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -11735,11 +11735,11 @@ }, "post": { "tags": [ - "Delivery Time" + "Document" ], - "summary": "Create a new Delivery Time resources.", + "summary": "Create a new Document resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDeliveryTime", + "operationId": "createDocument", "parameters": [ { "name": "_response", @@ -11761,7 +11761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" }, "included": { "type": "array", @@ -11775,14 +11775,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { - "description": "Detail of DeliveryTime", + "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { @@ -11794,7 +11794,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -11803,7 +11803,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -11817,19 +11817,19 @@ } } }, - "/delivery-time/{id}": { + "/document/{id}": { "get": { "tags": [ - "Delivery Time" + "Document" ], - "summary": "Detailed information about a Delivery Time resource.", + "summary": "Detailed information about a Document resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDeliveryTime", + "operationId": "getDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the delivery_time", + "description": "Identifier for the document", "required": true, "schema": { "type": "string", @@ -11839,7 +11839,7 @@ ], "responses": { "200": { - "description": "Detail of DeliveryTime", + "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { @@ -11851,7 +11851,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -11860,7 +11860,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -11875,16 +11875,16 @@ }, "delete": { "tags": [ - "Delivery Time" + "Document" ], - "summary": "Delete a Delivery Time resource.", + "summary": "Delete a Document resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDeliveryTime", + "operationId": "deleteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the delivery_time", + "description": "Identifier for the document", "required": true, "schema": { "type": "string", @@ -11915,16 +11915,16 @@ }, "patch": { "tags": [ - "Delivery Time" + "Document" ], - "summary": "Partially update information about a Delivery Time resource.", + "summary": "Partially update information about a Document resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDeliveryTime", + "operationId": "updateDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the delivery_time", + "description": "Identifier for the document", "required": true, "schema": { "type": "string", @@ -11942,14 +11942,14 @@ } ], "requestBody": { - "description": "Partially update information about a Delivery Time resource.", + "description": "Partially update information about a Document resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" }, "included": { "type": "array", @@ -11963,14 +11963,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { - "description": "Detail of DeliveryTime", + "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { @@ -11982,7 +11982,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -11991,7 +11991,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/Document" } } } @@ -12008,14 +12008,14 @@ } } }, - "/document": { + "/document-base-config": { "get": { "tags": [ - "Document" + "Document Base Config" ], - "summary": "List with basic information of Document resources.", + "summary": "List with basic information of Document Base Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentList", + "operationId": "getDocumentBaseConfigList", "parameters": [ { "name": "limit", @@ -12044,7 +12044,7 @@ ], "responses": { "200": { - "description": "List of Document resources.", + "description": "List of Document Base Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12063,7 +12063,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } ] @@ -12077,16 +12077,16 @@ "type": "object", "properties": { "first": { - "example": "/document?limit=25" + "example": "/document-base-config?limit=25" }, "last": { - "example": "/document?limit=25&page=11" + "example": "/document-base-config?limit=25&page=11" }, "next": { - "example": "/document?limit=25&page=4" + "example": "/document-base-config?limit=25&page=4" }, "prev": { - "example": "/document?limit=25&page=2" + "example": "/document-base-config?limit=25&page=2" } } } @@ -12107,7 +12107,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12122,11 +12122,11 @@ }, "post": { "tags": [ - "Document" + "Document Base Config" ], - "summary": "Create a new Document resources.", + "summary": "Create a new Document Base Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocument", + "operationId": "createDocumentBaseConfig", "parameters": [ { "name": "_response", @@ -12148,7 +12148,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" }, "included": { "type": "array", @@ -12162,14 +12162,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } }, "responses": { "200": { - "description": "Detail of Document", + "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -12181,7 +12181,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12190,7 +12190,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12204,19 +12204,19 @@ } } }, - "/document/{id}": { + "/document-base-config/{id}": { "get": { "tags": [ - "Document" + "Document Base Config" ], - "summary": "Detailed information about a Document resource.", + "summary": "Detailed information about a Document Base Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocument", + "operationId": "getDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document", + "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", @@ -12226,7 +12226,7 @@ ], "responses": { "200": { - "description": "Detail of Document", + "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -12238,7 +12238,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12247,7 +12247,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12262,16 +12262,16 @@ }, "delete": { "tags": [ - "Document" + "Document Base Config" ], - "summary": "Delete a Document resource.", + "summary": "Delete a Document Base Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocument", + "operationId": "deleteDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document", + "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", @@ -12302,16 +12302,16 @@ }, "patch": { "tags": [ - "Document" + "Document Base Config" ], - "summary": "Partially update information about a Document resource.", + "summary": "Partially update information about a Document Base Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocument", + "operationId": "updateDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document", + "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", @@ -12329,14 +12329,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document resource.", + "description": "Partially update information about a Document Base Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" }, "included": { "type": "array", @@ -12350,14 +12350,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } }, "responses": { "200": { - "description": "Detail of Document", + "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -12369,7 +12369,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12378,7 +12378,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12395,14 +12395,14 @@ } } }, - "/document-base-config": { + "/document-base-config-sales-channel": { "get": { "tags": [ - "Document Base Config" + "Document Base Config Sales Channel" ], - "summary": "List with basic information of Document Base Config resources.", + "summary": "List with basic information of Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigList", + "operationId": "getDocumentBaseConfigSalesChannelList", "parameters": [ { "name": "limit", @@ -12431,7 +12431,7 @@ ], "responses": { "200": { - "description": "List of Document Base Config resources.", + "description": "List of Document Base Config Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12450,7 +12450,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } ] @@ -12464,16 +12464,16 @@ "type": "object", "properties": { "first": { - "example": "/document-base-config?limit=25" + "example": "/document-base-config-sales-channel?limit=25" }, "last": { - "example": "/document-base-config?limit=25&page=11" + "example": "/document-base-config-sales-channel?limit=25&page=11" }, "next": { - "example": "/document-base-config?limit=25&page=4" + "example": "/document-base-config-sales-channel?limit=25&page=4" }, "prev": { - "example": "/document-base-config?limit=25&page=2" + "example": "/document-base-config-sales-channel?limit=25&page=2" } } } @@ -12494,7 +12494,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12509,11 +12509,11 @@ }, "post": { "tags": [ - "Document Base Config" + "Document Base Config Sales Channel" ], - "summary": "Create a new Document Base Config resources.", + "summary": "Create a new Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocumentBaseConfig", + "operationId": "createDocumentBaseConfigSalesChannel", "parameters": [ { "name": "_response", @@ -12535,7 +12535,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" }, "included": { "type": "array", @@ -12549,14 +12549,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfig", + "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -12568,7 +12568,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12577,7 +12577,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12591,19 +12591,19 @@ } } }, - "/document-base-config/{id}": { + "/document-base-config-sales-channel/{id}": { "get": { "tags": [ - "Document Base Config" + "Document Base Config Sales Channel" ], - "summary": "Detailed information about a Document Base Config resource.", + "summary": "Detailed information about a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfig", + "operationId": "getDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config", + "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", @@ -12613,7 +12613,7 @@ ], "responses": { "200": { - "description": "Detail of DocumentBaseConfig", + "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -12625,7 +12625,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12634,7 +12634,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12649,16 +12649,16 @@ }, "delete": { "tags": [ - "Document Base Config" + "Document Base Config Sales Channel" ], - "summary": "Delete a Document Base Config resource.", + "summary": "Delete a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentBaseConfig", + "operationId": "deleteDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config", + "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", @@ -12689,16 +12689,16 @@ }, "patch": { "tags": [ - "Document Base Config" + "Document Base Config Sales Channel" ], - "summary": "Partially update information about a Document Base Config resource.", + "summary": "Partially update information about a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentBaseConfig", + "operationId": "updateDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config", + "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", @@ -12716,14 +12716,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document Base Config resource.", + "description": "Partially update information about a Document Base Config Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" }, "included": { "type": "array", @@ -12737,14 +12737,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfig", + "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -12756,7 +12756,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12765,7 +12765,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12782,14 +12782,14 @@ } } }, - "/document-base-config-sales-channel": { + "/document-type": { "get": { "tags": [ - "Document Base Config Sales Channel" + "Document Type" ], - "summary": "List with basic information of Document Base Config Sales Channel resources.", + "summary": "List with basic information of Document Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannelList", + "operationId": "getDocumentTypeList", "parameters": [ { "name": "limit", @@ -12818,7 +12818,7 @@ ], "responses": { "200": { - "description": "List of Document Base Config Sales Channel resources.", + "description": "List of Document Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12837,7 +12837,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } ] @@ -12851,16 +12851,16 @@ "type": "object", "properties": { "first": { - "example": "/document-base-config-sales-channel?limit=25" + "example": "/document-type?limit=25" }, "last": { - "example": "/document-base-config-sales-channel?limit=25&page=11" + "example": "/document-type?limit=25&page=11" }, "next": { - "example": "/document-base-config-sales-channel?limit=25&page=4" + "example": "/document-type?limit=25&page=4" }, "prev": { - "example": "/document-base-config-sales-channel?limit=25&page=2" + "example": "/document-type?limit=25&page=2" } } } @@ -12881,7 +12881,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -12896,11 +12896,11 @@ }, "post": { "tags": [ - "Document Base Config Sales Channel" + "Document Type" ], - "summary": "Create a new Document Base Config Sales Channel resources.", + "summary": "Create a new Document Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocumentBaseConfigSalesChannel", + "operationId": "createDocumentType", "parameters": [ { "name": "_response", @@ -12922,7 +12922,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" }, "included": { "type": "array", @@ -12936,14 +12936,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", + "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -12955,7 +12955,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -12964,7 +12964,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -12978,19 +12978,19 @@ } } }, - "/document-base-config-sales-channel/{id}": { + "/document-type/{id}": { "get": { "tags": [ - "Document Base Config Sales Channel" + "Document Type" ], - "summary": "Detailed information about a Document Base Config Sales Channel resource.", + "summary": "Detailed information about a Document Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannel", + "operationId": "getDocumentType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config_sales_channel", + "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", @@ -13000,7 +13000,7 @@ ], "responses": { "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", + "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -13012,7 +13012,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13021,7 +13021,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13036,16 +13036,16 @@ }, "delete": { "tags": [ - "Document Base Config Sales Channel" + "Document Type" ], - "summary": "Delete a Document Base Config Sales Channel resource.", + "summary": "Delete a Document Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentBaseConfigSalesChannel", + "operationId": "deleteDocumentType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config_sales_channel", + "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", @@ -13076,16 +13076,16 @@ }, "patch": { "tags": [ - "Document Base Config Sales Channel" + "Document Type" ], - "summary": "Partially update information about a Document Base Config Sales Channel resource.", + "summary": "Partially update information about a Document Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentBaseConfigSalesChannel", + "operationId": "updateDocumentType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config_sales_channel", + "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", @@ -13103,14 +13103,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document Base Config Sales Channel resource.", + "description": "Partially update information about a Document Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" }, "included": { "type": "array", @@ -13124,14 +13124,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", + "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -13143,7 +13143,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13152,7 +13152,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13169,14 +13169,14 @@ } } }, - "/document-type": { + "/flow": { "get": { "tags": [ - "Document Type" + "Flow" ], - "summary": "List with basic information of Document Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentTypeList", + "summary": "List with basic information of Flow resources.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlowList", "parameters": [ { "name": "limit", @@ -13205,7 +13205,7 @@ ], "responses": { "200": { - "description": "List of Document Type resources.", + "description": "List of Flow resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13224,7 +13224,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } ] @@ -13238,16 +13238,16 @@ "type": "object", "properties": { "first": { - "example": "/document-type?limit=25" + "example": "/flow?limit=25" }, "last": { - "example": "/document-type?limit=25&page=11" + "example": "/flow?limit=25&page=11" }, "next": { - "example": "/document-type?limit=25&page=4" + "example": "/flow?limit=25&page=4" }, "prev": { - "example": "/document-type?limit=25&page=2" + "example": "/flow?limit=25&page=2" } } } @@ -13268,7 +13268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13283,11 +13283,11 @@ }, "post": { "tags": [ - "Document Type" + "Flow" ], - "summary": "Create a new Document Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDocumentType", + "summary": "Create a new Flow resources.", + "description": "Available since: 6.4.6.0", + "operationId": "createFlow", "parameters": [ { "name": "_response", @@ -13309,7 +13309,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" }, "included": { "type": "array", @@ -13323,14 +13323,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } }, "responses": { "200": { - "description": "Detail of DocumentType", + "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -13342,7 +13342,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13351,7 +13351,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13365,19 +13365,19 @@ } } }, - "/document-type/{id}": { + "/flow/{id}": { "get": { "tags": [ - "Document Type" + "Flow" ], - "summary": "Detailed information about a Document Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentType", + "summary": "Detailed information about a Flow resource.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlow", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_type", + "description": "Identifier for the flow", "required": true, "schema": { "type": "string", @@ -13387,7 +13387,7 @@ ], "responses": { "200": { - "description": "Detail of DocumentType", + "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -13399,7 +13399,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13408,7 +13408,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13423,16 +13423,16 @@ }, "delete": { "tags": [ - "Document Type" + "Flow" ], - "summary": "Delete a Document Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentType", + "summary": "Delete a Flow resource.", + "description": "Available since: 6.4.6.0", + "operationId": "deleteFlow", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_type", + "description": "Identifier for the flow", "required": true, "schema": { "type": "string", @@ -13463,16 +13463,16 @@ }, "patch": { "tags": [ - "Document Type" + "Flow" ], - "summary": "Partially update information about a Document Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentType", + "summary": "Partially update information about a Flow resource.", + "description": "Available since: 6.4.6.0", + "operationId": "updateFlow", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_type", + "description": "Identifier for the flow", "required": true, "schema": { "type": "string", @@ -13490,14 +13490,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document Type resource.", + "description": "Partially update information about a Flow resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" }, "included": { "type": "array", @@ -13511,14 +13511,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } }, "responses": { "200": { - "description": "Detail of DocumentType", + "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -13530,7 +13530,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13539,7 +13539,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/Flow" } } } @@ -13556,14 +13556,14 @@ } } }, - "/flow": { + "/flow-sequence": { "get": { "tags": [ - "Flow" + "Flow Sequence" ], - "summary": "List with basic information of Flow resources.", + "summary": "List with basic information of Flow Sequence resources.", "description": "Available since: 6.4.6.0", - "operationId": "getFlowList", + "operationId": "getFlowSequenceList", "parameters": [ { "name": "limit", @@ -13592,7 +13592,7 @@ ], "responses": { "200": { - "description": "List of Flow resources.", + "description": "List of Flow Sequence resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13611,7 +13611,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } ] @@ -13625,16 +13625,16 @@ "type": "object", "properties": { "first": { - "example": "/flow?limit=25" + "example": "/flow-sequence?limit=25" }, "last": { - "example": "/flow?limit=25&page=11" + "example": "/flow-sequence?limit=25&page=11" }, "next": { - "example": "/flow?limit=25&page=4" + "example": "/flow-sequence?limit=25&page=4" }, "prev": { - "example": "/flow?limit=25&page=2" + "example": "/flow-sequence?limit=25&page=2" } } } @@ -13655,7 +13655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13670,11 +13670,11 @@ }, "post": { "tags": [ - "Flow" + "Flow Sequence" ], - "summary": "Create a new Flow resources.", + "summary": "Create a new Flow Sequence resources.", "description": "Available since: 6.4.6.0", - "operationId": "createFlow", + "operationId": "createFlowSequence", "parameters": [ { "name": "_response", @@ -13696,7 +13696,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" }, "included": { "type": "array", @@ -13710,14 +13710,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } }, "responses": { "200": { - "description": "Detail of Flow", + "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -13729,7 +13729,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13738,7 +13738,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13752,19 +13752,19 @@ } } }, - "/flow/{id}": { + "/flow-sequence/{id}": { "get": { "tags": [ - "Flow" + "Flow Sequence" ], - "summary": "Detailed information about a Flow resource.", + "summary": "Detailed information about a Flow Sequence resource.", "description": "Available since: 6.4.6.0", - "operationId": "getFlow", + "operationId": "getFlowSequence", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow", + "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", @@ -13774,7 +13774,7 @@ ], "responses": { "200": { - "description": "Detail of Flow", + "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -13786,7 +13786,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13795,7 +13795,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13810,16 +13810,16 @@ }, "delete": { "tags": [ - "Flow" + "Flow Sequence" ], - "summary": "Delete a Flow resource.", + "summary": "Delete a Flow Sequence resource.", "description": "Available since: 6.4.6.0", - "operationId": "deleteFlow", + "operationId": "deleteFlowSequence", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow", + "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", @@ -13850,16 +13850,16 @@ }, "patch": { "tags": [ - "Flow" + "Flow Sequence" ], - "summary": "Partially update information about a Flow resource.", + "summary": "Partially update information about a Flow Sequence resource.", "description": "Available since: 6.4.6.0", - "operationId": "updateFlow", + "operationId": "updateFlowSequence", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow", + "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", @@ -13877,14 +13877,14 @@ } ], "requestBody": { - "description": "Partially update information about a Flow resource.", + "description": "Partially update information about a Flow Sequence resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" }, "included": { "type": "array", @@ -13898,14 +13898,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } }, "responses": { "200": { - "description": "Detail of Flow", + "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -13917,7 +13917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13926,7 +13926,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -13943,14 +13943,14 @@ } } }, - "/flow-sequence": { + "/flow-template": { "get": { "tags": [ - "Flow Sequence" + "Flow Template" ], - "summary": "List with basic information of Flow Sequence resources.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlowSequenceList", + "summary": "List with basic information of Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "getFlowTemplateList", "parameters": [ { "name": "limit", @@ -13979,7 +13979,7 @@ ], "responses": { "200": { - "description": "List of Flow Sequence resources.", + "description": "List of Flow Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13998,7 +13998,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } ] @@ -14012,16 +14012,16 @@ "type": "object", "properties": { "first": { - "example": "/flow-sequence?limit=25" + "example": "/flow-template?limit=25" }, "last": { - "example": "/flow-sequence?limit=25&page=11" + "example": "/flow-template?limit=25&page=11" }, "next": { - "example": "/flow-sequence?limit=25&page=4" + "example": "/flow-template?limit=25&page=4" }, "prev": { - "example": "/flow-sequence?limit=25&page=2" + "example": "/flow-template?limit=25&page=2" } } } @@ -14042,7 +14042,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14057,11 +14057,11 @@ }, "post": { "tags": [ - "Flow Sequence" + "Flow Template" ], - "summary": "Create a new Flow Sequence resources.", - "description": "Available since: 6.4.6.0", - "operationId": "createFlowSequence", + "summary": "Create a new Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "createFlowTemplate", "parameters": [ { "name": "_response", @@ -14083,7 +14083,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" }, "included": { "type": "array", @@ -14097,14 +14097,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } }, "responses": { "200": { - "description": "Detail of FlowSequence", + "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -14116,7 +14116,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14125,7 +14125,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14139,19 +14139,19 @@ } } }, - "/flow-sequence/{id}": { + "/flow-template/{id}": { "get": { "tags": [ - "Flow Sequence" + "Flow Template" ], - "summary": "Detailed information about a Flow Sequence resource.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlowSequence", + "summary": "Detailed information about a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "getFlowTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_sequence", + "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", @@ -14161,7 +14161,7 @@ ], "responses": { "200": { - "description": "Detail of FlowSequence", + "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -14173,7 +14173,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14182,7 +14182,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14197,16 +14197,16 @@ }, "delete": { "tags": [ - "Flow Sequence" + "Flow Template" ], - "summary": "Delete a Flow Sequence resource.", - "description": "Available since: 6.4.6.0", - "operationId": "deleteFlowSequence", + "summary": "Delete a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "deleteFlowTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_sequence", + "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", @@ -14237,16 +14237,16 @@ }, "patch": { "tags": [ - "Flow Sequence" + "Flow Template" ], - "summary": "Partially update information about a Flow Sequence resource.", - "description": "Available since: 6.4.6.0", - "operationId": "updateFlowSequence", + "summary": "Partially update information about a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "updateFlowTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_sequence", + "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", @@ -14264,14 +14264,14 @@ } ], "requestBody": { - "description": "Partially update information about a Flow Sequence resource.", + "description": "Partially update information about a Flow Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" }, "included": { "type": "array", @@ -14285,14 +14285,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } }, "responses": { "200": { - "description": "Detail of FlowSequence", + "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -14304,7 +14304,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14313,7 +14313,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14330,14 +14330,14 @@ } } }, - "/flow-template": { + "/import-export-file": { "get": { "tags": [ - "Flow Template" + "Import Export File" ], - "summary": "List with basic information of Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "getFlowTemplateList", + "summary": "List with basic information of Import Export File resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportFileList", "parameters": [ { "name": "limit", @@ -14366,7 +14366,7 @@ ], "responses": { "200": { - "description": "List of Flow Template resources.", + "description": "List of Import Export File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14385,7 +14385,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } ] @@ -14399,16 +14399,16 @@ "type": "object", "properties": { "first": { - "example": "/flow-template?limit=25" + "example": "/import-export-file?limit=25" }, "last": { - "example": "/flow-template?limit=25&page=11" + "example": "/import-export-file?limit=25&page=11" }, "next": { - "example": "/flow-template?limit=25&page=4" + "example": "/import-export-file?limit=25&page=4" }, "prev": { - "example": "/flow-template?limit=25&page=2" + "example": "/import-export-file?limit=25&page=2" } } } @@ -14429,7 +14429,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14444,11 +14444,11 @@ }, "post": { "tags": [ - "Flow Template" + "Import Export File" ], - "summary": "Create a new Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "createFlowTemplate", + "summary": "Create a new Import Export File resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createImportExportFile", "parameters": [ { "name": "_response", @@ -14470,7 +14470,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" }, "included": { "type": "array", @@ -14484,14 +14484,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } }, "responses": { "200": { - "description": "Detail of FlowTemplate", + "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -14503,7 +14503,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14512,7 +14512,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14526,19 +14526,19 @@ } } }, - "/flow-template/{id}": { + "/import-export-file/{id}": { "get": { "tags": [ - "Flow Template" + "Import Export File" ], - "summary": "Detailed information about a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "getFlowTemplate", + "summary": "Detailed information about a Import Export File resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_template", + "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", @@ -14548,7 +14548,7 @@ ], "responses": { "200": { - "description": "Detail of FlowTemplate", + "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -14560,7 +14560,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14569,7 +14569,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14584,16 +14584,16 @@ }, "delete": { "tags": [ - "Flow Template" + "Import Export File" ], - "summary": "Delete a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "deleteFlowTemplate", + "summary": "Delete a Import Export File resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteImportExportFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_template", + "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", @@ -14624,16 +14624,16 @@ }, "patch": { "tags": [ - "Flow Template" + "Import Export File" ], - "summary": "Partially update information about a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "updateFlowTemplate", + "summary": "Partially update information about a Import Export File resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateImportExportFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_template", + "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", @@ -14651,14 +14651,14 @@ } ], "requestBody": { - "description": "Partially update information about a Flow Template resource.", + "description": "Partially update information about a Import Export File resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" }, "included": { "type": "array", @@ -14672,14 +14672,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } }, "responses": { "200": { - "description": "Detail of FlowTemplate", + "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -14691,7 +14691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14700,7 +14700,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14717,14 +14717,14 @@ } } }, - "/import-export-file": { + "/import-export-log": { "get": { "tags": [ - "Import Export File" + "Import Export Log" ], - "summary": "List with basic information of Import Export File resources.", + "summary": "List with basic information of Import Export Log resources.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportFileList", + "operationId": "getImportExportLogList", "parameters": [ { "name": "limit", @@ -14753,7 +14753,7 @@ ], "responses": { "200": { - "description": "List of Import Export File resources.", + "description": "List of Import Export Log resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14772,7 +14772,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } ] @@ -14786,16 +14786,16 @@ "type": "object", "properties": { "first": { - "example": "/import-export-file?limit=25" + "example": "/import-export-log?limit=25" }, "last": { - "example": "/import-export-file?limit=25&page=11" + "example": "/import-export-log?limit=25&page=11" }, "next": { - "example": "/import-export-file?limit=25&page=4" + "example": "/import-export-log?limit=25&page=4" }, "prev": { - "example": "/import-export-file?limit=25&page=2" + "example": "/import-export-log?limit=25&page=2" } } } @@ -14816,7 +14816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -14831,11 +14831,11 @@ }, "post": { "tags": [ - "Import Export File" + "Import Export Log" ], - "summary": "Create a new Import Export File resources.", + "summary": "Create a new Import Export Log resources.", "description": "Available since: 6.0.0.0", - "operationId": "createImportExportFile", + "operationId": "createImportExportLog", "parameters": [ { "name": "_response", @@ -14857,7 +14857,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" }, "included": { "type": "array", @@ -14871,14 +14871,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } }, "responses": { "200": { - "description": "Detail of ImportExportFile", + "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -14890,7 +14890,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -14899,7 +14899,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -14913,19 +14913,19 @@ } } }, - "/import-export-file/{id}": { + "/import-export-log/{id}": { "get": { "tags": [ - "Import Export File" + "Import Export Log" ], - "summary": "Detailed information about a Import Export File resource.", + "summary": "Detailed information about a Import Export Log resource.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportFile", + "operationId": "getImportExportLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_file", + "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", @@ -14935,7 +14935,7 @@ ], "responses": { "200": { - "description": "Detail of ImportExportFile", + "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -14947,7 +14947,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -14956,7 +14956,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -14971,16 +14971,16 @@ }, "delete": { "tags": [ - "Import Export File" + "Import Export Log" ], - "summary": "Delete a Import Export File resource.", + "summary": "Delete a Import Export Log resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportFile", + "operationId": "deleteImportExportLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_file", + "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", @@ -15011,16 +15011,16 @@ }, "patch": { "tags": [ - "Import Export File" + "Import Export Log" ], - "summary": "Partially update information about a Import Export File resource.", + "summary": "Partially update information about a Import Export Log resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportFile", + "operationId": "updateImportExportLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_file", + "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", @@ -15038,14 +15038,14 @@ } ], "requestBody": { - "description": "Partially update information about a Import Export File resource.", + "description": "Partially update information about a Import Export Log resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" }, "included": { "type": "array", @@ -15059,14 +15059,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } }, "responses": { "200": { - "description": "Detail of ImportExportFile", + "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -15078,7 +15078,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -15087,7 +15087,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -15104,14 +15104,14 @@ } } }, - "/import-export-log": { + "/import-export-profile": { "get": { "tags": [ - "Import Export Log" + "Import Export Profile" ], - "summary": "List with basic information of Import Export Log resources.", + "summary": "List with basic information of Import Export Profile resources.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportLogList", + "operationId": "getImportExportProfileList", "parameters": [ { "name": "limit", @@ -15140,7 +15140,7 @@ ], "responses": { "200": { - "description": "List of Import Export Log resources.", + "description": "List of Import Export Profile resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15159,7 +15159,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } ] @@ -15173,16 +15173,16 @@ "type": "object", "properties": { "first": { - "example": "/import-export-log?limit=25" + "example": "/import-export-profile?limit=25" }, "last": { - "example": "/import-export-log?limit=25&page=11" + "example": "/import-export-profile?limit=25&page=11" }, "next": { - "example": "/import-export-log?limit=25&page=4" + "example": "/import-export-profile?limit=25&page=4" }, "prev": { - "example": "/import-export-log?limit=25&page=2" + "example": "/import-export-profile?limit=25&page=2" } } } @@ -15203,7 +15203,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15218,11 +15218,11 @@ }, "post": { "tags": [ - "Import Export Log" + "Import Export Profile" ], - "summary": "Create a new Import Export Log resources.", + "summary": "Create a new Import Export Profile resources.", "description": "Available since: 6.0.0.0", - "operationId": "createImportExportLog", + "operationId": "createImportExportProfile", "parameters": [ { "name": "_response", @@ -15244,7 +15244,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" }, "included": { "type": "array", @@ -15258,14 +15258,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } }, "responses": { "200": { - "description": "Detail of ImportExportLog", + "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -15277,7 +15277,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15286,7 +15286,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15300,19 +15300,19 @@ } } }, - "/import-export-log/{id}": { + "/import-export-profile/{id}": { "get": { "tags": [ - "Import Export Log" + "Import Export Profile" ], - "summary": "Detailed information about a Import Export Log resource.", + "summary": "Detailed information about a Import Export Profile resource.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportLog", + "operationId": "getImportExportProfile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_log", + "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", @@ -15322,7 +15322,7 @@ ], "responses": { "200": { - "description": "Detail of ImportExportLog", + "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -15334,7 +15334,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15343,7 +15343,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15358,16 +15358,16 @@ }, "delete": { "tags": [ - "Import Export Log" + "Import Export Profile" ], - "summary": "Delete a Import Export Log resource.", + "summary": "Delete a Import Export Profile resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportLog", + "operationId": "deleteImportExportProfile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_log", + "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", @@ -15398,16 +15398,16 @@ }, "patch": { "tags": [ - "Import Export Log" + "Import Export Profile" ], - "summary": "Partially update information about a Import Export Log resource.", + "summary": "Partially update information about a Import Export Profile resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportLog", + "operationId": "updateImportExportProfile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_log", + "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", @@ -15425,14 +15425,14 @@ } ], "requestBody": { - "description": "Partially update information about a Import Export Log resource.", + "description": "Partially update information about a Import Export Profile resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" }, "included": { "type": "array", @@ -15446,14 +15446,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } }, "responses": { "200": { - "description": "Detail of ImportExportLog", + "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -15465,7 +15465,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15474,7 +15474,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15491,14 +15491,14 @@ } } }, - "/import-export-profile": { + "/integration": { "get": { "tags": [ - "Import Export Profile" + "Integration" ], - "summary": "List with basic information of Import Export Profile resources.", + "summary": "List with basic information of Integration resources.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportProfileList", + "operationId": "getIntegrationList", "parameters": [ { "name": "limit", @@ -15527,7 +15527,7 @@ ], "responses": { "200": { - "description": "List of Import Export Profile resources.", + "description": "List of Integration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15546,7 +15546,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } ] @@ -15560,16 +15560,16 @@ "type": "object", "properties": { "first": { - "example": "/import-export-profile?limit=25" + "example": "/integration?limit=25" }, "last": { - "example": "/import-export-profile?limit=25&page=11" + "example": "/integration?limit=25&page=11" }, "next": { - "example": "/import-export-profile?limit=25&page=4" + "example": "/integration?limit=25&page=4" }, "prev": { - "example": "/import-export-profile?limit=25&page=2" + "example": "/integration?limit=25&page=2" } } } @@ -15590,7 +15590,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15605,11 +15605,11 @@ }, "post": { "tags": [ - "Import Export Profile" + "Integration" ], - "summary": "Create a new Import Export Profile resources.", + "summary": "Create a new Integration resources.", "description": "Available since: 6.0.0.0", - "operationId": "createImportExportProfile", + "operationId": "createIntegration", "parameters": [ { "name": "_response", @@ -15631,7 +15631,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" }, "included": { "type": "array", @@ -15645,14 +15645,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } }, "responses": { "200": { - "description": "Detail of ImportExportProfile", + "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -15664,7 +15664,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15673,7 +15673,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15687,19 +15687,19 @@ } } }, - "/import-export-profile/{id}": { + "/integration/{id}": { "get": { "tags": [ - "Import Export Profile" + "Integration" ], - "summary": "Detailed information about a Import Export Profile resource.", + "summary": "Detailed information about a Integration resource.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportProfile", + "operationId": "getIntegration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_profile", + "description": "Identifier for the integration", "required": true, "schema": { "type": "string", @@ -15709,7 +15709,7 @@ ], "responses": { "200": { - "description": "Detail of ImportExportProfile", + "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -15721,7 +15721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15730,7 +15730,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15745,16 +15745,16 @@ }, "delete": { "tags": [ - "Import Export Profile" + "Integration" ], - "summary": "Delete a Import Export Profile resource.", + "summary": "Delete a Integration resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportProfile", + "operationId": "deleteIntegration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_profile", + "description": "Identifier for the integration", "required": true, "schema": { "type": "string", @@ -15785,16 +15785,16 @@ }, "patch": { "tags": [ - "Import Export Profile" + "Integration" ], - "summary": "Partially update information about a Import Export Profile resource.", + "summary": "Partially update information about a Integration resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportProfile", + "operationId": "updateIntegration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_profile", + "description": "Identifier for the integration", "required": true, "schema": { "type": "string", @@ -15812,14 +15812,14 @@ } ], "requestBody": { - "description": "Partially update information about a Import Export Profile resource.", + "description": "Partially update information about a Integration resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" }, "included": { "type": "array", @@ -15833,14 +15833,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } }, "responses": { "200": { - "description": "Detail of ImportExportProfile", + "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -15852,7 +15852,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15861,7 +15861,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/Integration" } } } @@ -15878,14 +15878,14 @@ } } }, - "/integration": { + "/landing-page": { "get": { "tags": [ - "Integration" + "Landing Page" ], - "summary": "List with basic information of Integration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getIntegrationList", + "summary": "List with basic information of Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "getLandingPageList", "parameters": [ { "name": "limit", @@ -15914,7 +15914,7 @@ ], "responses": { "200": { - "description": "List of Integration resources.", + "description": "List of Landing Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15933,7 +15933,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } ] @@ -15947,16 +15947,16 @@ "type": "object", "properties": { "first": { - "example": "/integration?limit=25" + "example": "/landing-page?limit=25" }, "last": { - "example": "/integration?limit=25&page=11" + "example": "/landing-page?limit=25&page=11" }, "next": { - "example": "/integration?limit=25&page=4" + "example": "/landing-page?limit=25&page=4" }, "prev": { - "example": "/integration?limit=25&page=2" + "example": "/landing-page?limit=25&page=2" } } } @@ -15977,7 +15977,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -15992,11 +15992,11 @@ }, "post": { "tags": [ - "Integration" + "Landing Page" ], - "summary": "Create a new Integration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createIntegration", + "summary": "Create a new Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "createLandingPage", "parameters": [ { "name": "_response", @@ -16018,7 +16018,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" }, "included": { "type": "array", @@ -16032,14 +16032,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } }, "responses": { "200": { - "description": "Detail of Integration", + "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -16051,7 +16051,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16060,7 +16060,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16074,19 +16074,19 @@ } } }, - "/integration/{id}": { + "/landing-page/{id}": { "get": { "tags": [ - "Integration" + "Landing Page" ], - "summary": "Detailed information about a Integration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getIntegration", + "summary": "Detailed information about a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "getLandingPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the integration", + "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", @@ -16096,7 +16096,7 @@ ], "responses": { "200": { - "description": "Detail of Integration", + "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -16108,7 +16108,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16117,7 +16117,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16132,16 +16132,16 @@ }, "delete": { "tags": [ - "Integration" + "Landing Page" ], - "summary": "Delete a Integration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteIntegration", + "summary": "Delete a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "deleteLandingPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the integration", + "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", @@ -16172,16 +16172,16 @@ }, "patch": { "tags": [ - "Integration" + "Landing Page" ], - "summary": "Partially update information about a Integration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateIntegration", + "summary": "Partially update information about a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "updateLandingPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the integration", + "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", @@ -16199,14 +16199,14 @@ } ], "requestBody": { - "description": "Partially update information about a Integration resource.", + "description": "Partially update information about a Landing Page resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" }, "included": { "type": "array", @@ -16220,14 +16220,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } }, "responses": { "200": { - "description": "Detail of Integration", + "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -16239,7 +16239,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16248,7 +16248,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16265,14 +16265,14 @@ } } }, - "/landing-page": { + "/language": { "get": { "tags": [ - "Landing Page" + "Language" ], - "summary": "List with basic information of Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "getLandingPageList", + "summary": "List with basic information of Language resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getLanguageList", "parameters": [ { "name": "limit", @@ -16301,7 +16301,7 @@ ], "responses": { "200": { - "description": "List of Landing Page resources.", + "description": "List of Language resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16320,7 +16320,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } ] @@ -16334,16 +16334,16 @@ "type": "object", "properties": { "first": { - "example": "/landing-page?limit=25" + "example": "/language?limit=25" }, "last": { - "example": "/landing-page?limit=25&page=11" + "example": "/language?limit=25&page=11" }, "next": { - "example": "/landing-page?limit=25&page=4" + "example": "/language?limit=25&page=4" }, "prev": { - "example": "/landing-page?limit=25&page=2" + "example": "/language?limit=25&page=2" } } } @@ -16364,7 +16364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16379,11 +16379,11 @@ }, "post": { "tags": [ - "Landing Page" + "Language" ], - "summary": "Create a new Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "createLandingPage", + "summary": "Create a new Language resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createLanguage", "parameters": [ { "name": "_response", @@ -16405,7 +16405,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" }, "included": { "type": "array", @@ -16419,14 +16419,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } }, "responses": { "200": { - "description": "Detail of LandingPage", + "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { @@ -16438,7 +16438,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16447,7 +16447,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16461,19 +16461,19 @@ } } }, - "/landing-page/{id}": { + "/language/{id}": { "get": { "tags": [ - "Landing Page" + "Language" ], - "summary": "Detailed information about a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "getLandingPage", + "summary": "Detailed information about a Language resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getLanguage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the landing_page", + "description": "Identifier for the language", "required": true, "schema": { "type": "string", @@ -16483,7 +16483,7 @@ ], "responses": { "200": { - "description": "Detail of LandingPage", + "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { @@ -16495,7 +16495,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16504,7 +16504,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16519,16 +16519,16 @@ }, "delete": { "tags": [ - "Landing Page" + "Language" ], - "summary": "Delete a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "deleteLandingPage", + "summary": "Delete a Language resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteLanguage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the landing_page", + "description": "Identifier for the language", "required": true, "schema": { "type": "string", @@ -16559,16 +16559,16 @@ }, "patch": { "tags": [ - "Landing Page" + "Language" ], - "summary": "Partially update information about a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "updateLandingPage", + "summary": "Partially update information about a Language resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateLanguage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the landing_page", + "description": "Identifier for the language", "required": true, "schema": { "type": "string", @@ -16586,14 +16586,14 @@ } ], "requestBody": { - "description": "Partially update information about a Landing Page resource.", + "description": "Partially update information about a Language resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" }, "included": { "type": "array", @@ -16607,14 +16607,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } }, "responses": { "200": { - "description": "Detail of LandingPage", + "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { @@ -16626,7 +16626,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16635,7 +16635,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Language" } } } @@ -16652,14 +16652,14 @@ } } }, - "/language": { + "/locale": { "get": { "tags": [ - "Language" + "Locale" ], - "summary": "List with basic information of Language resources.", + "summary": "List with basic information of Locale resources.", "description": "Available since: 6.0.0.0", - "operationId": "getLanguageList", + "operationId": "getLocaleList", "parameters": [ { "name": "limit", @@ -16688,7 +16688,7 @@ ], "responses": { "200": { - "description": "List of Language resources.", + "description": "List of Locale resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16707,7 +16707,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } ] @@ -16721,16 +16721,16 @@ "type": "object", "properties": { "first": { - "example": "/language?limit=25" + "example": "/locale?limit=25" }, "last": { - "example": "/language?limit=25&page=11" + "example": "/locale?limit=25&page=11" }, "next": { - "example": "/language?limit=25&page=4" + "example": "/locale?limit=25&page=4" }, "prev": { - "example": "/language?limit=25&page=2" + "example": "/locale?limit=25&page=2" } } } @@ -16751,7 +16751,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -16766,11 +16766,11 @@ }, "post": { "tags": [ - "Language" + "Locale" ], - "summary": "Create a new Language resources.", + "summary": "Create a new Locale resources.", "description": "Available since: 6.0.0.0", - "operationId": "createLanguage", + "operationId": "createLocale", "parameters": [ { "name": "_response", @@ -16792,7 +16792,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" }, "included": { "type": "array", @@ -16806,14 +16806,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } }, "responses": { "200": { - "description": "Detail of Language", + "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -16825,7 +16825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -16834,7 +16834,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -16848,19 +16848,19 @@ } } }, - "/language/{id}": { + "/locale/{id}": { "get": { "tags": [ - "Language" + "Locale" ], - "summary": "Detailed information about a Language resource.", + "summary": "Detailed information about a Locale resource.", "description": "Available since: 6.0.0.0", - "operationId": "getLanguage", + "operationId": "getLocale", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the language", + "description": "Identifier for the locale", "required": true, "schema": { "type": "string", @@ -16870,7 +16870,7 @@ ], "responses": { "200": { - "description": "Detail of Language", + "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -16882,7 +16882,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -16891,7 +16891,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -16906,16 +16906,16 @@ }, "delete": { "tags": [ - "Language" + "Locale" ], - "summary": "Delete a Language resource.", + "summary": "Delete a Locale resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteLanguage", + "operationId": "deleteLocale", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the language", + "description": "Identifier for the locale", "required": true, "schema": { "type": "string", @@ -16946,16 +16946,16 @@ }, "patch": { "tags": [ - "Language" + "Locale" ], - "summary": "Partially update information about a Language resource.", + "summary": "Partially update information about a Locale resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateLanguage", + "operationId": "updateLocale", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the language", + "description": "Identifier for the locale", "required": true, "schema": { "type": "string", @@ -16973,14 +16973,14 @@ } ], "requestBody": { - "description": "Partially update information about a Language resource.", + "description": "Partially update information about a Locale resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" }, "included": { "type": "array", @@ -16994,14 +16994,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } }, "responses": { "200": { - "description": "Detail of Language", + "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -17013,7 +17013,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -17022,7 +17022,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Locale" } } } @@ -17039,14 +17039,14 @@ } } }, - "/locale": { + "/log-entry": { "get": { "tags": [ - "Locale" + "Log Entry" ], - "summary": "List with basic information of Locale resources.", + "summary": "List with basic information of Log Entry resources.", "description": "Available since: 6.0.0.0", - "operationId": "getLocaleList", + "operationId": "getLogEntryList", "parameters": [ { "name": "limit", @@ -17075,7 +17075,7 @@ ], "responses": { "200": { - "description": "List of Locale resources.", + "description": "List of Log Entry resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17094,7 +17094,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } ] @@ -17108,16 +17108,16 @@ "type": "object", "properties": { "first": { - "example": "/locale?limit=25" + "example": "/log-entry?limit=25" }, "last": { - "example": "/locale?limit=25&page=11" + "example": "/log-entry?limit=25&page=11" }, "next": { - "example": "/locale?limit=25&page=4" + "example": "/log-entry?limit=25&page=4" }, "prev": { - "example": "/locale?limit=25&page=2" + "example": "/log-entry?limit=25&page=2" } } } @@ -17138,7 +17138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17153,11 +17153,11 @@ }, "post": { "tags": [ - "Locale" + "Log Entry" ], - "summary": "Create a new Locale resources.", + "summary": "Create a new Log Entry resources.", "description": "Available since: 6.0.0.0", - "operationId": "createLocale", + "operationId": "createLogEntry", "parameters": [ { "name": "_response", @@ -17179,7 +17179,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" }, "included": { "type": "array", @@ -17193,14 +17193,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } }, "responses": { "200": { - "description": "Detail of Locale", + "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -17212,7 +17212,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17221,7 +17221,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17235,19 +17235,19 @@ } } }, - "/locale/{id}": { + "/log-entry/{id}": { "get": { "tags": [ - "Locale" + "Log Entry" ], - "summary": "Detailed information about a Locale resource.", + "summary": "Detailed information about a Log Entry resource.", "description": "Available since: 6.0.0.0", - "operationId": "getLocale", + "operationId": "getLogEntry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the locale", + "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", @@ -17257,7 +17257,7 @@ ], "responses": { "200": { - "description": "Detail of Locale", + "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -17269,7 +17269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17278,7 +17278,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17293,16 +17293,16 @@ }, "delete": { "tags": [ - "Locale" + "Log Entry" ], - "summary": "Delete a Locale resource.", + "summary": "Delete a Log Entry resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteLocale", + "operationId": "deleteLogEntry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the locale", + "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", @@ -17333,16 +17333,16 @@ }, "patch": { "tags": [ - "Locale" + "Log Entry" ], - "summary": "Partially update information about a Locale resource.", + "summary": "Partially update information about a Log Entry resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateLocale", + "operationId": "updateLogEntry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the locale", + "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", @@ -17360,14 +17360,14 @@ } ], "requestBody": { - "description": "Partially update information about a Locale resource.", + "description": "Partially update information about a Log Entry resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" }, "included": { "type": "array", @@ -17381,14 +17381,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } }, "responses": { "200": { - "description": "Detail of Locale", + "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -17400,7 +17400,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17409,7 +17409,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17426,14 +17426,14 @@ } } }, - "/log-entry": { + "/mail-header-footer": { "get": { "tags": [ - "Log Entry" + "Mail Header Footer" ], - "summary": "List with basic information of Log Entry resources.", + "summary": "List with basic information of Mail Header Footer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getLogEntryList", + "operationId": "getMailHeaderFooterList", "parameters": [ { "name": "limit", @@ -17462,7 +17462,7 @@ ], "responses": { "200": { - "description": "List of Log Entry resources.", + "description": "List of Mail Header Footer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17481,7 +17481,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } ] @@ -17495,16 +17495,16 @@ "type": "object", "properties": { "first": { - "example": "/log-entry?limit=25" + "example": "/mail-header-footer?limit=25" }, "last": { - "example": "/log-entry?limit=25&page=11" + "example": "/mail-header-footer?limit=25&page=11" }, "next": { - "example": "/log-entry?limit=25&page=4" + "example": "/mail-header-footer?limit=25&page=4" }, "prev": { - "example": "/log-entry?limit=25&page=2" + "example": "/mail-header-footer?limit=25&page=2" } } } @@ -17525,7 +17525,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17540,11 +17540,11 @@ }, "post": { "tags": [ - "Log Entry" + "Mail Header Footer" ], - "summary": "Create a new Log Entry resources.", + "summary": "Create a new Mail Header Footer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createLogEntry", + "operationId": "createMailHeaderFooter", "parameters": [ { "name": "_response", @@ -17566,7 +17566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" }, "included": { "type": "array", @@ -17580,14 +17580,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } }, "responses": { "200": { - "description": "Detail of LogEntry", + "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -17599,7 +17599,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17608,7 +17608,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17622,19 +17622,19 @@ } } }, - "/log-entry/{id}": { + "/mail-header-footer/{id}": { "get": { "tags": [ - "Log Entry" + "Mail Header Footer" ], - "summary": "Detailed information about a Log Entry resource.", + "summary": "Detailed information about a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getLogEntry", + "operationId": "getMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the log_entry", + "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", @@ -17644,7 +17644,7 @@ ], "responses": { "200": { - "description": "Detail of LogEntry", + "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -17656,7 +17656,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17665,7 +17665,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17680,16 +17680,16 @@ }, "delete": { "tags": [ - "Log Entry" + "Mail Header Footer" ], - "summary": "Delete a Log Entry resource.", + "summary": "Delete a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteLogEntry", + "operationId": "deleteMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the log_entry", + "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", @@ -17720,16 +17720,16 @@ }, "patch": { "tags": [ - "Log Entry" + "Mail Header Footer" ], - "summary": "Partially update information about a Log Entry resource.", + "summary": "Partially update information about a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateLogEntry", + "operationId": "updateMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the log_entry", + "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", @@ -17747,14 +17747,14 @@ } ], "requestBody": { - "description": "Partially update information about a Log Entry resource.", + "description": "Partially update information about a Mail Header Footer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" }, "included": { "type": "array", @@ -17768,14 +17768,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } }, "responses": { "200": { - "description": "Detail of LogEntry", + "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -17787,7 +17787,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17796,7 +17796,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17813,14 +17813,14 @@ } } }, - "/mail-header-footer": { + "/mail-template": { "get": { "tags": [ - "Mail Header Footer" + "Mail Template" ], - "summary": "List with basic information of Mail Header Footer resources.", + "summary": "List with basic information of Mail Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMailHeaderFooterList", + "operationId": "getMailTemplateList", "parameters": [ { "name": "limit", @@ -17849,7 +17849,7 @@ ], "responses": { "200": { - "description": "List of Mail Header Footer resources.", + "description": "List of Mail Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17868,7 +17868,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } ] @@ -17882,16 +17882,16 @@ "type": "object", "properties": { "first": { - "example": "/mail-header-footer?limit=25" + "example": "/mail-template?limit=25" }, "last": { - "example": "/mail-header-footer?limit=25&page=11" + "example": "/mail-template?limit=25&page=11" }, "next": { - "example": "/mail-header-footer?limit=25&page=4" + "example": "/mail-template?limit=25&page=4" }, "prev": { - "example": "/mail-header-footer?limit=25&page=2" + "example": "/mail-template?limit=25&page=2" } } } @@ -17912,7 +17912,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -17927,11 +17927,11 @@ }, "post": { "tags": [ - "Mail Header Footer" + "Mail Template" ], - "summary": "Create a new Mail Header Footer resources.", + "summary": "Create a new Mail Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMailHeaderFooter", + "operationId": "createMailTemplate", "parameters": [ { "name": "_response", @@ -17953,7 +17953,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" }, "included": { "type": "array", @@ -17967,14 +17967,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { - "description": "Detail of MailHeaderFooter", + "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -17986,7 +17986,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -17995,7 +17995,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18009,19 +18009,19 @@ } } }, - "/mail-header-footer/{id}": { + "/mail-template/{id}": { "get": { "tags": [ - "Mail Header Footer" + "Mail Template" ], - "summary": "Detailed information about a Mail Header Footer resource.", + "summary": "Detailed information about a Mail Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMailHeaderFooter", + "operationId": "getMailTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_header_footer", + "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", @@ -18031,7 +18031,7 @@ ], "responses": { "200": { - "description": "Detail of MailHeaderFooter", + "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -18043,7 +18043,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18052,7 +18052,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18067,16 +18067,16 @@ }, "delete": { "tags": [ - "Mail Header Footer" + "Mail Template" ], - "summary": "Delete a Mail Header Footer resource.", + "summary": "Delete a Mail Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMailHeaderFooter", + "operationId": "deleteMailTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_header_footer", + "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", @@ -18107,16 +18107,16 @@ }, "patch": { "tags": [ - "Mail Header Footer" + "Mail Template" ], - "summary": "Partially update information about a Mail Header Footer resource.", + "summary": "Partially update information about a Mail Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMailHeaderFooter", + "operationId": "updateMailTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_header_footer", + "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", @@ -18134,14 +18134,14 @@ } ], "requestBody": { - "description": "Partially update information about a Mail Header Footer resource.", + "description": "Partially update information about a Mail Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" }, "included": { "type": "array", @@ -18155,14 +18155,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { - "description": "Detail of MailHeaderFooter", + "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -18174,7 +18174,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18183,7 +18183,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18200,14 +18200,14 @@ } } }, - "/mail-template": { + "/mail-template-type": { "get": { "tags": [ - "Mail Template" + "Mail Template Type" ], - "summary": "List with basic information of Mail Template resources.", + "summary": "List with basic information of Mail Template Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateList", + "operationId": "getMailTemplateTypeList", "parameters": [ { "name": "limit", @@ -18236,7 +18236,7 @@ ], "responses": { "200": { - "description": "List of Mail Template resources.", + "description": "List of Mail Template Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18255,7 +18255,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } ] @@ -18269,16 +18269,16 @@ "type": "object", "properties": { "first": { - "example": "/mail-template?limit=25" + "example": "/mail-template-type?limit=25" }, "last": { - "example": "/mail-template?limit=25&page=11" + "example": "/mail-template-type?limit=25&page=11" }, "next": { - "example": "/mail-template?limit=25&page=4" + "example": "/mail-template-type?limit=25&page=4" }, "prev": { - "example": "/mail-template?limit=25&page=2" + "example": "/mail-template-type?limit=25&page=2" } } } @@ -18299,7 +18299,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18314,11 +18314,11 @@ }, "post": { "tags": [ - "Mail Template" + "Mail Template Type" ], - "summary": "Create a new Mail Template resources.", + "summary": "Create a new Mail Template Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMailTemplate", + "operationId": "createMailTemplateType", "parameters": [ { "name": "_response", @@ -18340,7 +18340,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" }, "included": { "type": "array", @@ -18354,14 +18354,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } }, "responses": { "200": { - "description": "Detail of MailTemplate", + "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -18373,7 +18373,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18382,7 +18382,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18396,19 +18396,19 @@ } } }, - "/mail-template/{id}": { + "/mail-template-type/{id}": { "get": { "tags": [ - "Mail Template" + "Mail Template Type" ], - "summary": "Detailed information about a Mail Template resource.", + "summary": "Detailed information about a Mail Template Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplate", + "operationId": "getMailTemplateType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template", + "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", @@ -18418,7 +18418,7 @@ ], "responses": { "200": { - "description": "Detail of MailTemplate", + "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -18430,7 +18430,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18439,7 +18439,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18454,16 +18454,16 @@ }, "delete": { "tags": [ - "Mail Template" + "Mail Template Type" ], - "summary": "Delete a Mail Template resource.", + "summary": "Delete a Mail Template Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMailTemplate", + "operationId": "deleteMailTemplateType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template", + "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", @@ -18494,16 +18494,16 @@ }, "patch": { "tags": [ - "Mail Template" + "Mail Template Type" ], - "summary": "Partially update information about a Mail Template resource.", + "summary": "Partially update information about a Mail Template Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMailTemplate", + "operationId": "updateMailTemplateType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template", + "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", @@ -18521,14 +18521,14 @@ } ], "requestBody": { - "description": "Partially update information about a Mail Template resource.", + "description": "Partially update information about a Mail Template Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" }, "included": { "type": "array", @@ -18542,14 +18542,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } }, "responses": { "200": { - "description": "Detail of MailTemplate", + "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -18561,7 +18561,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18570,7 +18570,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18587,14 +18587,14 @@ } } }, - "/mail-template-type": { + "/main-category": { "get": { "tags": [ - "Mail Template Type" + "Main Category" ], - "summary": "List with basic information of Mail Template Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateTypeList", + "summary": "List with basic information of Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getMainCategoryList", "parameters": [ { "name": "limit", @@ -18623,7 +18623,7 @@ ], "responses": { "200": { - "description": "List of Mail Template Type resources.", + "description": "List of Main Category resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18642,7 +18642,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } ] @@ -18656,16 +18656,16 @@ "type": "object", "properties": { "first": { - "example": "/mail-template-type?limit=25" + "example": "/main-category?limit=25" }, "last": { - "example": "/mail-template-type?limit=25&page=11" + "example": "/main-category?limit=25&page=11" }, "next": { - "example": "/mail-template-type?limit=25&page=4" + "example": "/main-category?limit=25&page=4" }, "prev": { - "example": "/mail-template-type?limit=25&page=2" + "example": "/main-category?limit=25&page=2" } } } @@ -18686,7 +18686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18701,11 +18701,11 @@ }, "post": { "tags": [ - "Mail Template Type" + "Main Category" ], - "summary": "Create a new Mail Template Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMailTemplateType", + "summary": "Create a new Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createMainCategory", "parameters": [ { "name": "_response", @@ -18727,7 +18727,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" }, "included": { "type": "array", @@ -18741,14 +18741,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } }, "responses": { "200": { - "description": "Detail of MailTemplateType", + "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -18760,7 +18760,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18769,7 +18769,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18783,19 +18783,19 @@ } } }, - "/mail-template-type/{id}": { + "/main-category/{id}": { "get": { "tags": [ - "Mail Template Type" + "Main Category" ], - "summary": "Detailed information about a Mail Template Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateType", + "summary": "Detailed information about a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getMainCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template_type", + "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", @@ -18805,7 +18805,7 @@ ], "responses": { "200": { - "description": "Detail of MailTemplateType", + "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -18817,7 +18817,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18826,7 +18826,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18841,16 +18841,16 @@ }, "delete": { "tags": [ - "Mail Template Type" + "Main Category" ], - "summary": "Delete a Mail Template Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMailTemplateType", + "summary": "Delete a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteMainCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template_type", + "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", @@ -18881,16 +18881,16 @@ }, "patch": { "tags": [ - "Mail Template Type" + "Main Category" ], - "summary": "Partially update information about a Mail Template Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMailTemplateType", + "summary": "Partially update information about a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateMainCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template_type", + "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", @@ -18908,14 +18908,14 @@ } ], "requestBody": { - "description": "Partially update information about a Mail Template Type resource.", + "description": "Partially update information about a Main Category resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" }, "included": { "type": "array", @@ -18929,14 +18929,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } }, "responses": { "200": { - "description": "Detail of MailTemplateType", + "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -18948,7 +18948,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18957,7 +18957,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MainCategory" } } } @@ -18974,14 +18974,14 @@ } } }, - "/main-category": { + "/media": { "get": { "tags": [ - "Main Category" + "Media" ], - "summary": "List with basic information of Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getMainCategoryList", + "summary": "List with basic information of Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaList", "parameters": [ { "name": "limit", @@ -19010,7 +19010,7 @@ ], "responses": { "200": { - "description": "List of Main Category resources.", + "description": "List of Media resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19029,7 +19029,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } ] @@ -19043,16 +19043,16 @@ "type": "object", "properties": { "first": { - "example": "/main-category?limit=25" + "example": "/media?limit=25" }, "last": { - "example": "/main-category?limit=25&page=11" + "example": "/media?limit=25&page=11" }, "next": { - "example": "/main-category?limit=25&page=4" + "example": "/media?limit=25&page=4" }, "prev": { - "example": "/main-category?limit=25&page=2" + "example": "/media?limit=25&page=2" } } } @@ -19073,7 +19073,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19088,11 +19088,11 @@ }, "post": { "tags": [ - "Main Category" + "Media" ], - "summary": "Create a new Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createMainCategory", + "summary": "Create a new Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMedia", "parameters": [ { "name": "_response", @@ -19114,7 +19114,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" }, "included": { "type": "array", @@ -19128,14 +19128,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { - "description": "Detail of MainCategory", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -19147,7 +19147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19156,7 +19156,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19170,19 +19170,19 @@ } } }, - "/main-category/{id}": { + "/media/{id}": { "get": { "tags": [ - "Main Category" + "Media" ], - "summary": "Detailed information about a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getMainCategory", + "summary": "Detailed information about a Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the main_category", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -19192,7 +19192,7 @@ ], "responses": { "200": { - "description": "Detail of MainCategory", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -19204,7 +19204,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19213,7 +19213,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19228,16 +19228,16 @@ }, "delete": { "tags": [ - "Main Category" + "Media" ], - "summary": "Delete a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteMainCategory", + "summary": "Delete a Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the main_category", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -19268,16 +19268,16 @@ }, "patch": { "tags": [ - "Main Category" + "Media" ], - "summary": "Partially update information about a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateMainCategory", + "summary": "Partially update information about a Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the main_category", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -19295,14 +19295,14 @@ } ], "requestBody": { - "description": "Partially update information about a Main Category resource.", + "description": "Partially update information about a Media resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" }, "included": { "type": "array", @@ -19316,14 +19316,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { - "description": "Detail of MainCategory", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -19335,7 +19335,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19344,7 +19344,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Media" } } } @@ -19361,14 +19361,14 @@ } } }, - "/media": { + "/media-default-folder": { "get": { "tags": [ - "Media" + "Media Default Folder" ], - "summary": "List with basic information of Media resources.", + "summary": "List with basic information of Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaList", + "operationId": "getMediaDefaultFolderList", "parameters": [ { "name": "limit", @@ -19397,7 +19397,7 @@ ], "responses": { "200": { - "description": "List of Media resources.", + "description": "List of Media Default Folder resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19416,7 +19416,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } ] @@ -19430,16 +19430,16 @@ "type": "object", "properties": { "first": { - "example": "/media?limit=25" + "example": "/media-default-folder?limit=25" }, "last": { - "example": "/media?limit=25&page=11" + "example": "/media-default-folder?limit=25&page=11" }, "next": { - "example": "/media?limit=25&page=4" + "example": "/media-default-folder?limit=25&page=4" }, "prev": { - "example": "/media?limit=25&page=2" + "example": "/media-default-folder?limit=25&page=2" } } } @@ -19460,7 +19460,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19475,11 +19475,11 @@ }, "post": { "tags": [ - "Media" + "Media Default Folder" ], - "summary": "Create a new Media resources.", + "summary": "Create a new Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMedia", + "operationId": "createMediaDefaultFolder", "parameters": [ { "name": "_response", @@ -19501,7 +19501,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" }, "included": { "type": "array", @@ -19515,14 +19515,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19534,7 +19534,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19543,7 +19543,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19557,19 +19557,19 @@ } } }, - "/media/{id}": { + "/media-default-folder/{id}": { "get": { "tags": [ - "Media" + "Media Default Folder" ], - "summary": "Detailed information about a Media resource.", + "summary": "Detailed information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMedia", + "operationId": "getMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -19579,7 +19579,7 @@ ], "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19591,7 +19591,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19600,7 +19600,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19615,16 +19615,16 @@ }, "delete": { "tags": [ - "Media" + "Media Default Folder" ], - "summary": "Delete a Media resource.", + "summary": "Delete a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMedia", + "operationId": "deleteMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -19655,16 +19655,16 @@ }, "patch": { "tags": [ - "Media" + "Media Default Folder" ], - "summary": "Partially update information about a Media resource.", + "summary": "Partially update information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMedia", + "operationId": "updateMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -19682,14 +19682,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media resource.", + "description": "Partially update information about a Media Default Folder resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" }, "included": { "type": "array", @@ -19703,14 +19703,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19722,7 +19722,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19731,7 +19731,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19748,14 +19748,14 @@ } } }, - "/media-default-folder": { + "/media-folder": { "get": { "tags": [ - "Media Default Folder" + "Media Folder" ], - "summary": "List with basic information of Media Default Folder resources.", + "summary": "List with basic information of Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolderList", + "operationId": "getMediaFolderList", "parameters": [ { "name": "limit", @@ -19784,7 +19784,7 @@ ], "responses": { "200": { - "description": "List of Media Default Folder resources.", + "description": "List of Media Folder resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19803,7 +19803,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } ] @@ -19817,16 +19817,16 @@ "type": "object", "properties": { "first": { - "example": "/media-default-folder?limit=25" + "example": "/media-folder?limit=25" }, "last": { - "example": "/media-default-folder?limit=25&page=11" + "example": "/media-folder?limit=25&page=11" }, "next": { - "example": "/media-default-folder?limit=25&page=4" + "example": "/media-folder?limit=25&page=4" }, "prev": { - "example": "/media-default-folder?limit=25&page=2" + "example": "/media-folder?limit=25&page=2" } } } @@ -19847,7 +19847,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -19862,11 +19862,11 @@ }, "post": { "tags": [ - "Media Default Folder" + "Media Folder" ], - "summary": "Create a new Media Default Folder resources.", + "summary": "Create a new Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaDefaultFolder", + "operationId": "createMediaFolder", "parameters": [ { "name": "_response", @@ -19888,7 +19888,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" }, "included": { "type": "array", @@ -19902,14 +19902,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19921,7 +19921,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -19930,7 +19930,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -19944,19 +19944,19 @@ } } }, - "/media-default-folder/{id}": { + "/media-folder/{id}": { "get": { "tags": [ - "Media Default Folder" + "Media Folder" ], - "summary": "Detailed information about a Media Default Folder resource.", + "summary": "Detailed information about a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolder", + "operationId": "getMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -19966,7 +19966,7 @@ ], "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19978,7 +19978,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -19987,7 +19987,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20002,16 +20002,16 @@ }, "delete": { "tags": [ - "Media Default Folder" + "Media Folder" ], - "summary": "Delete a Media Default Folder resource.", + "summary": "Delete a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaDefaultFolder", + "operationId": "deleteMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -20042,16 +20042,16 @@ }, "patch": { "tags": [ - "Media Default Folder" + "Media Folder" ], - "summary": "Partially update information about a Media Default Folder resource.", + "summary": "Partially update information about a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaDefaultFolder", + "operationId": "updateMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -20069,14 +20069,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Default Folder resource.", + "description": "Partially update information about a Media Folder resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" }, "included": { "type": "array", @@ -20090,14 +20090,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -20109,7 +20109,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20118,7 +20118,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20135,14 +20135,14 @@ } } }, - "/media-folder": { + "/media-folder-configuration": { "get": { "tags": [ - "Media Folder" + "Media Folder Configuration" ], - "summary": "List with basic information of Media Folder resources.", + "summary": "List with basic information of Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderList", + "operationId": "getMediaFolderConfigurationList", "parameters": [ { "name": "limit", @@ -20171,7 +20171,7 @@ ], "responses": { "200": { - "description": "List of Media Folder resources.", + "description": "List of Media Folder Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20190,7 +20190,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } ] @@ -20204,16 +20204,16 @@ "type": "object", "properties": { "first": { - "example": "/media-folder?limit=25" + "example": "/media-folder-configuration?limit=25" }, "last": { - "example": "/media-folder?limit=25&page=11" + "example": "/media-folder-configuration?limit=25&page=11" }, "next": { - "example": "/media-folder?limit=25&page=4" + "example": "/media-folder-configuration?limit=25&page=4" }, "prev": { - "example": "/media-folder?limit=25&page=2" + "example": "/media-folder-configuration?limit=25&page=2" } } } @@ -20234,7 +20234,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20249,11 +20249,11 @@ }, "post": { "tags": [ - "Media Folder" + "Media Folder Configuration" ], - "summary": "Create a new Media Folder resources.", + "summary": "Create a new Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolder", + "operationId": "createMediaFolderConfiguration", "parameters": [ { "name": "_response", @@ -20275,7 +20275,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" }, "included": { "type": "array", @@ -20289,14 +20289,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -20308,7 +20308,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20317,7 +20317,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20331,19 +20331,19 @@ } } }, - "/media-folder/{id}": { + "/media-folder-configuration/{id}": { "get": { "tags": [ - "Media Folder" + "Media Folder Configuration" ], - "summary": "Detailed information about a Media Folder resource.", + "summary": "Detailed information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolder", + "operationId": "getMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -20353,7 +20353,7 @@ ], "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -20365,7 +20365,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20374,7 +20374,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20389,16 +20389,16 @@ }, "delete": { "tags": [ - "Media Folder" + "Media Folder Configuration" ], - "summary": "Delete a Media Folder resource.", + "summary": "Delete a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolder", + "operationId": "deleteMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -20429,16 +20429,16 @@ }, "patch": { "tags": [ - "Media Folder" + "Media Folder Configuration" ], - "summary": "Partially update information about a Media Folder resource.", + "summary": "Partially update information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolder", + "operationId": "updateMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -20456,14 +20456,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Folder resource.", + "description": "Partially update information about a Media Folder Configuration resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" }, "included": { "type": "array", @@ -20477,14 +20477,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -20496,7 +20496,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20505,7 +20505,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20522,14 +20522,14 @@ } } }, - "/media-folder-configuration": { + "/media-thumbnail": { "get": { "tags": [ - "Media Folder Configuration" + "Media Thumbnail" ], - "summary": "List with basic information of Media Folder Configuration resources.", + "summary": "List with basic information of Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfigurationList", + "operationId": "getMediaThumbnailList", "parameters": [ { "name": "limit", @@ -20558,7 +20558,7 @@ ], "responses": { "200": { - "description": "List of Media Folder Configuration resources.", + "description": "List of Media Thumbnail resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20577,7 +20577,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } ] @@ -20591,16 +20591,16 @@ "type": "object", "properties": { "first": { - "example": "/media-folder-configuration?limit=25" + "example": "/media-thumbnail?limit=25" }, "last": { - "example": "/media-folder-configuration?limit=25&page=11" + "example": "/media-thumbnail?limit=25&page=11" }, "next": { - "example": "/media-folder-configuration?limit=25&page=4" + "example": "/media-thumbnail?limit=25&page=4" }, "prev": { - "example": "/media-folder-configuration?limit=25&page=2" + "example": "/media-thumbnail?limit=25&page=2" } } } @@ -20621,7 +20621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20636,11 +20636,11 @@ }, "post": { "tags": [ - "Media Folder Configuration" + "Media Thumbnail" ], - "summary": "Create a new Media Folder Configuration resources.", + "summary": "Create a new Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolderConfiguration", + "operationId": "createMediaThumbnail", "parameters": [ { "name": "_response", @@ -20662,7 +20662,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" }, "included": { "type": "array", @@ -20676,14 +20676,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -20695,7 +20695,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20704,7 +20704,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20718,19 +20718,19 @@ } } }, - "/media-folder-configuration/{id}": { + "/media-thumbnail/{id}": { "get": { "tags": [ - "Media Folder Configuration" + "Media Thumbnail" ], - "summary": "Detailed information about a Media Folder Configuration resource.", + "summary": "Detailed information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfiguration", + "operationId": "getMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -20740,7 +20740,7 @@ ], "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -20752,7 +20752,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20761,7 +20761,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20776,16 +20776,16 @@ }, "delete": { "tags": [ - "Media Folder Configuration" + "Media Thumbnail" ], - "summary": "Delete a Media Folder Configuration resource.", + "summary": "Delete a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolderConfiguration", + "operationId": "deleteMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -20816,16 +20816,16 @@ }, "patch": { "tags": [ - "Media Folder Configuration" + "Media Thumbnail" ], - "summary": "Partially update information about a Media Folder Configuration resource.", + "summary": "Partially update information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolderConfiguration", + "operationId": "updateMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -20843,14 +20843,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Folder Configuration resource.", + "description": "Partially update information about a Media Thumbnail resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" }, "included": { "type": "array", @@ -20864,14 +20864,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -20883,7 +20883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20892,7 +20892,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -20909,14 +20909,14 @@ } } }, - "/media-thumbnail": { + "/media-thumbnail-size": { "get": { "tags": [ - "Media Thumbnail" + "Media Thumbnail Size" ], - "summary": "List with basic information of Media Thumbnail resources.", + "summary": "List with basic information of Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailList", + "operationId": "getMediaThumbnailSizeList", "parameters": [ { "name": "limit", @@ -20945,7 +20945,7 @@ ], "responses": { "200": { - "description": "List of Media Thumbnail resources.", + "description": "List of Media Thumbnail Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20964,7 +20964,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } ] @@ -20978,16 +20978,16 @@ "type": "object", "properties": { "first": { - "example": "/media-thumbnail?limit=25" + "example": "/media-thumbnail-size?limit=25" }, "last": { - "example": "/media-thumbnail?limit=25&page=11" + "example": "/media-thumbnail-size?limit=25&page=11" }, "next": { - "example": "/media-thumbnail?limit=25&page=4" + "example": "/media-thumbnail-size?limit=25&page=4" }, "prev": { - "example": "/media-thumbnail?limit=25&page=2" + "example": "/media-thumbnail-size?limit=25&page=2" } } } @@ -21008,7 +21008,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21023,11 +21023,11 @@ }, "post": { "tags": [ - "Media Thumbnail" + "Media Thumbnail Size" ], - "summary": "Create a new Media Thumbnail resources.", + "summary": "Create a new Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnail", + "operationId": "createMediaThumbnailSize", "parameters": [ { "name": "_response", @@ -21049,7 +21049,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" }, "included": { "type": "array", @@ -21063,14 +21063,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -21082,7 +21082,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21091,7 +21091,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21105,19 +21105,19 @@ } } }, - "/media-thumbnail/{id}": { + "/media-thumbnail-size/{id}": { "get": { "tags": [ - "Media Thumbnail" + "Media Thumbnail Size" ], - "summary": "Detailed information about a Media Thumbnail resource.", + "summary": "Detailed information about a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnail", + "operationId": "getMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -21127,7 +21127,7 @@ ], "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -21139,7 +21139,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21148,7 +21148,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21163,16 +21163,16 @@ }, "delete": { "tags": [ - "Media Thumbnail" + "Media Thumbnail Size" ], - "summary": "Delete a Media Thumbnail resource.", + "summary": "Delete a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnail", + "operationId": "deleteMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -21203,16 +21203,16 @@ }, "patch": { "tags": [ - "Media Thumbnail" + "Media Thumbnail Size" ], - "summary": "Partially update information about a Media Thumbnail resource.", + "summary": "Partially update information about a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnail", + "operationId": "updateMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -21230,14 +21230,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Thumbnail resource.", + "description": "Partially update information about a Media Thumbnail Size resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" }, "included": { "type": "array", @@ -21251,14 +21251,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -21270,7 +21270,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21279,7 +21279,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21296,14 +21296,14 @@ } } }, - "/media-thumbnail-size": { + "/newsletter-recipient": { "get": { "tags": [ - "Media Thumbnail Size" + "Newsletter Recipient" ], - "summary": "List with basic information of Media Thumbnail Size resources.", + "summary": "List with basic information of Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSizeList", + "operationId": "getNewsletterRecipientList", "parameters": [ { "name": "limit", @@ -21332,7 +21332,7 @@ ], "responses": { "200": { - "description": "List of Media Thumbnail Size resources.", + "description": "List of Newsletter Recipient resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21351,7 +21351,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } ] @@ -21365,16 +21365,16 @@ "type": "object", "properties": { "first": { - "example": "/media-thumbnail-size?limit=25" + "example": "/newsletter-recipient?limit=25" }, "last": { - "example": "/media-thumbnail-size?limit=25&page=11" + "example": "/newsletter-recipient?limit=25&page=11" }, "next": { - "example": "/media-thumbnail-size?limit=25&page=4" + "example": "/newsletter-recipient?limit=25&page=4" }, "prev": { - "example": "/media-thumbnail-size?limit=25&page=2" + "example": "/newsletter-recipient?limit=25&page=2" } } } @@ -21395,7 +21395,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21410,11 +21410,11 @@ }, "post": { "tags": [ - "Media Thumbnail Size" + "Newsletter Recipient" ], - "summary": "Create a new Media Thumbnail Size resources.", + "summary": "Create a new Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnailSize", + "operationId": "createNewsletterRecipient", "parameters": [ { "name": "_response", @@ -21436,7 +21436,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" }, "included": { "type": "array", @@ -21450,14 +21450,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -21469,7 +21469,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21478,7 +21478,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21492,19 +21492,19 @@ } } }, - "/media-thumbnail-size/{id}": { + "/newsletter-recipient/{id}": { "get": { "tags": [ - "Media Thumbnail Size" + "Newsletter Recipient" ], - "summary": "Detailed information about a Media Thumbnail Size resource.", + "summary": "Detailed information about a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSize", + "operationId": "getNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -21514,7 +21514,7 @@ ], "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -21526,7 +21526,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21535,7 +21535,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21550,16 +21550,16 @@ }, "delete": { "tags": [ - "Media Thumbnail Size" + "Newsletter Recipient" ], - "summary": "Delete a Media Thumbnail Size resource.", + "summary": "Delete a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnailSize", + "operationId": "deleteNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -21590,16 +21590,16 @@ }, "patch": { "tags": [ - "Media Thumbnail Size" + "Newsletter Recipient" ], - "summary": "Partially update information about a Media Thumbnail Size resource.", + "summary": "Partially update information about a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnailSize", + "operationId": "updateNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -21617,14 +21617,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Thumbnail Size resource.", + "description": "Partially update information about a Newsletter Recipient resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" }, "included": { "type": "array", @@ -21638,14 +21638,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -21657,7 +21657,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21666,7 +21666,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21683,14 +21683,14 @@ } } }, - "/newsletter-recipient": { + "/notification": { "get": { "tags": [ - "Newsletter Recipient" + "Notification" ], - "summary": "List with basic information of Newsletter Recipient resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipientList", + "summary": "List with basic information of Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotificationList", "parameters": [ { "name": "limit", @@ -21719,7 +21719,7 @@ ], "responses": { "200": { - "description": "List of Newsletter Recipient resources.", + "description": "List of Notification resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21738,7 +21738,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } ] @@ -21752,16 +21752,16 @@ "type": "object", "properties": { "first": { - "example": "/newsletter-recipient?limit=25" + "example": "/notification?limit=25" }, "last": { - "example": "/newsletter-recipient?limit=25&page=11" + "example": "/notification?limit=25&page=11" }, "next": { - "example": "/newsletter-recipient?limit=25&page=4" + "example": "/notification?limit=25&page=4" }, "prev": { - "example": "/newsletter-recipient?limit=25&page=2" + "example": "/notification?limit=25&page=2" } } } @@ -21782,7 +21782,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -21797,11 +21797,11 @@ }, "post": { "tags": [ - "Newsletter Recipient" + "Notification" ], - "summary": "Create a new Newsletter Recipient resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNewsletterRecipient", + "summary": "Create a new Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createNotification", "parameters": [ { "name": "_response", @@ -21823,7 +21823,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" }, "included": { "type": "array", @@ -21837,14 +21837,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -21856,7 +21856,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -21865,7 +21865,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -21879,19 +21879,19 @@ } } }, - "/newsletter-recipient/{id}": { + "/notification/{id}": { "get": { "tags": [ - "Newsletter Recipient" + "Notification" ], - "summary": "Detailed information about a Newsletter Recipient resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipient", + "summary": "Detailed information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -21901,7 +21901,7 @@ ], "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -21913,7 +21913,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -21922,7 +21922,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -21937,16 +21937,16 @@ }, "delete": { "tags": [ - "Newsletter Recipient" + "Notification" ], - "summary": "Delete a Newsletter Recipient resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNewsletterRecipient", + "summary": "Delete a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -21977,16 +21977,16 @@ }, "patch": { "tags": [ - "Newsletter Recipient" + "Notification" ], - "summary": "Partially update information about a Newsletter Recipient resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNewsletterRecipient", + "summary": "Partially update information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "updateNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -22004,14 +22004,14 @@ } ], "requestBody": { - "description": "Partially update information about a Newsletter Recipient resource.", + "description": "Partially update information about a Notification resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" }, "included": { "type": "array", @@ -22025,14 +22025,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -22044,7 +22044,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -22053,7 +22053,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/Notification" } } } @@ -22070,14 +22070,14 @@ } } }, - "/notification": { + "/number-range": { "get": { "tags": [ - "Notification" + "Number Range" ], - "summary": "List with basic information of Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotificationList", + "summary": "List with basic information of Number Range resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeList", "parameters": [ { "name": "limit", @@ -22106,7 +22106,7 @@ ], "responses": { "200": { - "description": "List of Notification resources.", + "description": "List of Number Range resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22125,7 +22125,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } ] @@ -22139,16 +22139,16 @@ "type": "object", "properties": { "first": { - "example": "/notification?limit=25" + "example": "/number-range?limit=25" }, "last": { - "example": "/notification?limit=25&page=11" + "example": "/number-range?limit=25&page=11" }, "next": { - "example": "/notification?limit=25&page=4" + "example": "/number-range?limit=25&page=4" }, "prev": { - "example": "/notification?limit=25&page=2" + "example": "/number-range?limit=25&page=2" } } } @@ -22169,7 +22169,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22184,11 +22184,11 @@ }, "post": { "tags": [ - "Notification" + "Number Range" ], - "summary": "Create a new Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createNotification", + "summary": "Create a new Number Range resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNumberRange", "parameters": [ { "name": "_response", @@ -22210,7 +22210,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" }, "included": { "type": "array", @@ -22224,14 +22224,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -22243,7 +22243,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22252,7 +22252,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22266,19 +22266,19 @@ } } }, - "/notification/{id}": { + "/number-range/{id}": { "get": { "tags": [ - "Notification" + "Number Range" ], - "summary": "Detailed information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotification", + "summary": "Detailed information about a Number Range resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -22288,7 +22288,7 @@ ], "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -22300,7 +22300,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22309,7 +22309,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22324,16 +22324,16 @@ }, "delete": { "tags": [ - "Notification" + "Number Range" ], - "summary": "Delete a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteNotification", + "summary": "Delete a Number Range resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -22364,16 +22364,16 @@ }, "patch": { "tags": [ - "Notification" + "Number Range" ], - "summary": "Partially update information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateNotification", + "summary": "Partially update information about a Number Range resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -22391,14 +22391,14 @@ } ], "requestBody": { - "description": "Partially update information about a Notification resource.", + "description": "Partially update information about a Number Range resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" }, "included": { "type": "array", @@ -22412,14 +22412,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -22431,7 +22431,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22440,7 +22440,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22457,14 +22457,14 @@ } } }, - "/number-range": { + "/number-range-sales-channel": { "get": { "tags": [ - "Number Range" + "Number Range Sales Channel" ], - "summary": "List with basic information of Number Range resources.", + "summary": "List with basic information of Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeList", + "operationId": "getNumberRangeSalesChannelList", "parameters": [ { "name": "limit", @@ -22493,7 +22493,7 @@ ], "responses": { "200": { - "description": "List of Number Range resources.", + "description": "List of Number Range Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22512,7 +22512,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } ] @@ -22526,16 +22526,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range?limit=25" + "example": "/number-range-sales-channel?limit=25" }, "last": { - "example": "/number-range?limit=25&page=11" + "example": "/number-range-sales-channel?limit=25&page=11" }, "next": { - "example": "/number-range?limit=25&page=4" + "example": "/number-range-sales-channel?limit=25&page=4" }, "prev": { - "example": "/number-range?limit=25&page=2" + "example": "/number-range-sales-channel?limit=25&page=2" } } } @@ -22556,7 +22556,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22571,11 +22571,11 @@ }, "post": { "tags": [ - "Number Range" + "Number Range Sales Channel" ], - "summary": "Create a new Number Range resources.", + "summary": "Create a new Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRange", + "operationId": "createNumberRangeSalesChannel", "parameters": [ { "name": "_response", @@ -22597,7 +22597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" }, "included": { "type": "array", @@ -22611,14 +22611,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -22630,7 +22630,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22639,7 +22639,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22653,19 +22653,19 @@ } } }, - "/number-range/{id}": { + "/number-range-sales-channel/{id}": { "get": { "tags": [ - "Number Range" + "Number Range Sales Channel" ], - "summary": "Detailed information about a Number Range resource.", + "summary": "Detailed information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRange", + "operationId": "getNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -22675,7 +22675,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -22687,7 +22687,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22696,7 +22696,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22711,16 +22711,16 @@ }, "delete": { "tags": [ - "Number Range" + "Number Range Sales Channel" ], - "summary": "Delete a Number Range resource.", + "summary": "Delete a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRange", + "operationId": "deleteNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -22751,16 +22751,16 @@ }, "patch": { "tags": [ - "Number Range" + "Number Range Sales Channel" ], - "summary": "Partially update information about a Number Range resource.", + "summary": "Partially update information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRange", + "operationId": "updateNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -22778,14 +22778,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range resource.", + "description": "Partially update information about a Number Range Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" }, "included": { "type": "array", @@ -22799,14 +22799,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -22818,7 +22818,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22827,7 +22827,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22844,14 +22844,14 @@ } } }, - "/number-range-sales-channel": { + "/number-range-state": { "get": { "tags": [ - "Number Range Sales Channel" + "Number Range State" ], - "summary": "List with basic information of Number Range Sales Channel resources.", + "summary": "List with basic information of Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannelList", + "operationId": "getNumberRangeStateList", "parameters": [ { "name": "limit", @@ -22880,7 +22880,7 @@ ], "responses": { "200": { - "description": "List of Number Range Sales Channel resources.", + "description": "List of Number Range State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22899,7 +22899,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } ] @@ -22913,16 +22913,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-sales-channel?limit=25" + "example": "/number-range-state?limit=25" }, "last": { - "example": "/number-range-sales-channel?limit=25&page=11" + "example": "/number-range-state?limit=25&page=11" }, "next": { - "example": "/number-range-sales-channel?limit=25&page=4" + "example": "/number-range-state?limit=25&page=4" }, "prev": { - "example": "/number-range-sales-channel?limit=25&page=2" + "example": "/number-range-state?limit=25&page=2" } } } @@ -22943,7 +22943,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -22958,11 +22958,11 @@ }, "post": { "tags": [ - "Number Range Sales Channel" + "Number Range State" ], - "summary": "Create a new Number Range Sales Channel resources.", + "summary": "Create a new Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeSalesChannel", + "operationId": "createNumberRangeState", "parameters": [ { "name": "_response", @@ -22984,7 +22984,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" }, "included": { "type": "array", @@ -22998,14 +22998,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -23017,7 +23017,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23026,7 +23026,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23040,19 +23040,19 @@ } } }, - "/number-range-sales-channel/{id}": { + "/number-range-state/{id}": { "get": { "tags": [ - "Number Range Sales Channel" + "Number Range State" ], - "summary": "Detailed information about a Number Range Sales Channel resource.", + "summary": "Detailed information about a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannel", + "operationId": "getNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -23062,7 +23062,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -23074,7 +23074,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23083,7 +23083,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23098,16 +23098,16 @@ }, "delete": { "tags": [ - "Number Range Sales Channel" + "Number Range State" ], - "summary": "Delete a Number Range Sales Channel resource.", + "summary": "Delete a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeSalesChannel", + "operationId": "deleteNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -23138,16 +23138,16 @@ }, "patch": { "tags": [ - "Number Range Sales Channel" + "Number Range State" ], - "summary": "Partially update information about a Number Range Sales Channel resource.", + "summary": "Partially update information about a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeSalesChannel", + "operationId": "updateNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -23165,14 +23165,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range Sales Channel resource.", + "description": "Partially update information about a Number Range State resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" }, "included": { "type": "array", @@ -23186,14 +23186,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -23205,7 +23205,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23214,7 +23214,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23231,14 +23231,14 @@ } } }, - "/number-range-state": { + "/number-range-type": { "get": { "tags": [ - "Number Range State" + "Number Range Type" ], - "summary": "List with basic information of Number Range State resources.", + "summary": "List with basic information of Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeStateList", + "operationId": "getNumberRangeTypeList", "parameters": [ { "name": "limit", @@ -23267,7 +23267,7 @@ ], "responses": { "200": { - "description": "List of Number Range State resources.", + "description": "List of Number Range Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23286,7 +23286,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } ] @@ -23300,16 +23300,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-state?limit=25" + "example": "/number-range-type?limit=25" }, "last": { - "example": "/number-range-state?limit=25&page=11" + "example": "/number-range-type?limit=25&page=11" }, "next": { - "example": "/number-range-state?limit=25&page=4" + "example": "/number-range-type?limit=25&page=4" }, "prev": { - "example": "/number-range-state?limit=25&page=2" + "example": "/number-range-type?limit=25&page=2" } } } @@ -23330,7 +23330,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23345,11 +23345,11 @@ }, "post": { "tags": [ - "Number Range State" + "Number Range Type" ], - "summary": "Create a new Number Range State resources.", + "summary": "Create a new Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeState", + "operationId": "createNumberRangeType", "parameters": [ { "name": "_response", @@ -23371,7 +23371,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" }, "included": { "type": "array", @@ -23385,14 +23385,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -23404,7 +23404,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23413,7 +23413,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23427,19 +23427,19 @@ } } }, - "/number-range-state/{id}": { + "/number-range-type/{id}": { "get": { "tags": [ - "Number Range State" + "Number Range Type" ], - "summary": "Detailed information about a Number Range State resource.", + "summary": "Detailed information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeState", + "operationId": "getNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -23449,7 +23449,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -23461,7 +23461,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23470,7 +23470,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23485,16 +23485,16 @@ }, "delete": { "tags": [ - "Number Range State" + "Number Range Type" ], - "summary": "Delete a Number Range State resource.", + "summary": "Delete a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeState", + "operationId": "deleteNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -23525,16 +23525,16 @@ }, "patch": { "tags": [ - "Number Range State" + "Number Range Type" ], - "summary": "Partially update information about a Number Range State resource.", + "summary": "Partially update information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeState", + "operationId": "updateNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -23552,14 +23552,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range State resource.", + "description": "Partially update information about a Number Range Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" }, "included": { "type": "array", @@ -23573,14 +23573,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -23592,7 +23592,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23601,7 +23601,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23618,14 +23618,14 @@ } } }, - "/number-range-type": { + "/order": { "get": { "tags": [ - "Number Range Type" + "Order" ], - "summary": "List with basic information of Number Range Type resources.", + "summary": "List with basic information of Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeTypeList", + "operationId": "getOrderList", "parameters": [ { "name": "limit", @@ -23654,7 +23654,7 @@ ], "responses": { "200": { - "description": "List of Number Range Type resources.", + "description": "List of Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23673,7 +23673,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } ] @@ -23687,16 +23687,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-type?limit=25" + "example": "/order?limit=25" }, "last": { - "example": "/number-range-type?limit=25&page=11" + "example": "/order?limit=25&page=11" }, "next": { - "example": "/number-range-type?limit=25&page=4" + "example": "/order?limit=25&page=4" }, "prev": { - "example": "/number-range-type?limit=25&page=2" + "example": "/order?limit=25&page=2" } } } @@ -23717,7 +23717,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -23732,11 +23732,11 @@ }, "post": { "tags": [ - "Number Range Type" + "Order" ], - "summary": "Create a new Number Range Type resources.", + "summary": "Create a new Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeType", + "operationId": "createOrder", "parameters": [ { "name": "_response", @@ -23758,7 +23758,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" }, "included": { "type": "array", @@ -23772,14 +23772,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -23791,7 +23791,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -23800,7 +23800,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -23814,19 +23814,19 @@ } } }, - "/number-range-type/{id}": { + "/order/{id}": { "get": { "tags": [ - "Number Range Type" + "Order" ], - "summary": "Detailed information about a Number Range Type resource.", + "summary": "Detailed information about a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeType", + "operationId": "getOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -23836,7 +23836,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -23848,7 +23848,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -23857,7 +23857,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -23872,16 +23872,16 @@ }, "delete": { "tags": [ - "Number Range Type" + "Order" ], - "summary": "Delete a Number Range Type resource.", + "summary": "Delete a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeType", + "operationId": "deleteOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -23912,16 +23912,16 @@ }, "patch": { "tags": [ - "Number Range Type" + "Order" ], - "summary": "Partially update information about a Number Range Type resource.", + "summary": "Partially update information about a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeType", + "operationId": "updateOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -23939,14 +23939,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range Type resource.", + "description": "Partially update information about a Order resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" }, "included": { "type": "array", @@ -23960,14 +23960,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -23979,7 +23979,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -23988,7 +23988,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/Order" } } } @@ -24005,14 +24005,14 @@ } } }, - "/order": { + "/order-address": { "get": { "tags": [ - "Order" + "Order Address" ], - "summary": "List with basic information of Order resources.", + "summary": "List with basic information of Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderList", + "operationId": "getOrderAddressList", "parameters": [ { "name": "limit", @@ -24041,7 +24041,7 @@ ], "responses": { "200": { - "description": "List of Order resources.", + "description": "List of Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24060,7 +24060,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } ] @@ -24074,16 +24074,16 @@ "type": "object", "properties": { "first": { - "example": "/order?limit=25" + "example": "/order-address?limit=25" }, "last": { - "example": "/order?limit=25&page=11" + "example": "/order-address?limit=25&page=11" }, "next": { - "example": "/order?limit=25&page=4" + "example": "/order-address?limit=25&page=4" }, "prev": { - "example": "/order?limit=25&page=2" + "example": "/order-address?limit=25&page=2" } } } @@ -24104,7 +24104,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24119,11 +24119,11 @@ }, "post": { "tags": [ - "Order" + "Order Address" ], - "summary": "Create a new Order resources.", + "summary": "Create a new Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrder", + "operationId": "createOrderAddress", "parameters": [ { "name": "_response", @@ -24145,7 +24145,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" }, "included": { "type": "array", @@ -24159,14 +24159,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -24178,7 +24178,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24187,7 +24187,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24201,19 +24201,19 @@ } } }, - "/order/{id}": { + "/order-address/{id}": { "get": { "tags": [ - "Order" + "Order Address" ], - "summary": "Detailed information about a Order resource.", + "summary": "Detailed information about a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrder", + "operationId": "getOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -24223,7 +24223,7 @@ ], "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -24235,7 +24235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24244,7 +24244,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24259,16 +24259,16 @@ }, "delete": { "tags": [ - "Order" + "Order Address" ], - "summary": "Delete a Order resource.", + "summary": "Delete a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrder", + "operationId": "deleteOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -24299,16 +24299,16 @@ }, "patch": { "tags": [ - "Order" + "Order Address" ], - "summary": "Partially update information about a Order resource.", + "summary": "Partially update information about a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrder", + "operationId": "updateOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -24326,14 +24326,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order resource.", + "description": "Partially update information about a Order Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" }, "included": { "type": "array", @@ -24347,14 +24347,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -24366,7 +24366,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24375,7 +24375,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24392,14 +24392,14 @@ } } }, - "/order-address": { + "/order-customer": { "get": { "tags": [ - "Order Address" + "Order Customer" ], - "summary": "List with basic information of Order Address resources.", + "summary": "List with basic information of Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddressList", + "operationId": "getOrderCustomerList", "parameters": [ { "name": "limit", @@ -24428,7 +24428,7 @@ ], "responses": { "200": { - "description": "List of Order Address resources.", + "description": "List of Order Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24447,7 +24447,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } ] @@ -24461,16 +24461,16 @@ "type": "object", "properties": { "first": { - "example": "/order-address?limit=25" + "example": "/order-customer?limit=25" }, "last": { - "example": "/order-address?limit=25&page=11" + "example": "/order-customer?limit=25&page=11" }, "next": { - "example": "/order-address?limit=25&page=4" + "example": "/order-customer?limit=25&page=4" }, "prev": { - "example": "/order-address?limit=25&page=2" + "example": "/order-customer?limit=25&page=2" } } } @@ -24491,7 +24491,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24506,11 +24506,11 @@ }, "post": { "tags": [ - "Order Address" + "Order Customer" ], - "summary": "Create a new Order Address resources.", + "summary": "Create a new Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderAddress", + "operationId": "createOrderCustomer", "parameters": [ { "name": "_response", @@ -24532,7 +24532,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" }, "included": { "type": "array", @@ -24546,14 +24546,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -24565,7 +24565,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24574,7 +24574,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24588,19 +24588,19 @@ } } }, - "/order-address/{id}": { + "/order-customer/{id}": { "get": { "tags": [ - "Order Address" + "Order Customer" ], - "summary": "Detailed information about a Order Address resource.", + "summary": "Detailed information about a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddress", + "operationId": "getOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -24610,7 +24610,7 @@ ], "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -24622,7 +24622,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24631,7 +24631,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24646,16 +24646,16 @@ }, "delete": { "tags": [ - "Order Address" + "Order Customer" ], - "summary": "Delete a Order Address resource.", + "summary": "Delete a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderAddress", + "operationId": "deleteOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -24686,16 +24686,16 @@ }, "patch": { "tags": [ - "Order Address" + "Order Customer" ], - "summary": "Partially update information about a Order Address resource.", + "summary": "Partially update information about a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderAddress", + "operationId": "updateOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -24713,14 +24713,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Address resource.", + "description": "Partially update information about a Order Customer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" }, "included": { "type": "array", @@ -24734,14 +24734,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -24753,7 +24753,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24762,7 +24762,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24779,14 +24779,14 @@ } } }, - "/order-customer": { + "/order-delivery": { "get": { "tags": [ - "Order Customer" + "Order Delivery" ], - "summary": "List with basic information of Order Customer resources.", + "summary": "List with basic information of Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomerList", + "operationId": "getOrderDeliveryList", "parameters": [ { "name": "limit", @@ -24815,7 +24815,7 @@ ], "responses": { "200": { - "description": "List of Order Customer resources.", + "description": "List of Order Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24834,7 +24834,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } ] @@ -24848,16 +24848,16 @@ "type": "object", "properties": { "first": { - "example": "/order-customer?limit=25" + "example": "/order-delivery?limit=25" }, "last": { - "example": "/order-customer?limit=25&page=11" + "example": "/order-delivery?limit=25&page=11" }, "next": { - "example": "/order-customer?limit=25&page=4" + "example": "/order-delivery?limit=25&page=4" }, "prev": { - "example": "/order-customer?limit=25&page=2" + "example": "/order-delivery?limit=25&page=2" } } } @@ -24878,7 +24878,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -24893,11 +24893,11 @@ }, "post": { "tags": [ - "Order Customer" + "Order Delivery" ], - "summary": "Create a new Order Customer resources.", + "summary": "Create a new Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderCustomer", + "operationId": "createOrderDelivery", "parameters": [ { "name": "_response", @@ -24919,7 +24919,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" }, "included": { "type": "array", @@ -24933,14 +24933,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24952,7 +24952,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -24961,7 +24961,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -24975,19 +24975,19 @@ } } }, - "/order-customer/{id}": { + "/order-delivery/{id}": { "get": { "tags": [ - "Order Customer" + "Order Delivery" ], - "summary": "Detailed information about a Order Customer resource.", + "summary": "Detailed information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomer", + "operationId": "getOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -24997,7 +24997,7 @@ ], "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25009,7 +25009,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25018,7 +25018,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25033,16 +25033,16 @@ }, "delete": { "tags": [ - "Order Customer" + "Order Delivery" ], - "summary": "Delete a Order Customer resource.", + "summary": "Delete a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderCustomer", + "operationId": "deleteOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -25073,16 +25073,16 @@ }, "patch": { "tags": [ - "Order Customer" + "Order Delivery" ], - "summary": "Partially update information about a Order Customer resource.", + "summary": "Partially update information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderCustomer", + "operationId": "updateOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -25100,14 +25100,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Customer resource.", + "description": "Partially update information about a Order Delivery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" }, "included": { "type": "array", @@ -25121,14 +25121,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25140,7 +25140,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25149,7 +25149,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25166,14 +25166,14 @@ } } }, - "/order-delivery": { + "/order-delivery-position": { "get": { "tags": [ - "Order Delivery" + "Order Delivery Position" ], - "summary": "List with basic information of Order Delivery resources.", + "summary": "List with basic information of Order Delivery Position resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryList", + "operationId": "getOrderDeliveryPositionList", "parameters": [ { "name": "limit", @@ -25202,7 +25202,7 @@ ], "responses": { "200": { - "description": "List of Order Delivery resources.", + "description": "List of Order Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25221,7 +25221,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } ] @@ -25235,16 +25235,16 @@ "type": "object", "properties": { "first": { - "example": "/order-delivery?limit=25" + "example": "/order-delivery-position?limit=25" }, "last": { - "example": "/order-delivery?limit=25&page=11" + "example": "/order-delivery-position?limit=25&page=11" }, "next": { - "example": "/order-delivery?limit=25&page=4" + "example": "/order-delivery-position?limit=25&page=4" }, "prev": { - "example": "/order-delivery?limit=25&page=2" + "example": "/order-delivery-position?limit=25&page=2" } } } @@ -25265,7 +25265,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25280,11 +25280,11 @@ }, "post": { "tags": [ - "Order Delivery" + "Order Delivery Position" ], - "summary": "Create a new Order Delivery resources.", + "summary": "Create a new Order Delivery Position resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderDelivery", + "operationId": "createOrderDeliveryPosition", "parameters": [ { "name": "_response", @@ -25306,7 +25306,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" }, "included": { "type": "array", @@ -25320,14 +25320,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25339,7 +25339,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25348,7 +25348,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25362,19 +25362,19 @@ } } }, - "/order-delivery/{id}": { + "/order-delivery-position/{id}": { "get": { "tags": [ - "Order Delivery" + "Order Delivery Position" ], - "summary": "Detailed information about a Order Delivery resource.", + "summary": "Detailed information about a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDelivery", + "operationId": "getOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -25384,7 +25384,7 @@ ], "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25396,7 +25396,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25405,7 +25405,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25420,16 +25420,16 @@ }, "delete": { "tags": [ - "Order Delivery" + "Order Delivery Position" ], - "summary": "Delete a Order Delivery resource.", + "summary": "Delete a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDelivery", + "operationId": "deleteOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -25460,16 +25460,16 @@ }, "patch": { "tags": [ - "Order Delivery" + "Order Delivery Position" ], - "summary": "Partially update information about a Order Delivery resource.", + "summary": "Partially update information about a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDelivery", + "operationId": "updateOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -25487,14 +25487,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Delivery resource.", + "description": "Partially update information about a Order Delivery Position resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" }, "included": { "type": "array", @@ -25508,14 +25508,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25527,7 +25527,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25536,7 +25536,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25553,14 +25553,14 @@ } } }, - "/order-delivery-position": { + "/order-line-item": { "get": { "tags": [ - "Order Delivery Position" + "Order Line Item" ], - "summary": "List with basic information of Order Delivery Position resources.", + "summary": "List with basic information of Order Line Item resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPositionList", + "operationId": "getOrderLineItemList", "parameters": [ { "name": "limit", @@ -25589,7 +25589,7 @@ ], "responses": { "200": { - "description": "List of Order Delivery Position resources.", + "description": "List of Order Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25608,7 +25608,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } ] @@ -25622,16 +25622,16 @@ "type": "object", "properties": { "first": { - "example": "/order-delivery-position?limit=25" + "example": "/order-line-item?limit=25" }, "last": { - "example": "/order-delivery-position?limit=25&page=11" + "example": "/order-line-item?limit=25&page=11" }, "next": { - "example": "/order-delivery-position?limit=25&page=4" + "example": "/order-line-item?limit=25&page=4" }, "prev": { - "example": "/order-delivery-position?limit=25&page=2" + "example": "/order-line-item?limit=25&page=2" } } } @@ -25652,7 +25652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25667,11 +25667,11 @@ }, "post": { "tags": [ - "Order Delivery Position" + "Order Line Item" ], - "summary": "Create a new Order Delivery Position resources.", + "summary": "Create a new Order Line Item resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderDeliveryPosition", + "operationId": "createOrderLineItem", "parameters": [ { "name": "_response", @@ -25693,7 +25693,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" }, "included": { "type": "array", @@ -25707,14 +25707,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -25726,7 +25726,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25735,7 +25735,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25749,19 +25749,19 @@ } } }, - "/order-delivery-position/{id}": { + "/order-line-item/{id}": { "get": { "tags": [ - "Order Delivery Position" + "Order Line Item" ], - "summary": "Detailed information about a Order Delivery Position resource.", + "summary": "Detailed information about a Order Line Item resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPosition", + "operationId": "getOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -25771,7 +25771,7 @@ ], "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -25783,7 +25783,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25792,7 +25792,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25807,16 +25807,16 @@ }, "delete": { "tags": [ - "Order Delivery Position" + "Order Line Item" ], - "summary": "Delete a Order Delivery Position resource.", + "summary": "Delete a Order Line Item resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDeliveryPosition", + "operationId": "deleteOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -25847,16 +25847,16 @@ }, "patch": { "tags": [ - "Order Delivery Position" + "Order Line Item" ], - "summary": "Partially update information about a Order Delivery Position resource.", + "summary": "Partially update information about a Order Line Item resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDeliveryPosition", + "operationId": "updateOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -25874,14 +25874,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Delivery Position resource.", + "description": "Partially update information about a Order Line Item resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" }, "included": { "type": "array", @@ -25895,14 +25895,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -25914,7 +25914,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25923,7 +25923,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -25940,14 +25940,14 @@ } } }, - "/order-line-item": { + "/order-line-item-download": { "get": { "tags": [ - "Order Line Item" + "Order Line Item Download" ], - "summary": "List with basic information of Order Line Item resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItemList", + "summary": "List with basic information of Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownloadList", "parameters": [ { "name": "limit", @@ -25976,7 +25976,7 @@ ], "responses": { "200": { - "description": "List of Order Line Item resources.", + "description": "List of Order Line Item Download resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25995,7 +25995,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } ] @@ -26009,16 +26009,16 @@ "type": "object", "properties": { "first": { - "example": "/order-line-item?limit=25" + "example": "/order-line-item-download?limit=25" }, "last": { - "example": "/order-line-item?limit=25&page=11" + "example": "/order-line-item-download?limit=25&page=11" }, "next": { - "example": "/order-line-item?limit=25&page=4" + "example": "/order-line-item-download?limit=25&page=4" }, "prev": { - "example": "/order-line-item?limit=25&page=2" + "example": "/order-line-item-download?limit=25&page=2" } } } @@ -26039,7 +26039,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26054,11 +26054,11 @@ }, "post": { "tags": [ - "Order Line Item" + "Order Line Item Download" ], - "summary": "Create a new Order Line Item resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderLineItem", + "summary": "Create a new Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createOrderLineItemDownload", "parameters": [ { "name": "_response", @@ -26080,7 +26080,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" }, "included": { "type": "array", @@ -26094,14 +26094,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -26113,7 +26113,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26122,7 +26122,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26136,19 +26136,19 @@ } } }, - "/order-line-item/{id}": { + "/order-line-item-download/{id}": { "get": { "tags": [ - "Order Line Item" + "Order Line Item Download" ], - "summary": "Detailed information about a Order Line Item resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItem", + "summary": "Detailed information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -26158,7 +26158,7 @@ ], "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -26170,7 +26170,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26179,7 +26179,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26194,16 +26194,16 @@ }, "delete": { "tags": [ - "Order Line Item" + "Order Line Item Download" ], - "summary": "Delete a Order Line Item resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderLineItem", + "summary": "Delete a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -26234,16 +26234,16 @@ }, "patch": { "tags": [ - "Order Line Item" + "Order Line Item Download" ], - "summary": "Partially update information about a Order Line Item resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderLineItem", + "summary": "Partially update information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -26261,14 +26261,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Line Item resource.", + "description": "Partially update information about a Order Line Item Download resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" }, "included": { "type": "array", @@ -26282,14 +26282,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -26301,7 +26301,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26310,7 +26310,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26327,14 +26327,14 @@ } } }, - "/order-line-item-download": { + "/order-transaction": { "get": { "tags": [ - "Order Line Item Download" + "Order Transaction" ], - "summary": "List with basic information of Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownloadList", + "summary": "List with basic information of Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransactionList", "parameters": [ { "name": "limit", @@ -26363,7 +26363,7 @@ ], "responses": { "200": { - "description": "List of Order Line Item Download resources.", + "description": "List of Order Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26382,7 +26382,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } ] @@ -26396,16 +26396,16 @@ "type": "object", "properties": { "first": { - "example": "/order-line-item-download?limit=25" + "example": "/order-transaction?limit=25" }, "last": { - "example": "/order-line-item-download?limit=25&page=11" + "example": "/order-transaction?limit=25&page=11" }, "next": { - "example": "/order-line-item-download?limit=25&page=4" + "example": "/order-transaction?limit=25&page=4" }, "prev": { - "example": "/order-line-item-download?limit=25&page=2" + "example": "/order-transaction?limit=25&page=2" } } } @@ -26426,7 +26426,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26441,11 +26441,11 @@ }, "post": { "tags": [ - "Order Line Item Download" + "Order Transaction" ], - "summary": "Create a new Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createOrderLineItemDownload", + "summary": "Create a new Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderTransaction", "parameters": [ { "name": "_response", @@ -26467,7 +26467,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" }, "included": { "type": "array", @@ -26481,14 +26481,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26500,7 +26500,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26509,7 +26509,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26523,19 +26523,19 @@ } } }, - "/order-line-item-download/{id}": { + "/order-transaction/{id}": { "get": { "tags": [ - "Order Line Item Download" + "Order Transaction" ], - "summary": "Detailed information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownload", + "summary": "Detailed information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -26545,7 +26545,7 @@ ], "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26557,7 +26557,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26566,7 +26566,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26581,16 +26581,16 @@ }, "delete": { "tags": [ - "Order Line Item Download" + "Order Transaction" ], - "summary": "Delete a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteOrderLineItemDownload", + "summary": "Delete a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -26621,16 +26621,16 @@ }, "patch": { "tags": [ - "Order Line Item Download" + "Order Transaction" ], - "summary": "Partially update information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateOrderLineItemDownload", + "summary": "Partially update information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -26648,14 +26648,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Line Item Download resource.", + "description": "Partially update information about a Order Transaction resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" }, "included": { "type": "array", @@ -26669,14 +26669,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26688,7 +26688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26697,7 +26697,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26714,14 +26714,14 @@ } } }, - "/order-transaction": { + "/order-transaction-capture": { "get": { "tags": [ - "Order Transaction" + "Order Transaction Capture" ], - "summary": "List with basic information of Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransactionList", + "summary": "List with basic information of Order Transaction Capture resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureList", "parameters": [ { "name": "limit", @@ -26750,7 +26750,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction resources.", + "description": "List of Order Transaction Capture resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26769,7 +26769,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } ] @@ -26783,16 +26783,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction?limit=25" + "example": "/order-transaction-capture?limit=25" }, "last": { - "example": "/order-transaction?limit=25&page=11" + "example": "/order-transaction-capture?limit=25&page=11" }, "next": { - "example": "/order-transaction?limit=25&page=4" + "example": "/order-transaction-capture?limit=25&page=4" }, "prev": { - "example": "/order-transaction?limit=25&page=2" + "example": "/order-transaction-capture?limit=25&page=2" } } } @@ -26813,7 +26813,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -26828,11 +26828,11 @@ }, "post": { "tags": [ - "Order Transaction" + "Order Transaction Capture" ], - "summary": "Create a new Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderTransaction", + "summary": "Create a new Order Transaction Capture resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCapture", "parameters": [ { "name": "_response", @@ -26854,7 +26854,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" }, "included": { "type": "array", @@ -26868,14 +26868,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -26887,7 +26887,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -26896,7 +26896,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -26910,19 +26910,19 @@ } } }, - "/order-transaction/{id}": { + "/order-transaction-capture/{id}": { "get": { "tags": [ - "Order Transaction" + "Order Transaction Capture" ], - "summary": "Detailed information about a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransaction", + "summary": "Detailed information about a Order Transaction Capture resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -26932,7 +26932,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -26944,7 +26944,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -26953,7 +26953,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -26968,16 +26968,16 @@ }, "delete": { "tags": [ - "Order Transaction" + "Order Transaction Capture" ], - "summary": "Delete a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderTransaction", + "summary": "Delete a Order Transaction Capture resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -27008,16 +27008,16 @@ }, "patch": { "tags": [ - "Order Transaction" + "Order Transaction Capture" ], - "summary": "Partially update information about a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderTransaction", + "summary": "Partially update information about a Order Transaction Capture resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -27035,14 +27035,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction resource.", + "description": "Partially update information about a Order Transaction Capture resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" }, "included": { "type": "array", @@ -27056,14 +27056,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -27075,7 +27075,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -27084,7 +27084,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -27101,14 +27101,14 @@ } } }, - "/order-transaction-capture": { + "/order-transaction-capture-refund": { "get": { "tags": [ - "Order Transaction Capture" + "Order Transaction Capture Refund" ], - "summary": "List with basic information of Order Transaction Capture resources.", + "summary": "List with basic information of Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureList", + "operationId": "getOrderTransactionCaptureRefundList", "parameters": [ { "name": "limit", @@ -27137,7 +27137,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture resources.", + "description": "List of Order Transaction Capture Refund resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27156,7 +27156,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } ] @@ -27170,16 +27170,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture?limit=25" + "example": "/order-transaction-capture-refund?limit=25" }, "last": { - "example": "/order-transaction-capture?limit=25&page=11" + "example": "/order-transaction-capture-refund?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture?limit=25&page=4" + "example": "/order-transaction-capture-refund?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture?limit=25&page=2" + "example": "/order-transaction-capture-refund?limit=25&page=2" } } } @@ -27200,7 +27200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27215,11 +27215,11 @@ }, "post": { "tags": [ - "Order Transaction Capture" + "Order Transaction Capture Refund" ], - "summary": "Create a new Order Transaction Capture resources.", + "summary": "Create a new Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCapture", + "operationId": "createOrderTransactionCaptureRefund", "parameters": [ { "name": "_response", @@ -27241,7 +27241,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" }, "included": { "type": "array", @@ -27255,14 +27255,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -27274,7 +27274,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27283,7 +27283,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27297,19 +27297,19 @@ } } }, - "/order-transaction-capture/{id}": { + "/order-transaction-capture-refund/{id}": { "get": { "tags": [ - "Order Transaction Capture" + "Order Transaction Capture Refund" ], - "summary": "Detailed information about a Order Transaction Capture resource.", + "summary": "Detailed information about a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCapture", + "operationId": "getOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -27319,7 +27319,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -27331,7 +27331,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27340,7 +27340,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27355,16 +27355,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture" + "Order Transaction Capture Refund" ], - "summary": "Delete a Order Transaction Capture resource.", + "summary": "Delete a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCapture", + "operationId": "deleteOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -27395,16 +27395,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture" + "Order Transaction Capture Refund" ], - "summary": "Partially update information about a Order Transaction Capture resource.", + "summary": "Partially update information about a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCapture", + "operationId": "updateOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -27422,14 +27422,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture resource.", + "description": "Partially update information about a Order Transaction Capture Refund resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" }, "included": { "type": "array", @@ -27443,14 +27443,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -27462,7 +27462,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27471,7 +27471,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27488,14 +27488,14 @@ } } }, - "/order-transaction-capture-refund": { + "/order-transaction-capture-refund-position": { "get": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture Refund Position" ], - "summary": "List with basic information of Order Transaction Capture Refund resources.", + "summary": "List with basic information of Order Transaction Capture Refund Position resources.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundList", + "operationId": "getOrderTransactionCaptureRefundPositionList", "parameters": [ { "name": "limit", @@ -27524,7 +27524,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture Refund resources.", + "description": "List of Order Transaction Capture Refund Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27543,7 +27543,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } ] @@ -27557,16 +27557,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture-refund?limit=25" + "example": "/order-transaction-capture-refund-position?limit=25" }, "last": { - "example": "/order-transaction-capture-refund?limit=25&page=11" + "example": "/order-transaction-capture-refund-position?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture-refund?limit=25&page=4" + "example": "/order-transaction-capture-refund-position?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture-refund?limit=25&page=2" + "example": "/order-transaction-capture-refund-position?limit=25&page=2" } } } @@ -27587,7 +27587,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27602,11 +27602,11 @@ }, "post": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture Refund Position" ], - "summary": "Create a new Order Transaction Capture Refund resources.", + "summary": "Create a new Order Transaction Capture Refund Position resources.", "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefund", + "operationId": "createOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "_response", @@ -27628,7 +27628,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" }, "included": { "type": "array", @@ -27642,14 +27642,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -27661,7 +27661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27670,7 +27670,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27684,19 +27684,19 @@ } } }, - "/order-transaction-capture-refund/{id}": { + "/order-transaction-capture-refund-position/{id}": { "get": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture Refund Position" ], - "summary": "Detailed information about a Order Transaction Capture Refund resource.", + "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefund", + "operationId": "getOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -27706,7 +27706,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -27718,7 +27718,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27727,7 +27727,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27742,16 +27742,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture Refund Position" ], - "summary": "Delete a Order Transaction Capture Refund resource.", + "summary": "Delete a Order Transaction Capture Refund Position resource.", "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefund", + "operationId": "deleteOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -27782,16 +27782,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture Refund Position" ], - "summary": "Partially update information about a Order Transaction Capture Refund resource.", + "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefund", + "operationId": "updateOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -27809,14 +27809,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture Refund resource.", + "description": "Partially update information about a Order Transaction Capture Refund Position resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" }, "included": { "type": "array", @@ -27830,14 +27830,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -27849,7 +27849,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27858,7 +27858,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27875,14 +27875,14 @@ } } }, - "/order-transaction-capture-refund-position": { + "/payment-method": { "get": { "tags": [ - "Order Transaction Capture Refund Position" + "Payment Method" ], - "summary": "List with basic information of Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPositionList", + "summary": "List with basic information of Payment Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPaymentMethodList", "parameters": [ { "name": "limit", @@ -27911,7 +27911,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture Refund Position resources.", + "description": "List of Payment Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27930,7 +27930,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } ] @@ -27944,16 +27944,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture-refund-position?limit=25" + "example": "/payment-method?limit=25" }, "last": { - "example": "/order-transaction-capture-refund-position?limit=25&page=11" + "example": "/payment-method?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture-refund-position?limit=25&page=4" + "example": "/payment-method?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture-refund-position?limit=25&page=2" + "example": "/payment-method?limit=25&page=2" } } } @@ -27974,7 +27974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -27989,11 +27989,11 @@ }, "post": { "tags": [ - "Order Transaction Capture Refund Position" + "Payment Method" ], - "summary": "Create a new Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefundPosition", + "summary": "Create a new Payment Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPaymentMethod", "parameters": [ { "name": "_response", @@ -28015,7 +28015,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" }, "included": { "type": "array", @@ -28029,14 +28029,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -28048,7 +28048,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28057,7 +28057,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28071,19 +28071,19 @@ } } }, - "/order-transaction-capture-refund-position/{id}": { + "/payment-method/{id}": { "get": { "tags": [ - "Order Transaction Capture Refund Position" + "Payment Method" ], - "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPosition", + "summary": "Detailed information about a Payment Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -28093,7 +28093,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -28105,7 +28105,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28114,7 +28114,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28129,16 +28129,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture Refund Position" + "Payment Method" ], - "summary": "Delete a Order Transaction Capture Refund Position resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefundPosition", + "summary": "Delete a Payment Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -28169,16 +28169,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture Refund Position" + "Payment Method" ], - "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefundPosition", + "summary": "Partially update information about a Payment Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -28196,14 +28196,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture Refund Position resource.", + "description": "Partially update information about a Payment Method resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" }, "included": { "type": "array", @@ -28217,14 +28217,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -28236,7 +28236,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28245,7 +28245,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28262,14 +28262,14 @@ } } }, - "/payment-method": { + "/plugin": { "get": { "tags": [ - "Payment Method" + "Plugin" ], - "summary": "List with basic information of Payment Method resources.", + "summary": "List with basic information of Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethodList", + "operationId": "getPluginList", "parameters": [ { "name": "limit", @@ -28298,7 +28298,7 @@ ], "responses": { "200": { - "description": "List of Payment Method resources.", + "description": "List of Plugin resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28317,7 +28317,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } ] @@ -28331,16 +28331,16 @@ "type": "object", "properties": { "first": { - "example": "/payment-method?limit=25" + "example": "/plugin?limit=25" }, "last": { - "example": "/payment-method?limit=25&page=11" + "example": "/plugin?limit=25&page=11" }, "next": { - "example": "/payment-method?limit=25&page=4" + "example": "/plugin?limit=25&page=4" }, "prev": { - "example": "/payment-method?limit=25&page=2" + "example": "/plugin?limit=25&page=2" } } } @@ -28361,7 +28361,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28376,11 +28376,11 @@ }, "post": { "tags": [ - "Payment Method" + "Plugin" ], - "summary": "Create a new Payment Method resources.", + "summary": "Create a new Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPaymentMethod", + "operationId": "createPlugin", "parameters": [ { "name": "_response", @@ -28402,7 +28402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" }, "included": { "type": "array", @@ -28416,14 +28416,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -28435,7 +28435,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28444,7 +28444,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28458,19 +28458,19 @@ } } }, - "/payment-method/{id}": { + "/plugin/{id}": { "get": { "tags": [ - "Payment Method" + "Plugin" ], - "summary": "Detailed information about a Payment Method resource.", + "summary": "Detailed information about a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethod", + "operationId": "getPlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -28480,7 +28480,7 @@ ], "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -28492,7 +28492,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28501,7 +28501,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28516,16 +28516,16 @@ }, "delete": { "tags": [ - "Payment Method" + "Plugin" ], - "summary": "Delete a Payment Method resource.", + "summary": "Delete a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePaymentMethod", + "operationId": "deletePlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -28556,16 +28556,16 @@ }, "patch": { "tags": [ - "Payment Method" + "Plugin" ], - "summary": "Partially update information about a Payment Method resource.", + "summary": "Partially update information about a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePaymentMethod", + "operationId": "updatePlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -28583,14 +28583,14 @@ } ], "requestBody": { - "description": "Partially update information about a Payment Method resource.", + "description": "Partially update information about a Plugin resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" }, "included": { "type": "array", @@ -28604,14 +28604,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -28623,7 +28623,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28632,7 +28632,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/Plugin" } } } @@ -28649,14 +28649,14 @@ } } }, - "/plugin": { + "/product": { "get": { "tags": [ - "Plugin" + "Product" ], - "summary": "List with basic information of Plugin resources.", + "summary": "List with basic information of Product resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPluginList", + "operationId": "getProductList", "parameters": [ { "name": "limit", @@ -28685,7 +28685,7 @@ ], "responses": { "200": { - "description": "List of Plugin resources.", + "description": "List of Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28704,7 +28704,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } ] @@ -28718,16 +28718,16 @@ "type": "object", "properties": { "first": { - "example": "/plugin?limit=25" + "example": "/product?limit=25" }, "last": { - "example": "/plugin?limit=25&page=11" + "example": "/product?limit=25&page=11" }, "next": { - "example": "/plugin?limit=25&page=4" + "example": "/product?limit=25&page=4" }, "prev": { - "example": "/plugin?limit=25&page=2" + "example": "/product?limit=25&page=2" } } } @@ -28748,7 +28748,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -28763,11 +28763,11 @@ }, "post": { "tags": [ - "Plugin" + "Product" ], - "summary": "Create a new Plugin resources.", + "summary": "Create a new Product resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPlugin", + "operationId": "createProduct", "parameters": [ { "name": "_response", @@ -28789,7 +28789,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" }, "included": { "type": "array", @@ -28803,14 +28803,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -28822,7 +28822,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -28831,7 +28831,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -28845,19 +28845,19 @@ } } }, - "/plugin/{id}": { + "/product/{id}": { "get": { "tags": [ - "Plugin" + "Product" ], - "summary": "Detailed information about a Plugin resource.", + "summary": "Detailed information about a Product resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPlugin", + "operationId": "getProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -28867,7 +28867,7 @@ ], "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -28879,7 +28879,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -28888,7 +28888,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -28903,16 +28903,16 @@ }, "delete": { "tags": [ - "Plugin" + "Product" ], - "summary": "Delete a Plugin resource.", + "summary": "Delete a Product resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePlugin", + "operationId": "deleteProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -28943,16 +28943,16 @@ }, "patch": { "tags": [ - "Plugin" + "Product" ], - "summary": "Partially update information about a Plugin resource.", + "summary": "Partially update information about a Product resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePlugin", + "operationId": "updateProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -28970,14 +28970,14 @@ } ], "requestBody": { - "description": "Partially update information about a Plugin resource.", + "description": "Partially update information about a Product resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" }, "included": { "type": "array", @@ -28991,14 +28991,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -29010,7 +29010,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -29019,7 +29019,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/Product" } } } @@ -29036,14 +29036,14 @@ } } }, - "/product": { + "/product-configurator-setting": { "get": { "tags": [ - "Product" + "Product Configurator Setting" ], - "summary": "List with basic information of Product resources.", + "summary": "List with basic information of Product Configurator Setting resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductList", + "operationId": "getProductConfiguratorSettingList", "parameters": [ { "name": "limit", @@ -29072,7 +29072,7 @@ ], "responses": { "200": { - "description": "List of Product resources.", + "description": "List of Product Configurator Setting resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29091,7 +29091,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } ] @@ -29105,16 +29105,16 @@ "type": "object", "properties": { "first": { - "example": "/product?limit=25" + "example": "/product-configurator-setting?limit=25" }, "last": { - "example": "/product?limit=25&page=11" + "example": "/product-configurator-setting?limit=25&page=11" }, "next": { - "example": "/product?limit=25&page=4" + "example": "/product-configurator-setting?limit=25&page=4" }, "prev": { - "example": "/product?limit=25&page=2" + "example": "/product-configurator-setting?limit=25&page=2" } } } @@ -29135,7 +29135,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29150,11 +29150,11 @@ }, "post": { "tags": [ - "Product" + "Product Configurator Setting" ], - "summary": "Create a new Product resources.", + "summary": "Create a new Product Configurator Setting resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProduct", + "operationId": "createProductConfiguratorSetting", "parameters": [ { "name": "_response", @@ -29176,7 +29176,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" }, "included": { "type": "array", @@ -29190,14 +29190,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -29209,7 +29209,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29218,7 +29218,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29232,19 +29232,19 @@ } } }, - "/product/{id}": { + "/product-configurator-setting/{id}": { "get": { "tags": [ - "Product" + "Product Configurator Setting" ], - "summary": "Detailed information about a Product resource.", + "summary": "Detailed information about a Product Configurator Setting resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProduct", + "operationId": "getProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -29254,7 +29254,7 @@ ], "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -29266,7 +29266,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29275,7 +29275,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29290,16 +29290,16 @@ }, "delete": { "tags": [ - "Product" + "Product Configurator Setting" ], - "summary": "Delete a Product resource.", + "summary": "Delete a Product Configurator Setting resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProduct", + "operationId": "deleteProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -29330,16 +29330,16 @@ }, "patch": { "tags": [ - "Product" + "Product Configurator Setting" ], - "summary": "Partially update information about a Product resource.", + "summary": "Partially update information about a Product Configurator Setting resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProduct", + "operationId": "updateProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -29357,14 +29357,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product resource.", + "description": "Partially update information about a Product Configurator Setting resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" }, "included": { "type": "array", @@ -29378,14 +29378,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -29397,7 +29397,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29406,7 +29406,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29423,14 +29423,14 @@ } } }, - "/product-configurator-setting": { + "/product-cross-selling": { "get": { "tags": [ - "Product Configurator Setting" + "Product Cross Selling" ], - "summary": "List with basic information of Product Configurator Setting resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSettingList", + "summary": "List with basic information of Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSellingList", "parameters": [ { "name": "limit", @@ -29459,7 +29459,7 @@ ], "responses": { "200": { - "description": "List of Product Configurator Setting resources.", + "description": "List of Product Cross Selling resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29478,7 +29478,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } ] @@ -29492,16 +29492,16 @@ "type": "object", "properties": { "first": { - "example": "/product-configurator-setting?limit=25" + "example": "/product-cross-selling?limit=25" }, "last": { - "example": "/product-configurator-setting?limit=25&page=11" + "example": "/product-cross-selling?limit=25&page=11" }, "next": { - "example": "/product-configurator-setting?limit=25&page=4" + "example": "/product-cross-selling?limit=25&page=4" }, "prev": { - "example": "/product-configurator-setting?limit=25&page=2" + "example": "/product-cross-selling?limit=25&page=2" } } } @@ -29522,7 +29522,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29537,11 +29537,11 @@ }, "post": { "tags": [ - "Product Configurator Setting" + "Product Cross Selling" ], - "summary": "Create a new Product Configurator Setting resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductConfiguratorSetting", + "summary": "Create a new Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductCrossSelling", "parameters": [ { "name": "_response", @@ -29563,7 +29563,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" }, "included": { "type": "array", @@ -29577,14 +29577,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -29596,7 +29596,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29605,7 +29605,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29619,19 +29619,19 @@ } } }, - "/product-configurator-setting/{id}": { + "/product-cross-selling/{id}": { "get": { "tags": [ - "Product Configurator Setting" + "Product Cross Selling" ], - "summary": "Detailed information about a Product Configurator Setting resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSetting", + "summary": "Detailed information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -29641,7 +29641,7 @@ ], "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -29653,7 +29653,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29662,7 +29662,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29677,16 +29677,16 @@ }, "delete": { "tags": [ - "Product Configurator Setting" + "Product Cross Selling" ], - "summary": "Delete a Product Configurator Setting resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductConfiguratorSetting", + "summary": "Delete a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -29717,16 +29717,16 @@ }, "patch": { "tags": [ - "Product Configurator Setting" + "Product Cross Selling" ], - "summary": "Partially update information about a Product Configurator Setting resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductConfiguratorSetting", + "summary": "Partially update information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -29744,14 +29744,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Configurator Setting resource.", + "description": "Partially update information about a Product Cross Selling resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" }, "included": { "type": "array", @@ -29765,14 +29765,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -29784,7 +29784,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29793,7 +29793,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29810,14 +29810,14 @@ } } }, - "/product-cross-selling": { + "/product-cross-selling-assigned-products": { "get": { "tags": [ - "Product Cross Selling" + "Product Cross Selling Assigned Products" ], - "summary": "List with basic information of Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSellingList", + "summary": "List with basic information of Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProductsList", "parameters": [ { "name": "limit", @@ -29846,7 +29846,7 @@ ], "responses": { "200": { - "description": "List of Product Cross Selling resources.", + "description": "List of Product Cross Selling Assigned Products resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29865,7 +29865,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } ] @@ -29879,16 +29879,16 @@ "type": "object", "properties": { "first": { - "example": "/product-cross-selling?limit=25" + "example": "/product-cross-selling-assigned-products?limit=25" }, "last": { - "example": "/product-cross-selling?limit=25&page=11" + "example": "/product-cross-selling-assigned-products?limit=25&page=11" }, "next": { - "example": "/product-cross-selling?limit=25&page=4" + "example": "/product-cross-selling-assigned-products?limit=25&page=4" }, "prev": { - "example": "/product-cross-selling?limit=25&page=2" + "example": "/product-cross-selling-assigned-products?limit=25&page=2" } } } @@ -29909,7 +29909,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -29924,11 +29924,11 @@ }, "post": { "tags": [ - "Product Cross Selling" + "Product Cross Selling Assigned Products" ], - "summary": "Create a new Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductCrossSelling", + "summary": "Create a new Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createProductCrossSellingAssignedProducts", "parameters": [ { "name": "_response", @@ -29950,7 +29950,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" }, "included": { "type": "array", @@ -29964,14 +29964,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -29983,7 +29983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -29992,7 +29992,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30006,19 +30006,19 @@ } } }, - "/product-cross-selling/{id}": { + "/product-cross-selling-assigned-products/{id}": { "get": { "tags": [ - "Product Cross Selling" + "Product Cross Selling Assigned Products" ], - "summary": "Detailed information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSelling", + "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -30028,7 +30028,7 @@ ], "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -30040,7 +30040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30049,7 +30049,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30064,16 +30064,16 @@ }, "delete": { "tags": [ - "Product Cross Selling" + "Product Cross Selling Assigned Products" ], - "summary": "Delete a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductCrossSelling", + "summary": "Delete a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -30104,16 +30104,16 @@ }, "patch": { "tags": [ - "Product Cross Selling" + "Product Cross Selling Assigned Products" ], - "summary": "Partially update information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductCrossSelling", + "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -30131,14 +30131,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Cross Selling resource.", + "description": "Partially update information about a Product Cross Selling Assigned Products resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" }, "included": { "type": "array", @@ -30152,14 +30152,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -30171,7 +30171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30180,7 +30180,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30197,14 +30197,14 @@ } } }, - "/product-cross-selling-assigned-products": { + "/product-download": { "get": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Download" ], - "summary": "List with basic information of Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProductsList", + "summary": "List with basic information of Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownloadList", "parameters": [ { "name": "limit", @@ -30233,7 +30233,7 @@ ], "responses": { "200": { - "description": "List of Product Cross Selling Assigned Products resources.", + "description": "List of Product Download resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30252,7 +30252,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } ] @@ -30266,16 +30266,16 @@ "type": "object", "properties": { "first": { - "example": "/product-cross-selling-assigned-products?limit=25" + "example": "/product-download?limit=25" }, "last": { - "example": "/product-cross-selling-assigned-products?limit=25&page=11" + "example": "/product-download?limit=25&page=11" }, "next": { - "example": "/product-cross-selling-assigned-products?limit=25&page=4" + "example": "/product-download?limit=25&page=4" }, "prev": { - "example": "/product-cross-selling-assigned-products?limit=25&page=2" + "example": "/product-download?limit=25&page=2" } } } @@ -30296,7 +30296,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30311,11 +30311,11 @@ }, "post": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Download" ], - "summary": "Create a new Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createProductCrossSellingAssignedProducts", + "summary": "Create a new Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createProductDownload", "parameters": [ { "name": "_response", @@ -30337,7 +30337,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" }, "included": { "type": "array", @@ -30351,14 +30351,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -30370,7 +30370,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30379,7 +30379,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30393,19 +30393,19 @@ } } }, - "/product-cross-selling-assigned-products/{id}": { + "/product-download/{id}": { "get": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Download" ], - "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProducts", + "summary": "Detailed information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -30415,7 +30415,7 @@ ], "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -30427,7 +30427,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30436,7 +30436,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30451,16 +30451,16 @@ }, "delete": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Download" ], - "summary": "Delete a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteProductCrossSellingAssignedProducts", + "summary": "Delete a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -30491,16 +30491,16 @@ }, "patch": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Download" ], - "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateProductCrossSellingAssignedProducts", + "summary": "Partially update information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -30518,14 +30518,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Partially update information about a Product Download resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" }, "included": { "type": "array", @@ -30539,14 +30539,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -30558,7 +30558,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30567,7 +30567,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30584,14 +30584,14 @@ } } }, - "/product-download": { + "/product-export": { "get": { "tags": [ - "Product Download" + "Product Export" ], - "summary": "List with basic information of Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownloadList", + "summary": "List with basic information of Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExportList", "parameters": [ { "name": "limit", @@ -30620,7 +30620,7 @@ ], "responses": { "200": { - "description": "List of Product Download resources.", + "description": "List of Product Export resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30639,7 +30639,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } ] @@ -30653,16 +30653,16 @@ "type": "object", "properties": { "first": { - "example": "/product-download?limit=25" + "example": "/product-export?limit=25" }, "last": { - "example": "/product-download?limit=25&page=11" + "example": "/product-export?limit=25&page=11" }, "next": { - "example": "/product-download?limit=25&page=4" + "example": "/product-export?limit=25&page=4" }, "prev": { - "example": "/product-download?limit=25&page=2" + "example": "/product-export?limit=25&page=2" } } } @@ -30683,7 +30683,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30698,11 +30698,11 @@ }, "post": { "tags": [ - "Product Download" + "Product Export" ], - "summary": "Create a new Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createProductDownload", + "summary": "Create a new Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductExport", "parameters": [ { "name": "_response", @@ -30724,7 +30724,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" }, "included": { "type": "array", @@ -30738,14 +30738,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -30757,7 +30757,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30766,7 +30766,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30780,19 +30780,19 @@ } } }, - "/product-download/{id}": { + "/product-export/{id}": { "get": { "tags": [ - "Product Download" + "Product Export" ], - "summary": "Detailed information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownload", + "summary": "Detailed information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -30802,7 +30802,7 @@ ], "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -30814,7 +30814,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30823,7 +30823,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30838,16 +30838,16 @@ }, "delete": { "tags": [ - "Product Download" + "Product Export" ], - "summary": "Delete a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteProductDownload", + "summary": "Delete a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -30878,16 +30878,16 @@ }, "patch": { "tags": [ - "Product Download" + "Product Export" ], - "summary": "Partially update information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateProductDownload", + "summary": "Partially update information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -30905,14 +30905,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Download resource.", + "description": "Partially update information about a Product Export resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" }, "included": { "type": "array", @@ -30926,14 +30926,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -30945,7 +30945,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30954,7 +30954,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductExport" } } } @@ -30971,14 +30971,14 @@ } } }, - "/product-export": { + "/product-feature-set": { "get": { "tags": [ - "Product Export" + "Product Feature Set" ], - "summary": "List with basic information of Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExportList", + "summary": "List with basic information of Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSetList", "parameters": [ { "name": "limit", @@ -31007,7 +31007,7 @@ ], "responses": { "200": { - "description": "List of Product Export resources.", + "description": "List of Product Feature Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31026,7 +31026,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } ] @@ -31040,16 +31040,16 @@ "type": "object", "properties": { "first": { - "example": "/product-export?limit=25" + "example": "/product-feature-set?limit=25" }, "last": { - "example": "/product-export?limit=25&page=11" + "example": "/product-feature-set?limit=25&page=11" }, "next": { - "example": "/product-export?limit=25&page=4" + "example": "/product-feature-set?limit=25&page=4" }, "prev": { - "example": "/product-export?limit=25&page=2" + "example": "/product-feature-set?limit=25&page=2" } } } @@ -31070,7 +31070,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31085,11 +31085,11 @@ }, "post": { "tags": [ - "Product Export" + "Product Feature Set" ], - "summary": "Create a new Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductExport", + "summary": "Create a new Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "createProductFeatureSet", "parameters": [ { "name": "_response", @@ -31111,7 +31111,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" }, "included": { "type": "array", @@ -31125,14 +31125,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -31144,7 +31144,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31153,7 +31153,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31167,19 +31167,19 @@ } } }, - "/product-export/{id}": { + "/product-feature-set/{id}": { "get": { "tags": [ - "Product Export" + "Product Feature Set" ], - "summary": "Detailed information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExport", + "summary": "Detailed information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -31189,7 +31189,7 @@ ], "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -31201,7 +31201,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31210,7 +31210,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31225,16 +31225,16 @@ }, "delete": { "tags": [ - "Product Export" + "Product Feature Set" ], - "summary": "Delete a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductExport", + "summary": "Delete a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "deleteProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -31265,16 +31265,16 @@ }, "patch": { "tags": [ - "Product Export" + "Product Feature Set" ], - "summary": "Partially update information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductExport", + "summary": "Partially update information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "updateProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -31292,14 +31292,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Export resource.", + "description": "Partially update information about a Product Feature Set resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" }, "included": { "type": "array", @@ -31313,14 +31313,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -31332,7 +31332,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31341,7 +31341,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31358,14 +31358,14 @@ } } }, - "/product-feature-set": { + "/product-keyword-dictionary": { "get": { "tags": [ - "Product Feature Set" + "Product Keyword Dictionary" ], - "summary": "List with basic information of Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSetList", + "summary": "List with basic information of Product Keyword Dictionary resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductKeywordDictionaryList", "parameters": [ { "name": "limit", @@ -31394,7 +31394,7 @@ ], "responses": { "200": { - "description": "List of Product Feature Set resources.", + "description": "List of Product Keyword Dictionary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31413,7 +31413,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } ] @@ -31427,16 +31427,16 @@ "type": "object", "properties": { "first": { - "example": "/product-feature-set?limit=25" + "example": "/product-keyword-dictionary?limit=25" }, "last": { - "example": "/product-feature-set?limit=25&page=11" + "example": "/product-keyword-dictionary?limit=25&page=11" }, "next": { - "example": "/product-feature-set?limit=25&page=4" + "example": "/product-keyword-dictionary?limit=25&page=4" }, "prev": { - "example": "/product-feature-set?limit=25&page=2" + "example": "/product-keyword-dictionary?limit=25&page=2" } } } @@ -31457,7 +31457,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31472,11 +31472,11 @@ }, "post": { "tags": [ - "Product Feature Set" + "Product Keyword Dictionary" ], - "summary": "Create a new Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "createProductFeatureSet", + "summary": "Create a new Product Keyword Dictionary resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductKeywordDictionary", "parameters": [ { "name": "_response", @@ -31498,7 +31498,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" }, "included": { "type": "array", @@ -31512,14 +31512,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -31531,7 +31531,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31540,7 +31540,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31554,19 +31554,19 @@ } } }, - "/product-feature-set/{id}": { + "/product-keyword-dictionary/{id}": { "get": { "tags": [ - "Product Feature Set" + "Product Keyword Dictionary" ], - "summary": "Detailed information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSet", + "summary": "Detailed information about a Product Keyword Dictionary resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -31576,7 +31576,7 @@ ], "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -31588,7 +31588,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31597,7 +31597,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31612,16 +31612,16 @@ }, "delete": { "tags": [ - "Product Feature Set" + "Product Keyword Dictionary" ], - "summary": "Delete a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "deleteProductFeatureSet", + "summary": "Delete a Product Keyword Dictionary resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -31652,16 +31652,16 @@ }, "patch": { "tags": [ - "Product Feature Set" + "Product Keyword Dictionary" ], - "summary": "Partially update information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "updateProductFeatureSet", + "summary": "Partially update information about a Product Keyword Dictionary resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -31679,14 +31679,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Feature Set resource.", + "description": "Partially update information about a Product Keyword Dictionary resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" }, "included": { "type": "array", @@ -31700,14 +31700,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -31719,7 +31719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31728,7 +31728,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31745,14 +31745,14 @@ } } }, - "/product-keyword-dictionary": { + "/product-manufacturer": { "get": { "tags": [ - "Product Keyword Dictionary" + "Product Manufacturer" ], - "summary": "List with basic information of Product Keyword Dictionary resources.", + "summary": "List with basic information of Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionaryList", + "operationId": "getProductManufacturerList", "parameters": [ { "name": "limit", @@ -31781,7 +31781,7 @@ ], "responses": { "200": { - "description": "List of Product Keyword Dictionary resources.", + "description": "List of Product Manufacturer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31800,7 +31800,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } ] @@ -31814,16 +31814,16 @@ "type": "object", "properties": { "first": { - "example": "/product-keyword-dictionary?limit=25" + "example": "/product-manufacturer?limit=25" }, "last": { - "example": "/product-keyword-dictionary?limit=25&page=11" + "example": "/product-manufacturer?limit=25&page=11" }, "next": { - "example": "/product-keyword-dictionary?limit=25&page=4" + "example": "/product-manufacturer?limit=25&page=4" }, "prev": { - "example": "/product-keyword-dictionary?limit=25&page=2" + "example": "/product-manufacturer?limit=25&page=2" } } } @@ -31844,7 +31844,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -31859,11 +31859,11 @@ }, "post": { "tags": [ - "Product Keyword Dictionary" + "Product Manufacturer" ], - "summary": "Create a new Product Keyword Dictionary resources.", + "summary": "Create a new Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductKeywordDictionary", + "operationId": "createProductManufacturer", "parameters": [ { "name": "_response", @@ -31885,7 +31885,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" }, "included": { "type": "array", @@ -31899,14 +31899,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -31918,7 +31918,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -31927,7 +31927,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -31941,19 +31941,19 @@ } } }, - "/product-keyword-dictionary/{id}": { + "/product-manufacturer/{id}": { "get": { "tags": [ - "Product Keyword Dictionary" + "Product Manufacturer" ], - "summary": "Detailed information about a Product Keyword Dictionary resource.", + "summary": "Detailed information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionary", + "operationId": "getProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -31963,7 +31963,7 @@ ], "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -31975,7 +31975,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -31984,7 +31984,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -31999,16 +31999,16 @@ }, "delete": { "tags": [ - "Product Keyword Dictionary" + "Product Manufacturer" ], - "summary": "Delete a Product Keyword Dictionary resource.", + "summary": "Delete a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductKeywordDictionary", + "operationId": "deleteProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -32039,16 +32039,16 @@ }, "patch": { "tags": [ - "Product Keyword Dictionary" + "Product Manufacturer" ], - "summary": "Partially update information about a Product Keyword Dictionary resource.", + "summary": "Partially update information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductKeywordDictionary", + "operationId": "updateProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -32066,14 +32066,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Keyword Dictionary resource.", + "description": "Partially update information about a Product Manufacturer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" }, "included": { "type": "array", @@ -32087,14 +32087,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -32106,7 +32106,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -32115,7 +32115,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -32132,14 +32132,14 @@ } } }, - "/product-manufacturer": { + "/product-media": { "get": { "tags": [ - "Product Manufacturer" + "Product Media" ], - "summary": "List with basic information of Product Manufacturer resources.", + "summary": "List with basic information of Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturerList", + "operationId": "getProductMediaList", "parameters": [ { "name": "limit", @@ -32168,7 +32168,7 @@ ], "responses": { "200": { - "description": "List of Product Manufacturer resources.", + "description": "List of Product Media resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32187,7 +32187,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } ] @@ -32201,16 +32201,16 @@ "type": "object", "properties": { "first": { - "example": "/product-manufacturer?limit=25" + "example": "/product-media?limit=25" }, "last": { - "example": "/product-manufacturer?limit=25&page=11" + "example": "/product-media?limit=25&page=11" }, "next": { - "example": "/product-manufacturer?limit=25&page=4" + "example": "/product-media?limit=25&page=4" }, "prev": { - "example": "/product-manufacturer?limit=25&page=2" + "example": "/product-media?limit=25&page=2" } } } @@ -32231,7 +32231,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32246,11 +32246,11 @@ }, "post": { "tags": [ - "Product Manufacturer" + "Product Media" ], - "summary": "Create a new Product Manufacturer resources.", + "summary": "Create a new Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductManufacturer", + "operationId": "createProductMedia", "parameters": [ { "name": "_response", @@ -32272,7 +32272,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" }, "included": { "type": "array", @@ -32286,14 +32286,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -32305,7 +32305,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32314,7 +32314,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32328,19 +32328,19 @@ } } }, - "/product-manufacturer/{id}": { + "/product-media/{id}": { "get": { "tags": [ - "Product Manufacturer" + "Product Media" ], - "summary": "Detailed information about a Product Manufacturer resource.", + "summary": "Detailed information about a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturer", + "operationId": "getProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -32350,7 +32350,7 @@ ], "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -32362,7 +32362,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32371,7 +32371,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32386,16 +32386,16 @@ }, "delete": { "tags": [ - "Product Manufacturer" + "Product Media" ], - "summary": "Delete a Product Manufacturer resource.", + "summary": "Delete a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductManufacturer", + "operationId": "deleteProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -32426,16 +32426,16 @@ }, "patch": { "tags": [ - "Product Manufacturer" + "Product Media" ], - "summary": "Partially update information about a Product Manufacturer resource.", + "summary": "Partially update information about a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductManufacturer", + "operationId": "updateProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -32453,14 +32453,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Manufacturer resource.", + "description": "Partially update information about a Product Media resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" }, "included": { "type": "array", @@ -32474,14 +32474,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -32493,7 +32493,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32502,7 +32502,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32519,14 +32519,14 @@ } } }, - "/product-media": { + "/product-price": { "get": { "tags": [ - "Product Media" + "Product Price" ], - "summary": "List with basic information of Product Media resources.", + "summary": "List with basic information of Product Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductMediaList", + "operationId": "getProductPriceList", "parameters": [ { "name": "limit", @@ -32555,7 +32555,7 @@ ], "responses": { "200": { - "description": "List of Product Media resources.", + "description": "List of Product Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32574,7 +32574,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } ] @@ -32588,16 +32588,16 @@ "type": "object", "properties": { "first": { - "example": "/product-media?limit=25" + "example": "/product-price?limit=25" }, "last": { - "example": "/product-media?limit=25&page=11" + "example": "/product-price?limit=25&page=11" }, "next": { - "example": "/product-media?limit=25&page=4" + "example": "/product-price?limit=25&page=4" }, "prev": { - "example": "/product-media?limit=25&page=2" + "example": "/product-price?limit=25&page=2" } } } @@ -32618,7 +32618,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32633,11 +32633,11 @@ }, "post": { "tags": [ - "Product Media" + "Product Price" ], - "summary": "Create a new Product Media resources.", + "summary": "Create a new Product Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductMedia", + "operationId": "createProductPrice", "parameters": [ { "name": "_response", @@ -32659,7 +32659,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" }, "included": { "type": "array", @@ -32673,14 +32673,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -32692,7 +32692,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32701,7 +32701,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32715,19 +32715,19 @@ } } }, - "/product-media/{id}": { + "/product-price/{id}": { "get": { "tags": [ - "Product Media" + "Product Price" ], - "summary": "Detailed information about a Product Media resource.", + "summary": "Detailed information about a Product Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductMedia", + "operationId": "getProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -32737,7 +32737,7 @@ ], "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -32749,7 +32749,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32758,7 +32758,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32773,16 +32773,16 @@ }, "delete": { "tags": [ - "Product Media" + "Product Price" ], - "summary": "Delete a Product Media resource.", + "summary": "Delete a Product Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductMedia", + "operationId": "deleteProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -32813,16 +32813,16 @@ }, "patch": { "tags": [ - "Product Media" + "Product Price" ], - "summary": "Partially update information about a Product Media resource.", + "summary": "Partially update information about a Product Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductMedia", + "operationId": "updateProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -32840,14 +32840,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Media resource.", + "description": "Partially update information about a Product Price resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" }, "included": { "type": "array", @@ -32861,14 +32861,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -32880,7 +32880,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32889,7 +32889,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -32906,14 +32906,14 @@ } } }, - "/product-price": { + "/product-review": { "get": { "tags": [ - "Product Price" + "Product Review" ], - "summary": "List with basic information of Product Price resources.", + "summary": "List with basic information of Product Review resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductPriceList", + "operationId": "getProductReviewList", "parameters": [ { "name": "limit", @@ -32942,7 +32942,7 @@ ], "responses": { "200": { - "description": "List of Product Price resources.", + "description": "List of Product Review resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32961,7 +32961,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } ] @@ -32975,16 +32975,16 @@ "type": "object", "properties": { "first": { - "example": "/product-price?limit=25" + "example": "/product-review?limit=25" }, "last": { - "example": "/product-price?limit=25&page=11" + "example": "/product-review?limit=25&page=11" }, "next": { - "example": "/product-price?limit=25&page=4" + "example": "/product-review?limit=25&page=4" }, "prev": { - "example": "/product-price?limit=25&page=2" + "example": "/product-review?limit=25&page=2" } } } @@ -33005,7 +33005,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33020,11 +33020,11 @@ }, "post": { "tags": [ - "Product Price" + "Product Review" ], - "summary": "Create a new Product Price resources.", + "summary": "Create a new Product Review resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductPrice", + "operationId": "createProductReview", "parameters": [ { "name": "_response", @@ -33046,7 +33046,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" }, "included": { "type": "array", @@ -33060,14 +33060,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -33079,7 +33079,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33088,7 +33088,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33102,19 +33102,19 @@ } } }, - "/product-price/{id}": { + "/product-review/{id}": { "get": { "tags": [ - "Product Price" + "Product Review" ], - "summary": "Detailed information about a Product Price resource.", + "summary": "Detailed information about a Product Review resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductPrice", + "operationId": "getProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -33124,7 +33124,7 @@ ], "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -33136,7 +33136,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33145,7 +33145,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33160,16 +33160,16 @@ }, "delete": { "tags": [ - "Product Price" + "Product Review" ], - "summary": "Delete a Product Price resource.", + "summary": "Delete a Product Review resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductPrice", + "operationId": "deleteProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -33200,16 +33200,16 @@ }, "patch": { "tags": [ - "Product Price" + "Product Review" ], - "summary": "Partially update information about a Product Price resource.", + "summary": "Partially update information about a Product Review resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductPrice", + "operationId": "updateProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -33227,14 +33227,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Price resource.", + "description": "Partially update information about a Product Review resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" }, "included": { "type": "array", @@ -33248,14 +33248,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -33267,7 +33267,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33276,7 +33276,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33293,14 +33293,14 @@ } } }, - "/product-review": { + "/product-search-config": { "get": { "tags": [ - "Product Review" + "Product Search Config" ], - "summary": "List with basic information of Product Review resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductReviewList", + "summary": "List with basic information of Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigList", "parameters": [ { "name": "limit", @@ -33329,7 +33329,7 @@ ], "responses": { "200": { - "description": "List of Product Review resources.", + "description": "List of Product Search Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33348,7 +33348,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } ] @@ -33362,16 +33362,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review?limit=25" + "example": "/product-search-config?limit=25" }, "last": { - "example": "/product-review?limit=25&page=11" + "example": "/product-search-config?limit=25&page=11" }, "next": { - "example": "/product-review?limit=25&page=4" + "example": "/product-search-config?limit=25&page=4" }, "prev": { - "example": "/product-review?limit=25&page=2" + "example": "/product-search-config?limit=25&page=2" } } } @@ -33392,7 +33392,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33407,11 +33407,11 @@ }, "post": { "tags": [ - "Product Review" + "Product Search Config" ], - "summary": "Create a new Product Review resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductReview", + "summary": "Create a new Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createProductSearchConfig", "parameters": [ { "name": "_response", @@ -33433,7 +33433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" }, "included": { "type": "array", @@ -33447,14 +33447,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -33466,7 +33466,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33475,7 +33475,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33489,19 +33489,19 @@ } } }, - "/product-review/{id}": { + "/product-search-config/{id}": { "get": { "tags": [ - "Product Review" + "Product Search Config" ], - "summary": "Detailed information about a Product Review resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductReview", + "summary": "Detailed information about a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -33511,7 +33511,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -33523,7 +33523,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33532,7 +33532,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33547,16 +33547,16 @@ }, "delete": { "tags": [ - "Product Review" + "Product Search Config" ], - "summary": "Delete a Product Review resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductReview", + "summary": "Delete a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -33587,16 +33587,16 @@ }, "patch": { "tags": [ - "Product Review" + "Product Search Config" ], - "summary": "Partially update information about a Product Review resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductReview", + "summary": "Partially update information about a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -33614,14 +33614,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review resource.", + "description": "Partially update information about a Product Search Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" }, "included": { "type": "array", @@ -33635,14 +33635,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -33654,7 +33654,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33663,7 +33663,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33680,14 +33680,14 @@ } } }, - "/product-search-config": { + "/product-search-config-field": { "get": { "tags": [ - "Product Search Config" + "Product Search Config Field" ], - "summary": "List with basic information of Product Search Config resources.", + "summary": "List with basic information of Product Search Config Field resources.", "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigList", + "operationId": "getProductSearchConfigFieldList", "parameters": [ { "name": "limit", @@ -33716,7 +33716,7 @@ ], "responses": { "200": { - "description": "List of Product Search Config resources.", + "description": "List of Product Search Config Field resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33735,7 +33735,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } ] @@ -33749,16 +33749,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-config?limit=25" + "example": "/product-search-config-field?limit=25" }, "last": { - "example": "/product-search-config?limit=25&page=11" + "example": "/product-search-config-field?limit=25&page=11" }, "next": { - "example": "/product-search-config?limit=25&page=4" + "example": "/product-search-config-field?limit=25&page=4" }, "prev": { - "example": "/product-search-config?limit=25&page=2" + "example": "/product-search-config-field?limit=25&page=2" } } } @@ -33779,7 +33779,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -33794,11 +33794,11 @@ }, "post": { "tags": [ - "Product Search Config" + "Product Search Config Field" ], - "summary": "Create a new Product Search Config resources.", + "summary": "Create a new Product Search Config Field resources.", "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfig", + "operationId": "createProductSearchConfigField", "parameters": [ { "name": "_response", @@ -33820,7 +33820,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" }, "included": { "type": "array", @@ -33834,14 +33834,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -33853,7 +33853,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -33862,7 +33862,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -33876,19 +33876,19 @@ } } }, - "/product-search-config/{id}": { + "/product-search-config-field/{id}": { "get": { "tags": [ - "Product Search Config" + "Product Search Config Field" ], - "summary": "Detailed information about a Product Search Config resource.", + "summary": "Detailed information about a Product Search Config Field resource.", "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfig", + "operationId": "getProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -33898,7 +33898,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -33910,7 +33910,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -33919,7 +33919,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -33934,16 +33934,16 @@ }, "delete": { "tags": [ - "Product Search Config" + "Product Search Config Field" ], - "summary": "Delete a Product Search Config resource.", + "summary": "Delete a Product Search Config Field resource.", "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfig", + "operationId": "deleteProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -33974,16 +33974,16 @@ }, "patch": { "tags": [ - "Product Search Config" + "Product Search Config Field" ], - "summary": "Partially update information about a Product Search Config resource.", + "summary": "Partially update information about a Product Search Config Field resource.", "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfig", + "operationId": "updateProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -34001,14 +34001,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Config resource.", + "description": "Partially update information about a Product Search Config Field resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" }, "included": { "type": "array", @@ -34022,14 +34022,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -34041,7 +34041,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -34050,7 +34050,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -34067,14 +34067,14 @@ } } }, - "/product-search-config-field": { + "/product-search-keyword": { "get": { "tags": [ - "Product Search Config Field" + "Product Search Keyword" ], - "summary": "List with basic information of Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigFieldList", + "summary": "List with basic information of Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductSearchKeywordList", "parameters": [ { "name": "limit", @@ -34103,7 +34103,7 @@ ], "responses": { "200": { - "description": "List of Product Search Config Field resources.", + "description": "List of Product Search Keyword resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34122,7 +34122,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } ] @@ -34136,16 +34136,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-config-field?limit=25" + "example": "/product-search-keyword?limit=25" }, "last": { - "example": "/product-search-config-field?limit=25&page=11" + "example": "/product-search-keyword?limit=25&page=11" }, "next": { - "example": "/product-search-config-field?limit=25&page=4" + "example": "/product-search-keyword?limit=25&page=4" }, "prev": { - "example": "/product-search-config-field?limit=25&page=2" + "example": "/product-search-keyword?limit=25&page=2" } } } @@ -34166,7 +34166,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34181,11 +34181,11 @@ }, "post": { "tags": [ - "Product Search Config Field" + "Product Search Keyword" ], - "summary": "Create a new Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfigField", + "summary": "Create a new Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductSearchKeyword", "parameters": [ { "name": "_response", @@ -34207,7 +34207,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" }, "included": { "type": "array", @@ -34221,14 +34221,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -34240,7 +34240,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34249,7 +34249,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34263,19 +34263,19 @@ } } }, - "/product-search-config-field/{id}": { + "/product-search-keyword/{id}": { "get": { "tags": [ - "Product Search Config Field" + "Product Search Keyword" ], - "summary": "Detailed information about a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigField", + "summary": "Detailed information about a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -34285,7 +34285,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -34297,7 +34297,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34306,7 +34306,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34321,16 +34321,16 @@ }, "delete": { "tags": [ - "Product Search Config Field" + "Product Search Keyword" ], - "summary": "Delete a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfigField", + "summary": "Delete a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -34361,16 +34361,16 @@ }, "patch": { "tags": [ - "Product Search Config Field" + "Product Search Keyword" ], - "summary": "Partially update information about a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfigField", + "summary": "Partially update information about a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -34388,14 +34388,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Config Field resource.", + "description": "Partially update information about a Product Search Keyword resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" }, "included": { "type": "array", @@ -34409,14 +34409,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -34428,7 +34428,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34437,7 +34437,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34454,14 +34454,14 @@ } } }, - "/product-search-keyword": { + "/product-sorting": { "get": { "tags": [ - "Product Search Keyword" + "Product Sorting" ], - "summary": "List with basic information of Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeywordList", + "summary": "List with basic information of Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSortingList", "parameters": [ { "name": "limit", @@ -34490,7 +34490,7 @@ ], "responses": { "200": { - "description": "List of Product Search Keyword resources.", + "description": "List of Product Sorting resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34509,7 +34509,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } ] @@ -34523,16 +34523,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-keyword?limit=25" + "example": "/product-sorting?limit=25" }, "last": { - "example": "/product-search-keyword?limit=25&page=11" + "example": "/product-sorting?limit=25&page=11" }, "next": { - "example": "/product-search-keyword?limit=25&page=4" + "example": "/product-sorting?limit=25&page=4" }, "prev": { - "example": "/product-search-keyword?limit=25&page=2" + "example": "/product-sorting?limit=25&page=2" } } } @@ -34553,7 +34553,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34568,11 +34568,11 @@ }, "post": { "tags": [ - "Product Search Keyword" + "Product Sorting" ], - "summary": "Create a new Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductSearchKeyword", + "summary": "Create a new Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "createProductSorting", "parameters": [ { "name": "_response", @@ -34594,7 +34594,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" }, "included": { "type": "array", @@ -34608,14 +34608,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -34627,7 +34627,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34636,7 +34636,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34650,19 +34650,19 @@ } } }, - "/product-search-keyword/{id}": { + "/product-sorting/{id}": { "get": { "tags": [ - "Product Search Keyword" + "Product Sorting" ], - "summary": "Detailed information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeyword", + "summary": "Detailed information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -34672,7 +34672,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -34684,7 +34684,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34693,7 +34693,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34708,16 +34708,16 @@ }, "delete": { "tags": [ - "Product Search Keyword" + "Product Sorting" ], - "summary": "Delete a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductSearchKeyword", + "summary": "Delete a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "deleteProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -34748,16 +34748,16 @@ }, "patch": { "tags": [ - "Product Search Keyword" + "Product Sorting" ], - "summary": "Partially update information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductSearchKeyword", + "summary": "Partially update information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "updateProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -34775,14 +34775,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Keyword resource.", + "description": "Partially update information about a Product Sorting resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" }, "included": { "type": "array", @@ -34796,14 +34796,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -34815,7 +34815,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34824,7 +34824,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34841,14 +34841,14 @@ } } }, - "/product-sorting": { + "/product-stream": { "get": { "tags": [ - "Product Sorting" + "Product Stream" ], - "summary": "List with basic information of Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSortingList", + "summary": "List with basic information of Product Stream resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductStreamList", "parameters": [ { "name": "limit", @@ -34877,7 +34877,7 @@ ], "responses": { "200": { - "description": "List of Product Sorting resources.", + "description": "List of Product Stream resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34896,7 +34896,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } ] @@ -34910,16 +34910,16 @@ "type": "object", "properties": { "first": { - "example": "/product-sorting?limit=25" + "example": "/product-stream?limit=25" }, "last": { - "example": "/product-sorting?limit=25&page=11" + "example": "/product-stream?limit=25&page=11" }, "next": { - "example": "/product-sorting?limit=25&page=4" + "example": "/product-stream?limit=25&page=4" }, "prev": { - "example": "/product-sorting?limit=25&page=2" + "example": "/product-stream?limit=25&page=2" } } } @@ -34940,7 +34940,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -34955,11 +34955,11 @@ }, "post": { "tags": [ - "Product Sorting" + "Product Stream" ], - "summary": "Create a new Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "createProductSorting", + "summary": "Create a new Product Stream resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductStream", "parameters": [ { "name": "_response", @@ -34981,7 +34981,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" }, "included": { "type": "array", @@ -34995,14 +34995,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -35014,7 +35014,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35023,7 +35023,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35037,19 +35037,19 @@ } } }, - "/product-sorting/{id}": { + "/product-stream/{id}": { "get": { "tags": [ - "Product Sorting" + "Product Stream" ], - "summary": "Detailed information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSorting", + "summary": "Detailed information about a Product Stream resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -35059,7 +35059,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -35071,7 +35071,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35080,7 +35080,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35095,16 +35095,16 @@ }, "delete": { "tags": [ - "Product Sorting" + "Product Stream" ], - "summary": "Delete a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "deleteProductSorting", + "summary": "Delete a Product Stream resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -35135,16 +35135,16 @@ }, "patch": { "tags": [ - "Product Sorting" + "Product Stream" ], - "summary": "Partially update information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "updateProductSorting", + "summary": "Partially update information about a Product Stream resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -35162,14 +35162,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Sorting resource.", + "description": "Partially update information about a Product Stream resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" }, "included": { "type": "array", @@ -35183,14 +35183,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -35202,7 +35202,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35211,7 +35211,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35228,14 +35228,14 @@ } } }, - "/product-stream": { + "/product-stream-filter": { "get": { "tags": [ - "Product Stream" + "Product Stream Filter" ], - "summary": "List with basic information of Product Stream resources.", + "summary": "List with basic information of Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamList", + "operationId": "getProductStreamFilterList", "parameters": [ { "name": "limit", @@ -35264,7 +35264,7 @@ ], "responses": { "200": { - "description": "List of Product Stream resources.", + "description": "List of Product Stream Filter resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35283,7 +35283,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } ] @@ -35297,16 +35297,16 @@ "type": "object", "properties": { "first": { - "example": "/product-stream?limit=25" + "example": "/product-stream-filter?limit=25" }, "last": { - "example": "/product-stream?limit=25&page=11" + "example": "/product-stream-filter?limit=25&page=11" }, "next": { - "example": "/product-stream?limit=25&page=4" + "example": "/product-stream-filter?limit=25&page=4" }, "prev": { - "example": "/product-stream?limit=25&page=2" + "example": "/product-stream-filter?limit=25&page=2" } } } @@ -35327,7 +35327,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35342,11 +35342,11 @@ }, "post": { "tags": [ - "Product Stream" + "Product Stream Filter" ], - "summary": "Create a new Product Stream resources.", + "summary": "Create a new Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductStream", + "operationId": "createProductStreamFilter", "parameters": [ { "name": "_response", @@ -35368,7 +35368,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" }, "included": { "type": "array", @@ -35382,14 +35382,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -35401,7 +35401,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35410,7 +35410,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35424,19 +35424,19 @@ } } }, - "/product-stream/{id}": { + "/product-stream-filter/{id}": { "get": { "tags": [ - "Product Stream" + "Product Stream Filter" ], - "summary": "Detailed information about a Product Stream resource.", + "summary": "Detailed information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStream", + "operationId": "getProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -35446,7 +35446,7 @@ ], "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -35458,7 +35458,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35467,7 +35467,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35482,16 +35482,16 @@ }, "delete": { "tags": [ - "Product Stream" + "Product Stream Filter" ], - "summary": "Delete a Product Stream resource.", + "summary": "Delete a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStream", + "operationId": "deleteProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -35522,16 +35522,16 @@ }, "patch": { "tags": [ - "Product Stream" + "Product Stream Filter" ], - "summary": "Partially update information about a Product Stream resource.", + "summary": "Partially update information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductStream", + "operationId": "updateProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -35549,14 +35549,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Stream resource.", + "description": "Partially update information about a Product Stream Filter resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" }, "included": { "type": "array", @@ -35570,14 +35570,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -35589,7 +35589,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35598,7 +35598,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35615,14 +35615,14 @@ } } }, - "/product-stream-filter": { + "/product-visibility": { "get": { "tags": [ - "Product Stream Filter" + "Product Visibility" ], - "summary": "List with basic information of Product Stream Filter resources.", + "summary": "List with basic information of Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilterList", + "operationId": "getProductVisibilityList", "parameters": [ { "name": "limit", @@ -35651,7 +35651,7 @@ ], "responses": { "200": { - "description": "List of Product Stream Filter resources.", + "description": "List of Product Visibility resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35670,7 +35670,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } ] @@ -35684,16 +35684,16 @@ "type": "object", "properties": { "first": { - "example": "/product-stream-filter?limit=25" + "example": "/product-visibility?limit=25" }, "last": { - "example": "/product-stream-filter?limit=25&page=11" + "example": "/product-visibility?limit=25&page=11" }, "next": { - "example": "/product-stream-filter?limit=25&page=4" + "example": "/product-visibility?limit=25&page=4" }, "prev": { - "example": "/product-stream-filter?limit=25&page=2" + "example": "/product-visibility?limit=25&page=2" } } } @@ -35714,7 +35714,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -35729,11 +35729,11 @@ }, "post": { "tags": [ - "Product Stream Filter" + "Product Visibility" ], - "summary": "Create a new Product Stream Filter resources.", + "summary": "Create a new Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductStreamFilter", + "operationId": "createProductVisibility", "parameters": [ { "name": "_response", @@ -35755,7 +35755,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" }, "included": { "type": "array", @@ -35769,14 +35769,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -35788,7 +35788,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -35797,7 +35797,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -35811,19 +35811,19 @@ } } }, - "/product-stream-filter/{id}": { + "/product-visibility/{id}": { "get": { "tags": [ - "Product Stream Filter" + "Product Visibility" ], - "summary": "Detailed information about a Product Stream Filter resource.", + "summary": "Detailed information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilter", + "operationId": "getProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -35833,7 +35833,7 @@ ], "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -35845,7 +35845,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -35854,7 +35854,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -35869,16 +35869,16 @@ }, "delete": { "tags": [ - "Product Stream Filter" + "Product Visibility" ], - "summary": "Delete a Product Stream Filter resource.", + "summary": "Delete a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStreamFilter", + "operationId": "deleteProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -35909,16 +35909,16 @@ }, "patch": { "tags": [ - "Product Stream Filter" + "Product Visibility" ], - "summary": "Partially update information about a Product Stream Filter resource.", + "summary": "Partially update information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductStreamFilter", + "operationId": "updateProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -35936,14 +35936,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Stream Filter resource.", + "description": "Partially update information about a Product Visibility resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" }, "included": { "type": "array", @@ -35957,14 +35957,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -35976,7 +35976,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -35985,7 +35985,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -36002,14 +36002,14 @@ } } }, - "/product-visibility": { + "/promotion": { "get": { "tags": [ - "Product Visibility" + "Promotion" ], - "summary": "List with basic information of Product Visibility resources.", + "summary": "List with basic information of Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibilityList", + "operationId": "getPromotionList", "parameters": [ { "name": "limit", @@ -36038,7 +36038,7 @@ ], "responses": { "200": { - "description": "List of Product Visibility resources.", + "description": "List of Promotion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36057,7 +36057,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } ] @@ -36071,16 +36071,16 @@ "type": "object", "properties": { "first": { - "example": "/product-visibility?limit=25" + "example": "/promotion?limit=25" }, "last": { - "example": "/product-visibility?limit=25&page=11" + "example": "/promotion?limit=25&page=11" }, "next": { - "example": "/product-visibility?limit=25&page=4" + "example": "/promotion?limit=25&page=4" }, "prev": { - "example": "/product-visibility?limit=25&page=2" + "example": "/promotion?limit=25&page=2" } } } @@ -36101,7 +36101,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36116,11 +36116,11 @@ }, "post": { "tags": [ - "Product Visibility" + "Promotion" ], - "summary": "Create a new Product Visibility resources.", + "summary": "Create a new Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductVisibility", + "operationId": "createPromotion", "parameters": [ { "name": "_response", @@ -36142,7 +36142,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" }, "included": { "type": "array", @@ -36156,14 +36156,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -36175,7 +36175,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36184,7 +36184,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36198,19 +36198,19 @@ } } }, - "/product-visibility/{id}": { + "/promotion/{id}": { "get": { "tags": [ - "Product Visibility" + "Promotion" ], - "summary": "Detailed information about a Product Visibility resource.", + "summary": "Detailed information about a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibility", + "operationId": "getPromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -36220,7 +36220,7 @@ ], "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -36232,7 +36232,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36241,7 +36241,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36256,16 +36256,16 @@ }, "delete": { "tags": [ - "Product Visibility" + "Promotion" ], - "summary": "Delete a Product Visibility resource.", + "summary": "Delete a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductVisibility", + "operationId": "deletePromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -36296,16 +36296,16 @@ }, "patch": { "tags": [ - "Product Visibility" + "Promotion" ], - "summary": "Partially update information about a Product Visibility resource.", + "summary": "Partially update information about a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductVisibility", + "operationId": "updatePromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -36323,14 +36323,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Visibility resource.", + "description": "Partially update information about a Promotion resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" }, "included": { "type": "array", @@ -36344,14 +36344,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -36363,7 +36363,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36372,7 +36372,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/Promotion" } } } @@ -36389,14 +36389,14 @@ } } }, - "/promotion": { + "/promotion-discount": { "get": { "tags": [ - "Promotion" + "Promotion Discount" ], - "summary": "List with basic information of Promotion resources.", + "summary": "List with basic information of Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionList", + "operationId": "getPromotionDiscountList", "parameters": [ { "name": "limit", @@ -36425,7 +36425,7 @@ ], "responses": { "200": { - "description": "List of Promotion resources.", + "description": "List of Promotion Discount resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36444,7 +36444,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } ] @@ -36458,16 +36458,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion?limit=25" + "example": "/promotion-discount?limit=25" }, "last": { - "example": "/promotion?limit=25&page=11" + "example": "/promotion-discount?limit=25&page=11" }, "next": { - "example": "/promotion?limit=25&page=4" + "example": "/promotion-discount?limit=25&page=4" }, "prev": { - "example": "/promotion?limit=25&page=2" + "example": "/promotion-discount?limit=25&page=2" } } } @@ -36488,7 +36488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36503,11 +36503,11 @@ }, "post": { "tags": [ - "Promotion" + "Promotion Discount" ], - "summary": "Create a new Promotion resources.", + "summary": "Create a new Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotion", + "operationId": "createPromotionDiscount", "parameters": [ { "name": "_response", @@ -36529,7 +36529,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" }, "included": { "type": "array", @@ -36543,14 +36543,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -36562,7 +36562,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36571,7 +36571,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36585,19 +36585,19 @@ } } }, - "/promotion/{id}": { + "/promotion-discount/{id}": { "get": { "tags": [ - "Promotion" + "Promotion Discount" ], - "summary": "Detailed information about a Promotion resource.", + "summary": "Detailed information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotion", + "operationId": "getPromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -36607,7 +36607,7 @@ ], "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -36619,7 +36619,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36628,7 +36628,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36643,16 +36643,16 @@ }, "delete": { "tags": [ - "Promotion" + "Promotion Discount" ], - "summary": "Delete a Promotion resource.", + "summary": "Delete a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotion", + "operationId": "deletePromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -36683,16 +36683,16 @@ }, "patch": { "tags": [ - "Promotion" + "Promotion Discount" ], - "summary": "Partially update information about a Promotion resource.", + "summary": "Partially update information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotion", + "operationId": "updatePromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -36710,14 +36710,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion resource.", + "description": "Partially update information about a Promotion Discount resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" }, "included": { "type": "array", @@ -36731,14 +36731,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -36750,7 +36750,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36759,7 +36759,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36776,14 +36776,14 @@ } } }, - "/promotion-discount": { + "/promotion-discount-prices": { "get": { "tags": [ - "Promotion Discount" + "Promotion Discount Prices" ], - "summary": "List with basic information of Promotion Discount resources.", + "summary": "List with basic information of Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountList", + "operationId": "getPromotionDiscountPricesList", "parameters": [ { "name": "limit", @@ -36812,7 +36812,7 @@ ], "responses": { "200": { - "description": "List of Promotion Discount resources.", + "description": "List of Promotion Discount Prices resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36831,7 +36831,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } ] @@ -36845,16 +36845,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-discount?limit=25" + "example": "/promotion-discount-prices?limit=25" }, "last": { - "example": "/promotion-discount?limit=25&page=11" + "example": "/promotion-discount-prices?limit=25&page=11" }, "next": { - "example": "/promotion-discount?limit=25&page=4" + "example": "/promotion-discount-prices?limit=25&page=4" }, "prev": { - "example": "/promotion-discount?limit=25&page=2" + "example": "/promotion-discount-prices?limit=25&page=2" } } } @@ -36875,7 +36875,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -36890,11 +36890,11 @@ }, "post": { "tags": [ - "Promotion Discount" + "Promotion Discount Prices" ], - "summary": "Create a new Promotion Discount resources.", + "summary": "Create a new Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscount", + "operationId": "createPromotionDiscountPrices", "parameters": [ { "name": "_response", @@ -36916,7 +36916,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" }, "included": { "type": "array", @@ -36930,14 +36930,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -36949,7 +36949,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -36958,7 +36958,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -36972,19 +36972,19 @@ } } }, - "/promotion-discount/{id}": { + "/promotion-discount-prices/{id}": { "get": { "tags": [ - "Promotion Discount" + "Promotion Discount Prices" ], - "summary": "Detailed information about a Promotion Discount resource.", + "summary": "Detailed information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscount", + "operationId": "getPromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -36994,7 +36994,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -37006,7 +37006,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37015,7 +37015,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37030,16 +37030,16 @@ }, "delete": { "tags": [ - "Promotion Discount" + "Promotion Discount Prices" ], - "summary": "Delete a Promotion Discount resource.", + "summary": "Delete a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscount", + "operationId": "deletePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -37070,16 +37070,16 @@ }, "patch": { "tags": [ - "Promotion Discount" + "Promotion Discount Prices" ], - "summary": "Partially update information about a Promotion Discount resource.", + "summary": "Partially update information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscount", + "operationId": "updatePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -37097,14 +37097,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Discount resource.", + "description": "Partially update information about a Promotion Discount Prices resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" }, "included": { "type": "array", @@ -37118,14 +37118,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -37137,7 +37137,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37146,7 +37146,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37163,14 +37163,14 @@ } } }, - "/promotion-discount-prices": { + "/promotion-individual-code": { "get": { "tags": [ - "Promotion Discount Prices" + "Promotion Individual Code" ], - "summary": "List with basic information of Promotion Discount Prices resources.", + "summary": "List with basic information of Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPricesList", + "operationId": "getPromotionIndividualCodeList", "parameters": [ { "name": "limit", @@ -37199,7 +37199,7 @@ ], "responses": { "200": { - "description": "List of Promotion Discount Prices resources.", + "description": "List of Promotion Individual Code resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37218,7 +37218,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } ] @@ -37232,16 +37232,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-discount-prices?limit=25" + "example": "/promotion-individual-code?limit=25" }, "last": { - "example": "/promotion-discount-prices?limit=25&page=11" + "example": "/promotion-individual-code?limit=25&page=11" }, "next": { - "example": "/promotion-discount-prices?limit=25&page=4" + "example": "/promotion-individual-code?limit=25&page=4" }, "prev": { - "example": "/promotion-discount-prices?limit=25&page=2" + "example": "/promotion-individual-code?limit=25&page=2" } } } @@ -37262,7 +37262,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37277,11 +37277,11 @@ }, "post": { "tags": [ - "Promotion Discount Prices" + "Promotion Individual Code" ], - "summary": "Create a new Promotion Discount Prices resources.", + "summary": "Create a new Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscountPrices", + "operationId": "createPromotionIndividualCode", "parameters": [ { "name": "_response", @@ -37303,7 +37303,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" }, "included": { "type": "array", @@ -37317,14 +37317,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -37336,7 +37336,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37345,7 +37345,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37359,19 +37359,19 @@ } } }, - "/promotion-discount-prices/{id}": { + "/promotion-individual-code/{id}": { "get": { "tags": [ - "Promotion Discount Prices" + "Promotion Individual Code" ], - "summary": "Detailed information about a Promotion Discount Prices resource.", + "summary": "Detailed information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPrices", + "operationId": "getPromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -37381,7 +37381,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -37393,7 +37393,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37402,7 +37402,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37417,16 +37417,16 @@ }, "delete": { "tags": [ - "Promotion Discount Prices" + "Promotion Individual Code" ], - "summary": "Delete a Promotion Discount Prices resource.", + "summary": "Delete a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscountPrices", + "operationId": "deletePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -37457,16 +37457,16 @@ }, "patch": { "tags": [ - "Promotion Discount Prices" + "Promotion Individual Code" ], - "summary": "Partially update information about a Promotion Discount Prices resource.", + "summary": "Partially update information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscountPrices", + "operationId": "updatePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -37484,14 +37484,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Discount Prices resource.", + "description": "Partially update information about a Promotion Individual Code resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" }, "included": { "type": "array", @@ -37505,14 +37505,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -37524,7 +37524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37533,7 +37533,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37550,14 +37550,14 @@ } } }, - "/promotion-individual-code": { + "/promotion-sales-channel": { "get": { "tags": [ - "Promotion Individual Code" + "Promotion Sales Channel" ], - "summary": "List with basic information of Promotion Individual Code resources.", + "summary": "List with basic information of Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCodeList", + "operationId": "getPromotionSalesChannelList", "parameters": [ { "name": "limit", @@ -37586,7 +37586,7 @@ ], "responses": { "200": { - "description": "List of Promotion Individual Code resources.", + "description": "List of Promotion Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37605,7 +37605,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } ] @@ -37619,16 +37619,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-individual-code?limit=25" + "example": "/promotion-sales-channel?limit=25" }, "last": { - "example": "/promotion-individual-code?limit=25&page=11" + "example": "/promotion-sales-channel?limit=25&page=11" }, "next": { - "example": "/promotion-individual-code?limit=25&page=4" + "example": "/promotion-sales-channel?limit=25&page=4" }, "prev": { - "example": "/promotion-individual-code?limit=25&page=2" + "example": "/promotion-sales-channel?limit=25&page=2" } } } @@ -37649,7 +37649,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37664,11 +37664,11 @@ }, "post": { "tags": [ - "Promotion Individual Code" + "Promotion Sales Channel" ], - "summary": "Create a new Promotion Individual Code resources.", + "summary": "Create a new Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionIndividualCode", + "operationId": "createPromotionSalesChannel", "parameters": [ { "name": "_response", @@ -37690,7 +37690,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" }, "included": { "type": "array", @@ -37704,14 +37704,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -37723,7 +37723,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37732,7 +37732,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37746,19 +37746,19 @@ } } }, - "/promotion-individual-code/{id}": { + "/promotion-sales-channel/{id}": { "get": { "tags": [ - "Promotion Individual Code" + "Promotion Sales Channel" ], - "summary": "Detailed information about a Promotion Individual Code resource.", + "summary": "Detailed information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCode", + "operationId": "getPromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -37768,7 +37768,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -37780,7 +37780,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37789,7 +37789,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37804,16 +37804,16 @@ }, "delete": { "tags": [ - "Promotion Individual Code" + "Promotion Sales Channel" ], - "summary": "Delete a Promotion Individual Code resource.", + "summary": "Delete a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionIndividualCode", + "operationId": "deletePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -37844,16 +37844,16 @@ }, "patch": { "tags": [ - "Promotion Individual Code" + "Promotion Sales Channel" ], - "summary": "Partially update information about a Promotion Individual Code resource.", + "summary": "Partially update information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionIndividualCode", + "operationId": "updatePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -37871,14 +37871,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Individual Code resource.", + "description": "Partially update information about a Promotion Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" }, "included": { "type": "array", @@ -37892,14 +37892,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -37911,7 +37911,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37920,7 +37920,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -37937,14 +37937,14 @@ } } }, - "/promotion-sales-channel": { + "/promotion-setgroup": { "get": { "tags": [ - "Promotion Sales Channel" + "Promotion Setgroup" ], - "summary": "List with basic information of Promotion Sales Channel resources.", + "summary": "List with basic information of Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannelList", + "operationId": "getPromotionSetgroupList", "parameters": [ { "name": "limit", @@ -37973,7 +37973,7 @@ ], "responses": { "200": { - "description": "List of Promotion Sales Channel resources.", + "description": "List of Promotion Setgroup resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37992,7 +37992,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } ] @@ -38006,16 +38006,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-sales-channel?limit=25" + "example": "/promotion-setgroup?limit=25" }, "last": { - "example": "/promotion-sales-channel?limit=25&page=11" + "example": "/promotion-setgroup?limit=25&page=11" }, "next": { - "example": "/promotion-sales-channel?limit=25&page=4" + "example": "/promotion-setgroup?limit=25&page=4" }, "prev": { - "example": "/promotion-sales-channel?limit=25&page=2" + "example": "/promotion-setgroup?limit=25&page=2" } } } @@ -38036,7 +38036,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38051,11 +38051,11 @@ }, "post": { "tags": [ - "Promotion Sales Channel" + "Promotion Setgroup" ], - "summary": "Create a new Promotion Sales Channel resources.", + "summary": "Create a new Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSalesChannel", + "operationId": "createPromotionSetgroup", "parameters": [ { "name": "_response", @@ -38077,7 +38077,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" }, "included": { "type": "array", @@ -38091,14 +38091,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -38110,7 +38110,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38119,7 +38119,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38133,19 +38133,19 @@ } } }, - "/promotion-sales-channel/{id}": { + "/promotion-setgroup/{id}": { "get": { "tags": [ - "Promotion Sales Channel" + "Promotion Setgroup" ], - "summary": "Detailed information about a Promotion Sales Channel resource.", + "summary": "Detailed information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannel", + "operationId": "getPromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -38155,7 +38155,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -38167,7 +38167,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38176,7 +38176,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38191,16 +38191,16 @@ }, "delete": { "tags": [ - "Promotion Sales Channel" + "Promotion Setgroup" ], - "summary": "Delete a Promotion Sales Channel resource.", + "summary": "Delete a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSalesChannel", + "operationId": "deletePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -38231,16 +38231,16 @@ }, "patch": { "tags": [ - "Promotion Sales Channel" + "Promotion Setgroup" ], - "summary": "Partially update information about a Promotion Sales Channel resource.", + "summary": "Partially update information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSalesChannel", + "operationId": "updatePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -38258,14 +38258,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Sales Channel resource.", + "description": "Partially update information about a Promotion Setgroup resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" }, "included": { "type": "array", @@ -38279,14 +38279,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -38298,7 +38298,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38307,7 +38307,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38324,14 +38324,14 @@ } } }, - "/promotion-setgroup": { + "/property-group": { "get": { "tags": [ - "Promotion Setgroup" + "Property Group" ], - "summary": "List with basic information of Promotion Setgroup resources.", + "summary": "List with basic information of Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroupList", + "operationId": "getPropertyGroupList", "parameters": [ { "name": "limit", @@ -38360,7 +38360,7 @@ ], "responses": { "200": { - "description": "List of Promotion Setgroup resources.", + "description": "List of Property Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -38379,7 +38379,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } ] @@ -38393,16 +38393,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-setgroup?limit=25" + "example": "/property-group?limit=25" }, "last": { - "example": "/promotion-setgroup?limit=25&page=11" + "example": "/property-group?limit=25&page=11" }, "next": { - "example": "/promotion-setgroup?limit=25&page=4" + "example": "/property-group?limit=25&page=4" }, "prev": { - "example": "/promotion-setgroup?limit=25&page=2" + "example": "/property-group?limit=25&page=2" } } } @@ -38423,7 +38423,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38438,11 +38438,11 @@ }, "post": { "tags": [ - "Promotion Setgroup" + "Property Group" ], - "summary": "Create a new Promotion Setgroup resources.", + "summary": "Create a new Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSetgroup", + "operationId": "createPropertyGroup", "parameters": [ { "name": "_response", @@ -38464,7 +38464,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" }, "included": { "type": "array", @@ -38478,14 +38478,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -38497,7 +38497,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38506,7 +38506,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38520,19 +38520,19 @@ } } }, - "/promotion-setgroup/{id}": { + "/property-group/{id}": { "get": { "tags": [ - "Promotion Setgroup" + "Property Group" ], - "summary": "Detailed information about a Promotion Setgroup resource.", + "summary": "Detailed information about a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroup", + "operationId": "getPropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -38542,7 +38542,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -38554,7 +38554,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38563,7 +38563,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38578,16 +38578,16 @@ }, "delete": { "tags": [ - "Promotion Setgroup" + "Property Group" ], - "summary": "Delete a Promotion Setgroup resource.", + "summary": "Delete a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSetgroup", + "operationId": "deletePropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -38618,16 +38618,16 @@ }, "patch": { "tags": [ - "Promotion Setgroup" + "Property Group" ], - "summary": "Partially update information about a Promotion Setgroup resource.", + "summary": "Partially update information about a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSetgroup", + "operationId": "updatePropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -38645,14 +38645,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Setgroup resource.", + "description": "Partially update information about a Property Group resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" }, "included": { "type": "array", @@ -38666,14 +38666,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -38685,7 +38685,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38694,7 +38694,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38711,14 +38711,14 @@ } } }, - "/property-group": { + "/property-group-option": { "get": { "tags": [ - "Property Group" + "Property Group Option" ], - "summary": "List with basic information of Property Group resources.", + "summary": "List with basic information of Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupList", + "operationId": "getPropertyGroupOptionList", "parameters": [ { "name": "limit", @@ -38747,7 +38747,7 @@ ], "responses": { "200": { - "description": "List of Property Group resources.", + "description": "List of Property Group Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -38766,7 +38766,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } ] @@ -38780,16 +38780,16 @@ "type": "object", "properties": { "first": { - "example": "/property-group?limit=25" + "example": "/property-group-option?limit=25" }, "last": { - "example": "/property-group?limit=25&page=11" + "example": "/property-group-option?limit=25&page=11" }, "next": { - "example": "/property-group?limit=25&page=4" + "example": "/property-group-option?limit=25&page=4" }, "prev": { - "example": "/property-group?limit=25&page=2" + "example": "/property-group-option?limit=25&page=2" } } } @@ -38810,7 +38810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -38825,11 +38825,11 @@ }, "post": { "tags": [ - "Property Group" + "Property Group Option" ], - "summary": "Create a new Property Group resources.", + "summary": "Create a new Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroup", + "operationId": "createPropertyGroupOption", "parameters": [ { "name": "_response", @@ -38851,7 +38851,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" }, "included": { "type": "array", @@ -38865,14 +38865,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -38884,7 +38884,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -38893,7 +38893,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -38907,19 +38907,19 @@ } } }, - "/property-group/{id}": { + "/property-group-option/{id}": { "get": { "tags": [ - "Property Group" + "Property Group Option" ], - "summary": "Detailed information about a Property Group resource.", + "summary": "Detailed information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroup", + "operationId": "getPropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -38929,7 +38929,7 @@ ], "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -38941,7 +38941,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -38950,7 +38950,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -38965,16 +38965,16 @@ }, "delete": { "tags": [ - "Property Group" + "Property Group Option" ], - "summary": "Delete a Property Group resource.", + "summary": "Delete a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroup", + "operationId": "deletePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -39005,16 +39005,16 @@ }, "patch": { "tags": [ - "Property Group" + "Property Group Option" ], - "summary": "Partially update information about a Property Group resource.", + "summary": "Partially update information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroup", + "operationId": "updatePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -39032,14 +39032,14 @@ } ], "requestBody": { - "description": "Partially update information about a Property Group resource.", + "description": "Partially update information about a Property Group Option resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" }, "included": { "type": "array", @@ -39053,14 +39053,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -39072,7 +39072,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -39081,7 +39081,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -39098,14 +39098,14 @@ } } }, - "/property-group-option": { + "/rule": { "get": { "tags": [ - "Property Group Option" + "Rule" ], - "summary": "List with basic information of Property Group Option resources.", + "summary": "List with basic information of Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOptionList", + "operationId": "getRuleList", "parameters": [ { "name": "limit", @@ -39134,7 +39134,7 @@ ], "responses": { "200": { - "description": "List of Property Group Option resources.", + "description": "List of Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39153,7 +39153,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } ] @@ -39167,16 +39167,16 @@ "type": "object", "properties": { "first": { - "example": "/property-group-option?limit=25" + "example": "/rule?limit=25" }, "last": { - "example": "/property-group-option?limit=25&page=11" + "example": "/rule?limit=25&page=11" }, "next": { - "example": "/property-group-option?limit=25&page=4" + "example": "/rule?limit=25&page=4" }, "prev": { - "example": "/property-group-option?limit=25&page=2" + "example": "/rule?limit=25&page=2" } } } @@ -39197,7 +39197,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39212,11 +39212,11 @@ }, "post": { "tags": [ - "Property Group Option" + "Rule" ], - "summary": "Create a new Property Group Option resources.", + "summary": "Create a new Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroupOption", + "operationId": "createRule", "parameters": [ { "name": "_response", @@ -39238,7 +39238,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" }, "included": { "type": "array", @@ -39252,14 +39252,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -39271,7 +39271,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39280,7 +39280,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39294,19 +39294,19 @@ } } }, - "/property-group-option/{id}": { + "/rule/{id}": { "get": { "tags": [ - "Property Group Option" + "Rule" ], - "summary": "Detailed information about a Property Group Option resource.", + "summary": "Detailed information about a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOption", + "operationId": "getRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -39316,7 +39316,7 @@ ], "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -39328,7 +39328,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39337,7 +39337,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39352,16 +39352,16 @@ }, "delete": { "tags": [ - "Property Group Option" + "Rule" ], - "summary": "Delete a Property Group Option resource.", + "summary": "Delete a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroupOption", + "operationId": "deleteRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -39392,16 +39392,16 @@ }, "patch": { "tags": [ - "Property Group Option" + "Rule" ], - "summary": "Partially update information about a Property Group Option resource.", + "summary": "Partially update information about a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroupOption", + "operationId": "updateRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -39419,14 +39419,14 @@ } ], "requestBody": { - "description": "Partially update information about a Property Group Option resource.", + "description": "Partially update information about a Rule resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" }, "included": { "type": "array", @@ -39440,14 +39440,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -39459,7 +39459,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39468,7 +39468,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/Rule" } } } @@ -39485,14 +39485,14 @@ } } }, - "/rule": { + "/rule-condition": { "get": { "tags": [ - "Rule" + "Rule Condition" ], - "summary": "List with basic information of Rule resources.", + "summary": "List with basic information of Rule Condition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleList", + "operationId": "getRuleConditionList", "parameters": [ { "name": "limit", @@ -39521,7 +39521,7 @@ ], "responses": { "200": { - "description": "List of Rule resources.", + "description": "List of Rule Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39540,7 +39540,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } ] @@ -39554,16 +39554,16 @@ "type": "object", "properties": { "first": { - "example": "/rule?limit=25" + "example": "/rule-condition?limit=25" }, "last": { - "example": "/rule?limit=25&page=11" + "example": "/rule-condition?limit=25&page=11" }, "next": { - "example": "/rule?limit=25&page=4" + "example": "/rule-condition?limit=25&page=4" }, "prev": { - "example": "/rule?limit=25&page=2" + "example": "/rule-condition?limit=25&page=2" } } } @@ -39584,7 +39584,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39599,11 +39599,11 @@ }, "post": { "tags": [ - "Rule" + "Rule Condition" ], - "summary": "Create a new Rule resources.", + "summary": "Create a new Rule Condition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createRule", + "operationId": "createRuleCondition", "parameters": [ { "name": "_response", @@ -39625,7 +39625,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" }, "included": { "type": "array", @@ -39639,14 +39639,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -39658,7 +39658,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39667,7 +39667,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39681,19 +39681,19 @@ } } }, - "/rule/{id}": { + "/rule-condition/{id}": { "get": { "tags": [ - "Rule" + "Rule Condition" ], - "summary": "Detailed information about a Rule resource.", + "summary": "Detailed information about a Rule Condition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getRule", + "operationId": "getRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -39703,7 +39703,7 @@ ], "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -39715,7 +39715,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39724,7 +39724,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39739,16 +39739,16 @@ }, "delete": { "tags": [ - "Rule" + "Rule Condition" ], - "summary": "Delete a Rule resource.", + "summary": "Delete a Rule Condition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteRule", + "operationId": "deleteRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -39779,16 +39779,16 @@ }, "patch": { "tags": [ - "Rule" + "Rule Condition" ], - "summary": "Partially update information about a Rule resource.", + "summary": "Partially update information about a Rule Condition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateRule", + "operationId": "updateRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -39806,14 +39806,14 @@ } ], "requestBody": { - "description": "Partially update information about a Rule resource.", + "description": "Partially update information about a Rule Condition resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" }, "included": { "type": "array", @@ -39827,14 +39827,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -39846,7 +39846,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39855,7 +39855,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39872,14 +39872,14 @@ } } }, - "/rule-condition": { + "/sales-channel": { "get": { "tags": [ - "Rule Condition" + "Sales Channel" ], - "summary": "List with basic information of Rule Condition resources.", + "summary": "List with basic information of Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleConditionList", + "operationId": "getSalesChannelList", "parameters": [ { "name": "limit", @@ -39908,7 +39908,7 @@ ], "responses": { "200": { - "description": "List of Rule Condition resources.", + "description": "List of Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39927,7 +39927,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } ] @@ -39941,16 +39941,16 @@ "type": "object", "properties": { "first": { - "example": "/rule-condition?limit=25" + "example": "/sales-channel?limit=25" }, "last": { - "example": "/rule-condition?limit=25&page=11" + "example": "/sales-channel?limit=25&page=11" }, "next": { - "example": "/rule-condition?limit=25&page=4" + "example": "/sales-channel?limit=25&page=4" }, "prev": { - "example": "/rule-condition?limit=25&page=2" + "example": "/sales-channel?limit=25&page=2" } } } @@ -39971,7 +39971,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -39986,11 +39986,11 @@ }, "post": { "tags": [ - "Rule Condition" + "Sales Channel" ], - "summary": "Create a new Rule Condition resources.", + "summary": "Create a new Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createRuleCondition", + "operationId": "createSalesChannel", "parameters": [ { "name": "_response", @@ -40012,7 +40012,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" }, "included": { "type": "array", @@ -40026,14 +40026,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -40045,7 +40045,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40054,7 +40054,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40068,19 +40068,19 @@ } } }, - "/rule-condition/{id}": { + "/sales-channel/{id}": { "get": { "tags": [ - "Rule Condition" + "Sales Channel" ], - "summary": "Detailed information about a Rule Condition resource.", + "summary": "Detailed information about a Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleCondition", + "operationId": "getSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -40090,7 +40090,7 @@ ], "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -40102,7 +40102,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40111,7 +40111,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40126,16 +40126,16 @@ }, "delete": { "tags": [ - "Rule Condition" + "Sales Channel" ], - "summary": "Delete a Rule Condition resource.", + "summary": "Delete a Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteRuleCondition", + "operationId": "deleteSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -40166,16 +40166,16 @@ }, "patch": { "tags": [ - "Rule Condition" + "Sales Channel" ], - "summary": "Partially update information about a Rule Condition resource.", + "summary": "Partially update information about a Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateRuleCondition", + "operationId": "updateSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -40193,14 +40193,14 @@ } ], "requestBody": { - "description": "Partially update information about a Rule Condition resource.", + "description": "Partially update information about a Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" }, "included": { "type": "array", @@ -40214,14 +40214,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -40233,7 +40233,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40242,7 +40242,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40259,14 +40259,14 @@ } } }, - "/sales-channel": { + "/sales-channel-analytics": { "get": { "tags": [ - "Sales Channel" + "Sales Channel Analytics" ], - "summary": "List with basic information of Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelList", + "summary": "List with basic information of Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalyticsList", "parameters": [ { "name": "limit", @@ -40295,7 +40295,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel resources.", + "description": "List of Sales Channel Analytics resources.", "content": { "application/vnd.api+json": { "schema": { @@ -40314,7 +40314,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } ] @@ -40328,16 +40328,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel?limit=25" + "example": "/sales-channel-analytics?limit=25" }, "last": { - "example": "/sales-channel?limit=25&page=11" + "example": "/sales-channel-analytics?limit=25&page=11" }, "next": { - "example": "/sales-channel?limit=25&page=4" + "example": "/sales-channel-analytics?limit=25&page=4" }, "prev": { - "example": "/sales-channel?limit=25&page=2" + "example": "/sales-channel-analytics?limit=25&page=2" } } } @@ -40358,7 +40358,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40373,11 +40373,11 @@ }, "post": { "tags": [ - "Sales Channel" + "Sales Channel Analytics" ], - "summary": "Create a new Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannel", + "summary": "Create a new Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createSalesChannelAnalytics", "parameters": [ { "name": "_response", @@ -40399,7 +40399,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" }, "included": { "type": "array", @@ -40413,14 +40413,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -40432,7 +40432,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40441,7 +40441,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40455,19 +40455,19 @@ } } }, - "/sales-channel/{id}": { + "/sales-channel-analytics/{id}": { "get": { "tags": [ - "Sales Channel" + "Sales Channel Analytics" ], - "summary": "Detailed information about a Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannel", + "summary": "Detailed information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -40477,7 +40477,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -40489,7 +40489,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40498,7 +40498,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40513,16 +40513,16 @@ }, "delete": { "tags": [ - "Sales Channel" + "Sales Channel Analytics" ], - "summary": "Delete a Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannel", + "summary": "Delete a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -40553,16 +40553,16 @@ }, "patch": { "tags": [ - "Sales Channel" + "Sales Channel Analytics" ], - "summary": "Partially update information about a Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannel", + "summary": "Partially update information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -40580,14 +40580,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel resource.", + "description": "Partially update information about a Sales Channel Analytics resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" }, "included": { "type": "array", @@ -40601,14 +40601,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -40620,7 +40620,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40629,7 +40629,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40646,14 +40646,14 @@ } } }, - "/sales-channel-analytics": { + "/sales-channel-domain": { "get": { "tags": [ - "Sales Channel Analytics" + "Sales Channel Domain" ], - "summary": "List with basic information of Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalyticsList", + "summary": "List with basic information of Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelDomainList", "parameters": [ { "name": "limit", @@ -40682,7 +40682,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Analytics resources.", + "description": "List of Sales Channel Domain resources.", "content": { "application/vnd.api+json": { "schema": { @@ -40701,7 +40701,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } ] @@ -40715,16 +40715,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-analytics?limit=25" + "example": "/sales-channel-domain?limit=25" }, "last": { - "example": "/sales-channel-analytics?limit=25&page=11" + "example": "/sales-channel-domain?limit=25&page=11" }, "next": { - "example": "/sales-channel-analytics?limit=25&page=4" + "example": "/sales-channel-domain?limit=25&page=4" }, "prev": { - "example": "/sales-channel-analytics?limit=25&page=2" + "example": "/sales-channel-domain?limit=25&page=2" } } } @@ -40745,7 +40745,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -40760,11 +40760,11 @@ }, "post": { "tags": [ - "Sales Channel Analytics" + "Sales Channel Domain" ], - "summary": "Create a new Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createSalesChannelAnalytics", + "summary": "Create a new Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelDomain", "parameters": [ { "name": "_response", @@ -40786,7 +40786,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" }, "included": { "type": "array", @@ -40800,14 +40800,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -40819,7 +40819,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -40828,7 +40828,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -40842,19 +40842,19 @@ } } }, - "/sales-channel-analytics/{id}": { + "/sales-channel-domain/{id}": { "get": { "tags": [ - "Sales Channel Analytics" + "Sales Channel Domain" ], - "summary": "Detailed information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalytics", + "summary": "Detailed information about a Sales Channel Domain resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -40864,7 +40864,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -40876,7 +40876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -40885,7 +40885,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -40900,16 +40900,16 @@ }, "delete": { "tags": [ - "Sales Channel Analytics" + "Sales Channel Domain" ], - "summary": "Delete a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteSalesChannelAnalytics", + "summary": "Delete a Sales Channel Domain resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -40940,16 +40940,16 @@ }, "patch": { "tags": [ - "Sales Channel Analytics" + "Sales Channel Domain" ], - "summary": "Partially update information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateSalesChannelAnalytics", + "summary": "Partially update information about a Sales Channel Domain resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -40967,14 +40967,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Analytics resource.", + "description": "Partially update information about a Sales Channel Domain resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" }, "included": { "type": "array", @@ -40988,14 +40988,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -41007,7 +41007,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -41016,7 +41016,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -41033,14 +41033,14 @@ } } }, - "/sales-channel-domain": { + "/sales-channel-type": { "get": { "tags": [ - "Sales Channel Domain" + "Sales Channel Type" ], - "summary": "List with basic information of Sales Channel Domain resources.", + "summary": "List with basic information of Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomainList", + "operationId": "getSalesChannelTypeList", "parameters": [ { "name": "limit", @@ -41069,7 +41069,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Domain resources.", + "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41088,7 +41088,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } ] @@ -41102,16 +41102,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-domain?limit=25" + "example": "/sales-channel-type?limit=25" }, "last": { - "example": "/sales-channel-domain?limit=25&page=11" + "example": "/sales-channel-type?limit=25&page=11" }, "next": { - "example": "/sales-channel-domain?limit=25&page=4" + "example": "/sales-channel-type?limit=25&page=4" }, "prev": { - "example": "/sales-channel-domain?limit=25&page=2" + "example": "/sales-channel-type?limit=25&page=2" } } } @@ -41132,7 +41132,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41147,11 +41147,11 @@ }, "post": { "tags": [ - "Sales Channel Domain" + "Sales Channel Type" ], - "summary": "Create a new Sales Channel Domain resources.", + "summary": "Create a new Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelDomain", + "operationId": "createSalesChannelType", "parameters": [ { "name": "_response", @@ -41173,7 +41173,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" }, "included": { "type": "array", @@ -41187,14 +41187,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -41206,7 +41206,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41215,7 +41215,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41229,19 +41229,19 @@ } } }, - "/sales-channel-domain/{id}": { + "/sales-channel-type/{id}": { "get": { "tags": [ - "Sales Channel Domain" + "Sales Channel Type" ], - "summary": "Detailed information about a Sales Channel Domain resource.", + "summary": "Detailed information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomain", + "operationId": "getSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -41251,7 +41251,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -41263,7 +41263,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41272,7 +41272,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41287,16 +41287,16 @@ }, "delete": { "tags": [ - "Sales Channel Domain" + "Sales Channel Type" ], - "summary": "Delete a Sales Channel Domain resource.", + "summary": "Delete a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelDomain", + "operationId": "deleteSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -41327,16 +41327,16 @@ }, "patch": { "tags": [ - "Sales Channel Domain" + "Sales Channel Type" ], - "summary": "Partially update information about a Sales Channel Domain resource.", + "summary": "Partially update information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelDomain", + "operationId": "updateSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -41354,14 +41354,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Domain resource.", + "description": "Partially update information about a Sales Channel Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" }, "included": { "type": "array", @@ -41375,14 +41375,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -41394,7 +41394,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41403,7 +41403,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41420,14 +41420,14 @@ } } }, - "/sales-channel-type": { + "/salutation": { "get": { "tags": [ - "Sales Channel Type" + "Salutation" ], - "summary": "List with basic information of Sales Channel Type resources.", + "summary": "List with basic information of Salutation resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelTypeList", + "operationId": "getSalutationList", "parameters": [ { "name": "limit", @@ -41456,7 +41456,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Type resources.", + "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41475,7 +41475,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } ] @@ -41489,16 +41489,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-type?limit=25" + "example": "/salutation?limit=25" }, "last": { - "example": "/sales-channel-type?limit=25&page=11" + "example": "/salutation?limit=25&page=11" }, "next": { - "example": "/sales-channel-type?limit=25&page=4" + "example": "/salutation?limit=25&page=4" }, "prev": { - "example": "/sales-channel-type?limit=25&page=2" + "example": "/salutation?limit=25&page=2" } } } @@ -41519,7 +41519,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41534,11 +41534,11 @@ }, "post": { "tags": [ - "Sales Channel Type" + "Salutation" ], - "summary": "Create a new Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", + "summary": "Create a new Salutation resources.", + "description": "Fetches salutations with a criteria obj.", + "operationId": "createSalutation", "parameters": [ { "name": "_response", @@ -41560,7 +41560,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" }, "included": { "type": "array", @@ -41574,14 +41574,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -41593,7 +41593,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41602,7 +41602,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41616,19 +41616,19 @@ } } }, - "/sales-channel-type/{id}": { + "/salutation/{id}": { "get": { "tags": [ - "Sales Channel Type" + "Salutation" ], - "summary": "Detailed information about a Sales Channel Type resource.", + "summary": "Detailed information about a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelType", + "operationId": "getSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -41638,7 +41638,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -41650,7 +41650,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41659,7 +41659,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41674,16 +41674,16 @@ }, "delete": { "tags": [ - "Sales Channel Type" + "Salutation" ], - "summary": "Delete a Sales Channel Type resource.", + "summary": "Delete a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelType", + "operationId": "deleteSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -41714,16 +41714,16 @@ }, "patch": { "tags": [ - "Sales Channel Type" + "Salutation" ], - "summary": "Partially update information about a Sales Channel Type resource.", + "summary": "Partially update information about a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelType", + "operationId": "updateSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -41741,14 +41741,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Type resource.", + "description": "Partially update information about a Salutation resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" }, "included": { "type": "array", @@ -41762,14 +41762,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -41781,7 +41781,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41790,7 +41790,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/Salutation" } } } @@ -41807,14 +41807,14 @@ } } }, - "/salutation": { + "/scheduled-task": { "get": { "tags": [ - "Salutation" + "Scheduled Task" ], - "summary": "List with basic information of Salutation resources.", + "summary": "List with basic information of Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", + "operationId": "getScheduledTaskList", "parameters": [ { "name": "limit", @@ -41843,7 +41843,7 @@ ], "responses": { "200": { - "description": "List of Salutation resources.", + "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41862,7 +41862,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } ] @@ -41876,16 +41876,16 @@ "type": "object", "properties": { "first": { - "example": "/salutation?limit=25" + "example": "/scheduled-task?limit=25" }, "last": { - "example": "/salutation?limit=25&page=11" + "example": "/scheduled-task?limit=25&page=11" }, "next": { - "example": "/salutation?limit=25&page=4" + "example": "/scheduled-task?limit=25&page=4" }, "prev": { - "example": "/salutation?limit=25&page=2" + "example": "/scheduled-task?limit=25&page=2" } } } @@ -41906,7 +41906,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -41921,11 +41921,11 @@ }, "post": { "tags": [ - "Salutation" + "Scheduled Task" ], - "summary": "Create a new Salutation resources.", - "description": "Fetches salutations with a criteria obj.", - "operationId": "createSalutation", + "summary": "Create a new Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createScheduledTask", "parameters": [ { "name": "_response", @@ -41947,7 +41947,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" }, "included": { "type": "array", @@ -41961,14 +41961,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -41980,7 +41980,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -41989,7 +41989,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42003,19 +42003,19 @@ } } }, - "/salutation/{id}": { + "/scheduled-task/{id}": { "get": { "tags": [ - "Salutation" + "Scheduled Task" ], - "summary": "Detailed information about a Salutation resource.", + "summary": "Detailed information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutation", + "operationId": "getScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -42025,7 +42025,7 @@ ], "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -42037,7 +42037,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42046,7 +42046,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42061,16 +42061,16 @@ }, "delete": { "tags": [ - "Salutation" + "Scheduled Task" ], - "summary": "Delete a Salutation resource.", + "summary": "Delete a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", + "operationId": "deleteScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -42101,16 +42101,16 @@ }, "patch": { "tags": [ - "Salutation" + "Scheduled Task" ], - "summary": "Partially update information about a Salutation resource.", + "summary": "Partially update information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalutation", + "operationId": "updateScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -42128,14 +42128,14 @@ } ], "requestBody": { - "description": "Partially update information about a Salutation resource.", + "description": "Partially update information about a Scheduled Task resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" }, "included": { "type": "array", @@ -42149,14 +42149,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -42168,7 +42168,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42177,7 +42177,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42194,14 +42194,14 @@ } } }, - "/scheduled-task": { + "/script": { "get": { "tags": [ - "Scheduled Task" + "Script" ], - "summary": "List with basic information of Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTaskList", + "summary": "List with basic information of Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getScriptList", "parameters": [ { "name": "limit", @@ -42230,7 +42230,7 @@ ], "responses": { "200": { - "description": "List of Scheduled Task resources.", + "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { @@ -42249,7 +42249,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } ] @@ -42263,16 +42263,16 @@ "type": "object", "properties": { "first": { - "example": "/scheduled-task?limit=25" + "example": "/script?limit=25" }, "last": { - "example": "/scheduled-task?limit=25&page=11" + "example": "/script?limit=25&page=11" }, "next": { - "example": "/scheduled-task?limit=25&page=4" + "example": "/script?limit=25&page=4" }, "prev": { - "example": "/scheduled-task?limit=25&page=2" + "example": "/script?limit=25&page=2" } } } @@ -42293,7 +42293,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42308,11 +42308,11 @@ }, "post": { "tags": [ - "Scheduled Task" + "Script" ], - "summary": "Create a new Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createScheduledTask", + "summary": "Create a new Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createScript", "parameters": [ { "name": "_response", @@ -42334,7 +42334,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" }, "included": { "type": "array", @@ -42348,14 +42348,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -42367,7 +42367,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42376,7 +42376,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42390,19 +42390,19 @@ } } }, - "/scheduled-task/{id}": { + "/script/{id}": { "get": { "tags": [ - "Scheduled Task" + "Script" ], - "summary": "Detailed information about a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", + "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 scheduled_task", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -42412,7 +42412,7 @@ ], "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -42424,7 +42424,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42433,7 +42433,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42448,16 +42448,16 @@ }, "delete": { "tags": [ - "Scheduled Task" + "Script" ], - "summary": "Delete a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteScheduledTask", + "summary": "Delete a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -42488,16 +42488,16 @@ }, "patch": { "tags": [ - "Scheduled Task" + "Script" ], - "summary": "Partially update information about a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateScheduledTask", + "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 scheduled_task", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -42515,14 +42515,14 @@ } ], "requestBody": { - "description": "Partially update information about a Scheduled Task resource.", + "description": "Partially update information about a Script resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" }, "included": { "type": "array", @@ -42536,14 +42536,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -42555,7 +42555,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42564,7 +42564,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Script" } } } @@ -42581,14 +42581,14 @@ } } }, - "/script": { + "/seo-url": { "get": { "tags": [ - "Script" + "Seo Url" ], - "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 resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrlList", "parameters": [ { "name": "limit", @@ -42617,7 +42617,7 @@ ], "responses": { "200": { - "description": "List of Script resources.", + "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { @@ -42636,7 +42636,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } ] @@ -42650,16 +42650,16 @@ "type": "object", "properties": { "first": { - "example": "/script?limit=25" + "example": "/seo-url?limit=25" }, "last": { - "example": "/script?limit=25&page=11" + "example": "/seo-url?limit=25&page=11" }, "next": { - "example": "/script?limit=25&page=4" + "example": "/seo-url?limit=25&page=4" }, "prev": { - "example": "/script?limit=25&page=2" + "example": "/seo-url?limit=25&page=2" } } } @@ -42680,7 +42680,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42695,11 +42695,11 @@ }, "post": { "tags": [ - "Script" + "Seo Url" ], - "summary": "Create a new Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createScript", + "summary": "Create a new Seo Url resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSeoUrl", "parameters": [ { "name": "_response", @@ -42721,7 +42721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" }, "included": { "type": "array", @@ -42735,14 +42735,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -42754,7 +42754,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42763,7 +42763,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42777,19 +42777,19 @@ } } }, - "/script/{id}": { + "/seo-url/{id}": { "get": { "tags": [ - "Script" + "Seo Url" ], - "summary": "Detailed information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getScript", + "summary": "Detailed information about a Seo Url resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -42799,7 +42799,7 @@ ], "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -42811,7 +42811,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42820,7 +42820,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42835,16 +42835,16 @@ }, "delete": { "tags": [ - "Script" + "Seo Url" ], - "summary": "Delete a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteScript", + "summary": "Delete a Seo Url resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -42875,16 +42875,16 @@ }, "patch": { "tags": [ - "Script" + "Seo Url" ], - "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 resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -42902,14 +42902,14 @@ } ], "requestBody": { - "description": "Partially update information about a Script resource.", + "description": "Partially update information about a Seo Url resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" }, "included": { "type": "array", @@ -42923,14 +42923,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -42942,7 +42942,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42951,7 +42951,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -42968,14 +42968,14 @@ } } }, - "/seo-url": { + "/seo-url-template": { "get": { "tags": [ - "Seo Url" + "Seo Url Template" ], - "summary": "List with basic information of Seo Url resources.", + "summary": "List with basic information of Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlList", + "operationId": "getSeoUrlTemplateList", "parameters": [ { "name": "limit", @@ -43004,7 +43004,7 @@ ], "responses": { "200": { - "description": "List of Seo Url resources.", + "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43023,7 +43023,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } ] @@ -43037,16 +43037,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url?limit=25" + "example": "/seo-url-template?limit=25" }, "last": { - "example": "/seo-url?limit=25&page=11" + "example": "/seo-url-template?limit=25&page=11" }, "next": { - "example": "/seo-url?limit=25&page=4" + "example": "/seo-url-template?limit=25&page=4" }, "prev": { - "example": "/seo-url?limit=25&page=2" + "example": "/seo-url-template?limit=25&page=2" } } } @@ -43067,7 +43067,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43082,11 +43082,11 @@ }, "post": { "tags": [ - "Seo Url" + "Seo Url Template" ], - "summary": "Create a new Seo Url resources.", + "summary": "Create a new Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrl", + "operationId": "createSeoUrlTemplate", "parameters": [ { "name": "_response", @@ -43108,7 +43108,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" }, "included": { "type": "array", @@ -43122,14 +43122,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -43141,7 +43141,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43150,7 +43150,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43164,19 +43164,19 @@ } } }, - "/seo-url/{id}": { + "/seo-url-template/{id}": { "get": { "tags": [ - "Seo Url" + "Seo Url Template" ], - "summary": "Detailed information about a Seo Url resource.", + "summary": "Detailed information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrl", + "operationId": "getSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -43186,7 +43186,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -43198,7 +43198,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43207,7 +43207,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43222,16 +43222,16 @@ }, "delete": { "tags": [ - "Seo Url" + "Seo Url Template" ], - "summary": "Delete a Seo Url resource.", + "summary": "Delete a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrl", + "operationId": "deleteSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -43262,16 +43262,16 @@ }, "patch": { "tags": [ - "Seo Url" + "Seo Url Template" ], - "summary": "Partially update information about a Seo Url resource.", + "summary": "Partially update information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrl", + "operationId": "updateSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -43289,14 +43289,14 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url resource.", + "description": "Partially update information about a Seo Url Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" }, "included": { "type": "array", @@ -43310,14 +43310,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -43329,7 +43329,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43338,7 +43338,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43355,14 +43355,14 @@ } } }, - "/seo-url-template": { + "/shipping-method": { "get": { "tags": [ - "Seo Url Template" + "Shipping Method" ], - "summary": "List with basic information of Seo Url Template resources.", + "summary": "List with basic information of Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplateList", + "operationId": "getShippingMethodList", "parameters": [ { "name": "limit", @@ -43391,7 +43391,7 @@ ], "responses": { "200": { - "description": "List of Seo Url Template resources.", + "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43410,7 +43410,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } ] @@ -43424,16 +43424,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url-template?limit=25" + "example": "/shipping-method?limit=25" }, "last": { - "example": "/seo-url-template?limit=25&page=11" + "example": "/shipping-method?limit=25&page=11" }, "next": { - "example": "/seo-url-template?limit=25&page=4" + "example": "/shipping-method?limit=25&page=4" }, "prev": { - "example": "/seo-url-template?limit=25&page=2" + "example": "/shipping-method?limit=25&page=2" } } } @@ -43454,7 +43454,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43469,11 +43469,11 @@ }, "post": { "tags": [ - "Seo Url Template" + "Shipping Method" ], - "summary": "Create a new Seo Url Template resources.", + "summary": "Create a new Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrlTemplate", + "operationId": "createShippingMethod", "parameters": [ { "name": "_response", @@ -43495,7 +43495,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" }, "included": { "type": "array", @@ -43509,14 +43509,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -43528,7 +43528,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43537,7 +43537,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43551,19 +43551,19 @@ } } }, - "/seo-url-template/{id}": { + "/shipping-method/{id}": { "get": { "tags": [ - "Seo Url Template" + "Shipping Method" ], - "summary": "Detailed information about a Seo Url Template resource.", + "summary": "Detailed information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplate", + "operationId": "getShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -43573,7 +43573,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -43585,7 +43585,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43594,7 +43594,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43609,16 +43609,16 @@ }, "delete": { "tags": [ - "Seo Url Template" + "Shipping Method" ], - "summary": "Delete a Seo Url Template resource.", + "summary": "Delete a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrlTemplate", + "operationId": "deleteShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -43649,16 +43649,16 @@ }, "patch": { "tags": [ - "Seo Url Template" + "Shipping Method" ], - "summary": "Partially update information about a Seo Url Template resource.", + "summary": "Partially update information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrlTemplate", + "operationId": "updateShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -43676,14 +43676,14 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url Template resource.", + "description": "Partially update information about a Shipping Method resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" }, "included": { "type": "array", @@ -43697,14 +43697,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -43716,7 +43716,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43725,7 +43725,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43742,14 +43742,14 @@ } } }, - "/shipping-method": { + "/shipping-method-price": { "get": { "tags": [ - "Shipping Method" + "Shipping Method Price" ], - "summary": "List with basic information of Shipping Method resources.", + "summary": "List with basic information of Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodList", + "operationId": "getShippingMethodPriceList", "parameters": [ { "name": "limit", @@ -43778,7 +43778,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method resources.", + "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43797,7 +43797,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } ] @@ -43811,16 +43811,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method?limit=25" + "example": "/shipping-method-price?limit=25" }, "last": { - "example": "/shipping-method?limit=25&page=11" + "example": "/shipping-method-price?limit=25&page=11" }, "next": { - "example": "/shipping-method?limit=25&page=4" + "example": "/shipping-method-price?limit=25&page=4" }, "prev": { - "example": "/shipping-method?limit=25&page=2" + "example": "/shipping-method-price?limit=25&page=2" } } } @@ -43841,7 +43841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -43856,11 +43856,11 @@ }, "post": { "tags": [ - "Shipping Method" + "Shipping Method Price" ], - "summary": "Create a new Shipping Method resources.", + "summary": "Create a new Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethod", + "operationId": "createShippingMethodPrice", "parameters": [ { "name": "_response", @@ -43882,7 +43882,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" }, "included": { "type": "array", @@ -43896,14 +43896,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -43915,7 +43915,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -43924,7 +43924,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -43938,19 +43938,19 @@ } } }, - "/shipping-method/{id}": { + "/shipping-method-price/{id}": { "get": { "tags": [ - "Shipping Method" + "Shipping Method Price" ], - "summary": "Detailed information about a Shipping Method resource.", + "summary": "Detailed information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethod", + "operationId": "getShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -43960,7 +43960,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -43972,7 +43972,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -43981,7 +43981,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -43996,16 +43996,16 @@ }, "delete": { "tags": [ - "Shipping Method" + "Shipping Method Price" ], - "summary": "Delete a Shipping Method resource.", + "summary": "Delete a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethod", + "operationId": "deleteShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -44036,16 +44036,16 @@ }, "patch": { "tags": [ - "Shipping Method" + "Shipping Method Price" ], - "summary": "Partially update information about a Shipping Method resource.", + "summary": "Partially update information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethod", + "operationId": "updateShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -44063,14 +44063,14 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method resource.", + "description": "Partially update information about a Shipping Method Price resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" }, "included": { "type": "array", @@ -44084,14 +44084,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -44103,7 +44103,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -44112,7 +44112,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -44129,14 +44129,14 @@ } } }, - "/shipping-method-price": { + "/snippet": { "get": { "tags": [ - "Shipping Method Price" + "Snippet" ], - "summary": "List with basic information of Shipping Method Price resources.", + "summary": "List with basic information of Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPriceList", + "operationId": "getSnippetList", "parameters": [ { "name": "limit", @@ -44165,7 +44165,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method Price resources.", + "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44184,7 +44184,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } ] @@ -44198,16 +44198,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method-price?limit=25" + "example": "/snippet?limit=25" }, "last": { - "example": "/shipping-method-price?limit=25&page=11" + "example": "/snippet?limit=25&page=11" }, "next": { - "example": "/shipping-method-price?limit=25&page=4" + "example": "/snippet?limit=25&page=4" }, "prev": { - "example": "/shipping-method-price?limit=25&page=2" + "example": "/snippet?limit=25&page=2" } } } @@ -44228,7 +44228,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44243,11 +44243,11 @@ }, "post": { "tags": [ - "Shipping Method Price" + "Snippet" ], - "summary": "Create a new Shipping Method Price resources.", + "summary": "Create a new Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethodPrice", + "operationId": "createSnippet", "parameters": [ { "name": "_response", @@ -44269,7 +44269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" }, "included": { "type": "array", @@ -44283,14 +44283,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -44302,7 +44302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44311,7 +44311,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44325,19 +44325,19 @@ } } }, - "/shipping-method-price/{id}": { + "/snippet/{id}": { "get": { "tags": [ - "Shipping Method Price" + "Snippet" ], - "summary": "Detailed information about a Shipping Method Price resource.", + "summary": "Detailed information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPrice", + "operationId": "getSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -44347,7 +44347,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -44359,7 +44359,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44368,7 +44368,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44383,16 +44383,16 @@ }, "delete": { "tags": [ - "Shipping Method Price" + "Snippet" ], - "summary": "Delete a Shipping Method Price resource.", + "summary": "Delete a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethodPrice", + "operationId": "deleteSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -44423,16 +44423,16 @@ }, "patch": { "tags": [ - "Shipping Method Price" + "Snippet" ], - "summary": "Partially update information about a Shipping Method Price resource.", + "summary": "Partially update information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethodPrice", + "operationId": "updateSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -44450,14 +44450,14 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method Price resource.", + "description": "Partially update information about a Snippet resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" }, "included": { "type": "array", @@ -44471,14 +44471,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -44490,7 +44490,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44499,7 +44499,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Snippet" } } } @@ -44516,14 +44516,14 @@ } } }, - "/snippet": { + "/snippet-set": { "get": { "tags": [ - "Snippet" + "Snippet Set" ], - "summary": "List with basic information of Snippet resources.", + "summary": "List with basic information of Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetList", + "operationId": "getSnippetSetList", "parameters": [ { "name": "limit", @@ -44552,7 +44552,7 @@ ], "responses": { "200": { - "description": "List of Snippet resources.", + "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44571,7 +44571,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } ] @@ -44585,16 +44585,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet?limit=25" + "example": "/snippet-set?limit=25" }, "last": { - "example": "/snippet?limit=25&page=11" + "example": "/snippet-set?limit=25&page=11" }, "next": { - "example": "/snippet?limit=25&page=4" + "example": "/snippet-set?limit=25&page=4" }, "prev": { - "example": "/snippet?limit=25&page=2" + "example": "/snippet-set?limit=25&page=2" } } } @@ -44615,7 +44615,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44630,11 +44630,11 @@ }, "post": { "tags": [ - "Snippet" + "Snippet Set" ], - "summary": "Create a new Snippet resources.", + "summary": "Create a new Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippet", + "operationId": "createSnippetSet", "parameters": [ { "name": "_response", @@ -44656,7 +44656,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" }, "included": { "type": "array", @@ -44670,14 +44670,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -44689,7 +44689,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44698,7 +44698,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44712,19 +44712,19 @@ } } }, - "/snippet/{id}": { + "/snippet-set/{id}": { "get": { "tags": [ - "Snippet" + "Snippet Set" ], - "summary": "Detailed information about a Snippet resource.", + "summary": "Detailed information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", + "operationId": "getSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -44734,7 +44734,7 @@ ], "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -44746,7 +44746,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44755,7 +44755,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44770,16 +44770,16 @@ }, "delete": { "tags": [ - "Snippet" + "Snippet Set" ], - "summary": "Delete a Snippet resource.", + "summary": "Delete a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", + "operationId": "deleteSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -44810,16 +44810,16 @@ }, "patch": { "tags": [ - "Snippet" + "Snippet Set" ], - "summary": "Partially update information about a Snippet resource.", + "summary": "Partially update information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", + "operationId": "updateSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -44837,14 +44837,14 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet resource.", + "description": "Partially update information about a Snippet Set resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" }, "included": { "type": "array", @@ -44858,14 +44858,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -44877,7 +44877,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44886,7 +44886,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -44903,14 +44903,14 @@ } } }, - "/snippet-set": { + "/state-machine": { "get": { "tags": [ - "Snippet Set" + "State Machine" ], - "summary": "List with basic information of Snippet Set resources.", + "summary": "List with basic information of State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSetList", + "operationId": "getStateMachineList", "parameters": [ { "name": "limit", @@ -44939,7 +44939,7 @@ ], "responses": { "200": { - "description": "List of Snippet Set resources.", + "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44958,7 +44958,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } ] @@ -44972,16 +44972,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet-set?limit=25" + "example": "/state-machine?limit=25" }, "last": { - "example": "/snippet-set?limit=25&page=11" + "example": "/state-machine?limit=25&page=11" }, "next": { - "example": "/snippet-set?limit=25&page=4" + "example": "/state-machine?limit=25&page=4" }, "prev": { - "example": "/snippet-set?limit=25&page=2" + "example": "/state-machine?limit=25&page=2" } } } @@ -45002,7 +45002,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45017,11 +45017,11 @@ }, "post": { "tags": [ - "Snippet Set" + "State Machine" ], - "summary": "Create a new Snippet Set resources.", + "summary": "Create a new State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippetSet", + "operationId": "createStateMachine", "parameters": [ { "name": "_response", @@ -45043,7 +45043,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" }, "included": { "type": "array", @@ -45057,14 +45057,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -45076,7 +45076,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45085,7 +45085,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45099,19 +45099,19 @@ } } }, - "/snippet-set/{id}": { + "/state-machine/{id}": { "get": { "tags": [ - "Snippet Set" + "State Machine" ], - "summary": "Detailed information about a Snippet Set resource.", + "summary": "Detailed information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSet", + "operationId": "getStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -45121,7 +45121,7 @@ ], "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -45133,7 +45133,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45142,7 +45142,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45157,16 +45157,16 @@ }, "delete": { "tags": [ - "Snippet Set" + "State Machine" ], - "summary": "Delete a Snippet Set resource.", + "summary": "Delete a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippetSet", + "operationId": "deleteStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -45197,16 +45197,16 @@ }, "patch": { "tags": [ - "Snippet Set" + "State Machine" ], - "summary": "Partially update information about a Snippet Set resource.", + "summary": "Partially update information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippetSet", + "operationId": "updateStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -45224,14 +45224,14 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet Set resource.", + "description": "Partially update information about a State Machine resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" }, "included": { "type": "array", @@ -45245,14 +45245,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -45264,7 +45264,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45273,7 +45273,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45290,14 +45290,14 @@ } } }, - "/state-machine": { + "/state-machine-history": { "get": { "tags": [ - "State Machine" + "State Machine History" ], - "summary": "List with basic information of State Machine resources.", + "summary": "List with basic information of State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineList", + "operationId": "getStateMachineHistoryList", "parameters": [ { "name": "limit", @@ -45326,7 +45326,7 @@ ], "responses": { "200": { - "description": "List of State Machine resources.", + "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { @@ -45345,7 +45345,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } ] @@ -45359,16 +45359,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine?limit=25" + "example": "/state-machine-history?limit=25" }, "last": { - "example": "/state-machine?limit=25&page=11" + "example": "/state-machine-history?limit=25&page=11" }, "next": { - "example": "/state-machine?limit=25&page=4" + "example": "/state-machine-history?limit=25&page=4" }, "prev": { - "example": "/state-machine?limit=25&page=2" + "example": "/state-machine-history?limit=25&page=2" } } } @@ -45389,7 +45389,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45404,11 +45404,11 @@ }, "post": { "tags": [ - "State Machine" + "State Machine History" ], - "summary": "Create a new State Machine resources.", + "summary": "Create a new State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachine", + "operationId": "createStateMachineHistory", "parameters": [ { "name": "_response", @@ -45430,7 +45430,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" }, "included": { "type": "array", @@ -45444,14 +45444,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -45463,7 +45463,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45472,7 +45472,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45486,19 +45486,19 @@ } } }, - "/state-machine/{id}": { + "/state-machine-history/{id}": { "get": { "tags": [ - "State Machine" + "State Machine History" ], - "summary": "Detailed information about a State Machine resource.", + "summary": "Detailed information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachine", + "operationId": "getStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -45508,7 +45508,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -45520,7 +45520,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45529,7 +45529,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45544,16 +45544,16 @@ }, "delete": { "tags": [ - "State Machine" + "State Machine History" ], - "summary": "Delete a State Machine resource.", + "summary": "Delete a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachine", + "operationId": "deleteStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -45584,16 +45584,16 @@ }, "patch": { "tags": [ - "State Machine" + "State Machine History" ], - "summary": "Partially update information about a State Machine resource.", + "summary": "Partially update information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachine", + "operationId": "updateStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -45611,14 +45611,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine resource.", + "description": "Partially update information about a State Machine History resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" }, "included": { "type": "array", @@ -45632,14 +45632,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -45651,7 +45651,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45660,7 +45660,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45677,14 +45677,14 @@ } } }, - "/state-machine-history": { + "/state-machine-state": { "get": { "tags": [ - "State Machine History" + "State Machine State" ], - "summary": "List with basic information of State Machine History resources.", + "summary": "List with basic information of State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistoryList", + "operationId": "getStateMachineStateList", "parameters": [ { "name": "limit", @@ -45713,7 +45713,7 @@ ], "responses": { "200": { - "description": "List of State Machine History resources.", + "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -45732,7 +45732,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } ] @@ -45746,16 +45746,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-history?limit=25" + "example": "/state-machine-state?limit=25" }, "last": { - "example": "/state-machine-history?limit=25&page=11" + "example": "/state-machine-state?limit=25&page=11" }, "next": { - "example": "/state-machine-history?limit=25&page=4" + "example": "/state-machine-state?limit=25&page=4" }, "prev": { - "example": "/state-machine-history?limit=25&page=2" + "example": "/state-machine-state?limit=25&page=2" } } } @@ -45776,7 +45776,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -45791,11 +45791,11 @@ }, "post": { "tags": [ - "State Machine History" + "State Machine State" ], - "summary": "Create a new State Machine History resources.", + "summary": "Create a new State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineHistory", + "operationId": "createStateMachineState", "parameters": [ { "name": "_response", @@ -45817,7 +45817,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" }, "included": { "type": "array", @@ -45831,14 +45831,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -45850,7 +45850,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -45859,7 +45859,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -45873,19 +45873,19 @@ } } }, - "/state-machine-history/{id}": { + "/state-machine-state/{id}": { "get": { "tags": [ - "State Machine History" + "State Machine State" ], - "summary": "Detailed information about a State Machine History resource.", + "summary": "Detailed information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", + "operationId": "getStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -45895,7 +45895,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -45907,7 +45907,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -45916,7 +45916,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -45931,16 +45931,16 @@ }, "delete": { "tags": [ - "State Machine History" + "State Machine State" ], - "summary": "Delete a State Machine History resource.", + "summary": "Delete a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", + "operationId": "deleteStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -45971,16 +45971,16 @@ }, "patch": { "tags": [ - "State Machine History" + "State Machine State" ], - "summary": "Partially update information about a State Machine History resource.", + "summary": "Partially update information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", + "operationId": "updateStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -45998,14 +45998,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine History resource.", + "description": "Partially update information about a State Machine State resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" }, "included": { "type": "array", @@ -46019,14 +46019,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -46038,7 +46038,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -46047,7 +46047,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -46064,14 +46064,14 @@ } } }, - "/state-machine-state": { + "/state-machine-transition": { "get": { "tags": [ - "State Machine State" + "State Machine Transition" ], - "summary": "List with basic information of State Machine State resources.", + "summary": "List with basic information of State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineStateList", + "operationId": "getStateMachineTransitionList", "parameters": [ { "name": "limit", @@ -46100,7 +46100,7 @@ ], "responses": { "200": { - "description": "List of State Machine State resources.", + "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46119,7 +46119,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } ] @@ -46133,16 +46133,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-state?limit=25" + "example": "/state-machine-transition?limit=25" }, "last": { - "example": "/state-machine-state?limit=25&page=11" + "example": "/state-machine-transition?limit=25&page=11" }, "next": { - "example": "/state-machine-state?limit=25&page=4" + "example": "/state-machine-transition?limit=25&page=4" }, "prev": { - "example": "/state-machine-state?limit=25&page=2" + "example": "/state-machine-transition?limit=25&page=2" } } } @@ -46163,7 +46163,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46178,11 +46178,11 @@ }, "post": { "tags": [ - "State Machine State" + "State Machine Transition" ], - "summary": "Create a new State Machine State resources.", + "summary": "Create a new State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineState", + "operationId": "createStateMachineTransition", "parameters": [ { "name": "_response", @@ -46204,7 +46204,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" }, "included": { "type": "array", @@ -46218,14 +46218,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -46237,7 +46237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46246,7 +46246,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46260,19 +46260,19 @@ } } }, - "/state-machine-state/{id}": { + "/state-machine-transition/{id}": { "get": { "tags": [ - "State Machine State" + "State Machine Transition" ], - "summary": "Detailed information about a State Machine State resource.", + "summary": "Detailed information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineState", + "operationId": "getStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -46282,7 +46282,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -46294,7 +46294,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46303,7 +46303,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46318,16 +46318,16 @@ }, "delete": { "tags": [ - "State Machine State" + "State Machine Transition" ], - "summary": "Delete a State Machine State resource.", + "summary": "Delete a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineState", + "operationId": "deleteStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -46358,16 +46358,16 @@ }, "patch": { "tags": [ - "State Machine State" + "State Machine Transition" ], - "summary": "Partially update information about a State Machine State resource.", + "summary": "Partially update information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineState", + "operationId": "updateStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -46385,14 +46385,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine State resource.", + "description": "Partially update information about a State Machine Transition resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" }, "included": { "type": "array", @@ -46406,14 +46406,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -46425,7 +46425,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46434,7 +46434,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46451,14 +46451,14 @@ } } }, - "/state-machine-transition": { + "/system-config": { "get": { "tags": [ - "State Machine Transition" + "System Config" ], - "summary": "List with basic information of State Machine Transition resources.", + "summary": "List with basic information of System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransitionList", + "operationId": "getSystemConfigList", "parameters": [ { "name": "limit", @@ -46487,7 +46487,7 @@ ], "responses": { "200": { - "description": "List of State Machine Transition resources.", + "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46506,7 +46506,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } ] @@ -46520,16 +46520,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-transition?limit=25" + "example": "/system-config?limit=25" }, "last": { - "example": "/state-machine-transition?limit=25&page=11" + "example": "/system-config?limit=25&page=11" }, "next": { - "example": "/state-machine-transition?limit=25&page=4" + "example": "/system-config?limit=25&page=4" }, "prev": { - "example": "/state-machine-transition?limit=25&page=2" + "example": "/system-config?limit=25&page=2" } } } @@ -46550,7 +46550,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46565,11 +46565,11 @@ }, "post": { "tags": [ - "State Machine Transition" + "System Config" ], - "summary": "Create a new State Machine Transition resources.", + "summary": "Create a new System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineTransition", + "operationId": "createSystemConfig", "parameters": [ { "name": "_response", @@ -46591,7 +46591,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" }, "included": { "type": "array", @@ -46605,14 +46605,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -46624,7 +46624,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46633,7 +46633,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46647,19 +46647,19 @@ } } }, - "/state-machine-transition/{id}": { + "/system-config/{id}": { "get": { "tags": [ - "State Machine Transition" + "System Config" ], - "summary": "Detailed information about a State Machine Transition resource.", + "summary": "Detailed information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransition", + "operationId": "getSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -46669,7 +46669,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -46681,7 +46681,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46690,7 +46690,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46705,16 +46705,16 @@ }, "delete": { "tags": [ - "State Machine Transition" + "System Config" ], - "summary": "Delete a State Machine Transition resource.", + "summary": "Delete a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineTransition", + "operationId": "deleteSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -46745,16 +46745,16 @@ }, "patch": { "tags": [ - "State Machine Transition" + "System Config" ], - "summary": "Partially update information about a State Machine Transition resource.", + "summary": "Partially update information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineTransition", + "operationId": "updateSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -46772,14 +46772,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine Transition resource.", + "description": "Partially update information about a System Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" }, "included": { "type": "array", @@ -46793,14 +46793,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -46812,7 +46812,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46821,7 +46821,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46838,14 +46838,14 @@ } } }, - "/system-config": { + "/tag": { "get": { "tags": [ - "System Config" + "Tag" ], - "summary": "List with basic information of System Config resources.", + "summary": "List with basic information of Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfigList", + "operationId": "getTagList", "parameters": [ { "name": "limit", @@ -46874,7 +46874,7 @@ ], "responses": { "200": { - "description": "List of System Config resources.", + "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46893,7 +46893,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } ] @@ -46907,16 +46907,16 @@ "type": "object", "properties": { "first": { - "example": "/system-config?limit=25" + "example": "/tag?limit=25" }, "last": { - "example": "/system-config?limit=25&page=11" + "example": "/tag?limit=25&page=11" }, "next": { - "example": "/system-config?limit=25&page=4" + "example": "/tag?limit=25&page=4" }, "prev": { - "example": "/system-config?limit=25&page=2" + "example": "/tag?limit=25&page=2" } } } @@ -46937,7 +46937,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -46952,11 +46952,11 @@ }, "post": { "tags": [ - "System Config" + "Tag" ], - "summary": "Create a new System Config resources.", + "summary": "Create a new Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSystemConfig", + "operationId": "createTag", "parameters": [ { "name": "_response", @@ -46978,7 +46978,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" }, "included": { "type": "array", @@ -46992,14 +46992,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -47011,7 +47011,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -47020,7 +47020,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -47034,19 +47034,19 @@ } } }, - "/system-config/{id}": { + "/tag/{id}": { "get": { "tags": [ - "System Config" + "Tag" ], - "summary": "Detailed information about a System Config resource.", + "summary": "Detailed information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", + "operationId": "getTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -47056,7 +47056,7 @@ ], "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -47068,7 +47068,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -47077,7 +47077,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -47092,16 +47092,16 @@ }, "delete": { "tags": [ - "System Config" + "Tag" ], - "summary": "Delete a System Config resource.", + "summary": "Delete a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", + "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -47132,16 +47132,16 @@ }, "patch": { "tags": [ - "System Config" + "Tag" ], - "summary": "Partially update information about a System Config resource.", + "summary": "Partially update information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", + "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -47159,14 +47159,14 @@ } ], "requestBody": { - "description": "Partially update information about a System Config resource.", + "description": "Partially update information about a Tag resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" }, "included": { "type": "array", @@ -47180,14 +47180,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -47199,7 +47199,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -47208,7 +47208,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/Tag" } } } @@ -47225,14 +47225,14 @@ } } }, - "/tag": { + "/tax": { "get": { "tags": [ - "Tag" + "Tax" ], - "summary": "List with basic information of Tag resources.", + "summary": "List with basic information of Tax resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTagList", + "operationId": "getTaxList", "parameters": [ { "name": "limit", @@ -47261,7 +47261,7 @@ ], "responses": { "200": { - "description": "List of Tag resources.", + "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { @@ -47280,7 +47280,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } ] @@ -47294,16 +47294,16 @@ "type": "object", "properties": { "first": { - "example": "/tag?limit=25" + "example": "/tax?limit=25" }, "last": { - "example": "/tag?limit=25&page=11" + "example": "/tax?limit=25&page=11" }, "next": { - "example": "/tag?limit=25&page=4" + "example": "/tax?limit=25&page=4" }, "prev": { - "example": "/tag?limit=25&page=2" + "example": "/tax?limit=25&page=2" } } } @@ -47324,7 +47324,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47339,11 +47339,11 @@ }, "post": { "tags": [ - "Tag" + "Tax" ], - "summary": "Create a new Tag resources.", + "summary": "Create a new Tax resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTag", + "operationId": "createTax", "parameters": [ { "name": "_response", @@ -47365,7 +47365,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" }, "included": { "type": "array", @@ -47379,14 +47379,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -47398,7 +47398,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47407,7 +47407,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47421,19 +47421,19 @@ } } }, - "/tag/{id}": { + "/tax/{id}": { "get": { "tags": [ - "Tag" + "Tax" ], - "summary": "Detailed information about a Tag resource.", + "summary": "Detailed information about a Tax resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTag", + "operationId": "getTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -47443,7 +47443,7 @@ ], "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -47455,7 +47455,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47464,7 +47464,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47479,16 +47479,16 @@ }, "delete": { "tags": [ - "Tag" + "Tax" ], - "summary": "Delete a Tag resource.", + "summary": "Delete a Tax resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTag", + "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -47519,16 +47519,16 @@ }, "patch": { "tags": [ - "Tag" + "Tax" ], - "summary": "Partially update information about a Tag resource.", + "summary": "Partially update information about a Tax resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTag", + "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -47546,14 +47546,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tag resource.", + "description": "Partially update information about a Tax resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" }, "included": { "type": "array", @@ -47567,14 +47567,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -47586,7 +47586,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47595,7 +47595,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Tax" } } } @@ -47612,14 +47612,14 @@ } } }, - "/tax": { + "/tax-provider": { "get": { "tags": [ - "Tax" + "Tax Provider" ], - "summary": "List with basic information of Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getTaxList", + "summary": "List with basic information of Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProviderList", "parameters": [ { "name": "limit", @@ -47648,7 +47648,7 @@ ], "responses": { "200": { - "description": "List of Tax resources.", + "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -47667,7 +47667,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } ] @@ -47681,16 +47681,16 @@ "type": "object", "properties": { "first": { - "example": "/tax?limit=25" + "example": "/tax-provider?limit=25" }, "last": { - "example": "/tax?limit=25&page=11" + "example": "/tax-provider?limit=25&page=11" }, "next": { - "example": "/tax?limit=25&page=4" + "example": "/tax-provider?limit=25&page=4" }, "prev": { - "example": "/tax?limit=25&page=2" + "example": "/tax-provider?limit=25&page=2" } } } @@ -47711,7 +47711,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47726,11 +47726,11 @@ }, "post": { "tags": [ - "Tax" + "Tax Provider" ], - "summary": "Create a new Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTax", + "summary": "Create a new Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "createTaxProvider", "parameters": [ { "name": "_response", @@ -47752,7 +47752,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" }, "included": { "type": "array", @@ -47766,14 +47766,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -47785,7 +47785,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47794,7 +47794,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47808,19 +47808,19 @@ } } }, - "/tax/{id}": { + "/tax-provider/{id}": { "get": { "tags": [ - "Tax" + "Tax Provider" ], - "summary": "Detailed information about a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTax", + "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 tax", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -47830,7 +47830,7 @@ ], "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -47842,7 +47842,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47851,7 +47851,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47866,16 +47866,16 @@ }, "delete": { "tags": [ - "Tax" + "Tax Provider" ], - "summary": "Delete a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTax", + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -47906,16 +47906,16 @@ }, "patch": { "tags": [ - "Tax" + "Tax Provider" ], - "summary": "Partially update information about a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTax", + "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 tax", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -47933,14 +47933,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax resource.", + "description": "Partially update information about a Tax Provider resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" }, "included": { "type": "array", @@ -47954,14 +47954,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -47973,7 +47973,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47982,7 +47982,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -47999,14 +47999,14 @@ } } }, - "/tax-provider": { + "/tax-rule": { "get": { "tags": [ - "Tax Provider" + "Tax Rule" ], - "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 resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleList", "parameters": [ { "name": "limit", @@ -48035,7 +48035,7 @@ ], "responses": { "200": { - "description": "List of Tax Provider resources.", + "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48054,7 +48054,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } ] @@ -48068,16 +48068,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-provider?limit=25" + "example": "/tax-rule?limit=25" }, "last": { - "example": "/tax-provider?limit=25&page=11" + "example": "/tax-rule?limit=25&page=11" }, "next": { - "example": "/tax-provider?limit=25&page=4" + "example": "/tax-rule?limit=25&page=4" }, "prev": { - "example": "/tax-provider?limit=25&page=2" + "example": "/tax-rule?limit=25&page=2" } } } @@ -48098,7 +48098,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48113,11 +48113,11 @@ }, "post": { "tags": [ - "Tax Provider" + "Tax Rule" ], - "summary": "Create a new Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "createTaxProvider", + "summary": "Create a new Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRule", "parameters": [ { "name": "_response", @@ -48139,7 +48139,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" }, "included": { "type": "array", @@ -48153,14 +48153,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -48172,7 +48172,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48181,7 +48181,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48195,19 +48195,19 @@ } } }, - "/tax-provider/{id}": { + "/tax-rule/{id}": { "get": { "tags": [ - "Tax Provider" + "Tax Rule" ], - "summary": "Detailed information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProvider", + "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_provider", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -48217,7 +48217,7 @@ ], "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -48229,7 +48229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48238,7 +48238,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48253,16 +48253,16 @@ }, "delete": { "tags": [ - "Tax Provider" + "Tax Rule" ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", + "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_provider", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -48293,16 +48293,16 @@ }, "patch": { "tags": [ - "Tax Provider" + "Tax Rule" ], - "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 resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -48320,14 +48320,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Provider resource.", + "description": "Partially update information about a Tax Rule resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" }, "included": { "type": "array", @@ -48341,14 +48341,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -48360,7 +48360,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48369,7 +48369,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48386,14 +48386,14 @@ } } }, - "/tax-rule": { + "/tax-rule-type": { "get": { "tags": [ - "Tax Rule" + "Tax Rule Type" ], - "summary": "List with basic information of Tax Rule resources.", + "summary": "List with basic information of Tax Rule Type resources.", "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleList", + "operationId": "getTaxRuleTypeList", "parameters": [ { "name": "limit", @@ -48422,7 +48422,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule resources.", + "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48441,7 +48441,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } ] @@ -48455,16 +48455,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule?limit=25" + "example": "/tax-rule-type?limit=25" }, "last": { - "example": "/tax-rule?limit=25&page=11" + "example": "/tax-rule-type?limit=25&page=11" }, "next": { - "example": "/tax-rule?limit=25&page=4" + "example": "/tax-rule-type?limit=25&page=4" }, "prev": { - "example": "/tax-rule?limit=25&page=2" + "example": "/tax-rule-type?limit=25&page=2" } } } @@ -48485,7 +48485,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48500,11 +48500,11 @@ }, "post": { "tags": [ - "Tax Rule" + "Tax Rule Type" ], - "summary": "Create a new Tax Rule resources.", + "summary": "Create a new Tax Rule Type resources.", "description": "Available since: 6.1.0.0", - "operationId": "createTaxRule", + "operationId": "createTaxRuleType", "parameters": [ { "name": "_response", @@ -48526,7 +48526,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" }, "included": { "type": "array", @@ -48540,14 +48540,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -48559,7 +48559,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48568,7 +48568,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48582,19 +48582,19 @@ } } }, - "/tax-rule/{id}": { + "/tax-rule-type/{id}": { "get": { "tags": [ - "Tax Rule" + "Tax Rule Type" ], - "summary": "Detailed information about a Tax Rule resource.", + "summary": "Detailed information about a Tax Rule Type resource.", "description": "Available since: 6.1.0.0", - "operationId": "getTaxRule", + "operationId": "getTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -48604,7 +48604,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -48616,7 +48616,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48625,7 +48625,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48640,16 +48640,16 @@ }, "delete": { "tags": [ - "Tax Rule" + "Tax Rule Type" ], - "summary": "Delete a Tax Rule resource.", + "summary": "Delete a Tax Rule Type resource.", "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRule", + "operationId": "deleteTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -48680,16 +48680,16 @@ }, "patch": { "tags": [ - "Tax Rule" + "Tax Rule Type" ], - "summary": "Partially update information about a Tax Rule resource.", + "summary": "Partially update information about a Tax Rule Type resource.", "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRule", + "operationId": "updateTaxRuleType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -48707,14 +48707,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule resource.", + "description": "Partially update information about a Tax Rule Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" }, "included": { "type": "array", @@ -48728,14 +48728,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -48747,7 +48747,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48756,7 +48756,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48773,14 +48773,14 @@ } } }, - "/tax-rule-type": { + "/theme": { "get": { "tags": [ - "Tax Rule Type" + "Theme" ], - "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 Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getThemeList", "parameters": [ { "name": "limit", @@ -48809,7 +48809,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule Type resources.", + "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48828,7 +48828,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } ] @@ -48842,16 +48842,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule-type?limit=25" + "example": "/theme?limit=25" }, "last": { - "example": "/tax-rule-type?limit=25&page=11" + "example": "/theme?limit=25&page=11" }, "next": { - "example": "/tax-rule-type?limit=25&page=4" + "example": "/theme?limit=25&page=4" }, "prev": { - "example": "/tax-rule-type?limit=25&page=2" + "example": "/theme?limit=25&page=2" } } } @@ -48872,7 +48872,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -48887,11 +48887,11 @@ }, "post": { "tags": [ - "Tax Rule Type" + "Theme" ], - "summary": "Create a new Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRuleType", + "summary": "Create a new Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTheme", "parameters": [ { "name": "_response", @@ -48913,7 +48913,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" }, "included": { "type": "array", @@ -48927,14 +48927,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -48946,7 +48946,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -48955,7 +48955,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -48969,19 +48969,19 @@ } } }, - "/tax-rule-type/{id}": { + "/theme/{id}": { "get": { "tags": [ - "Tax Rule Type" + "Theme" ], - "summary": "Detailed information about a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleType", + "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_type", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -48991,7 +48991,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -49003,7 +49003,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -49012,7 +49012,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -49027,16 +49027,16 @@ }, "delete": { "tags": [ - "Tax Rule Type" + "Theme" ], - "summary": "Delete a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRuleType", + "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_type", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -49067,16 +49067,16 @@ }, "patch": { "tags": [ - "Tax Rule Type" + "Theme" ], - "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 Theme resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -49094,14 +49094,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule Type resource.", + "description": "Partially update information about a Theme resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" }, "included": { "type": "array", @@ -49115,14 +49115,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -49134,7 +49134,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -49143,7 +49143,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/Theme" } } } @@ -49160,14 +49160,14 @@ } } }, - "/theme": { + "/unit": { "get": { "tags": [ - "Theme" + "Unit" ], - "summary": "List with basic information of Theme resources.", + "summary": "List with basic information of Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "getThemeList", + "operationId": "getUnitList", "parameters": [ { "name": "limit", @@ -49196,7 +49196,7 @@ ], "responses": { "200": { - "description": "List of Theme resources.", + "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49215,7 +49215,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } ] @@ -49229,16 +49229,16 @@ "type": "object", "properties": { "first": { - "example": "/theme?limit=25" + "example": "/unit?limit=25" }, "last": { - "example": "/theme?limit=25&page=11" + "example": "/unit?limit=25&page=11" }, "next": { - "example": "/theme?limit=25&page=4" + "example": "/unit?limit=25&page=4" }, "prev": { - "example": "/theme?limit=25&page=2" + "example": "/unit?limit=25&page=2" } } } @@ -49259,7 +49259,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49274,11 +49274,11 @@ }, "post": { "tags": [ - "Theme" + "Unit" ], - "summary": "Create a new Theme resources.", + "summary": "Create a new Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTheme", + "operationId": "createUnit", "parameters": [ { "name": "_response", @@ -49300,7 +49300,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" }, "included": { "type": "array", @@ -49314,14 +49314,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -49333,7 +49333,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49342,7 +49342,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49356,19 +49356,19 @@ } } }, - "/theme/{id}": { + "/unit/{id}": { "get": { "tags": [ - "Theme" + "Unit" ], - "summary": "Detailed information about a Theme resource.", + "summary": "Detailed information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTheme", + "operationId": "getUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -49378,7 +49378,7 @@ ], "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -49390,7 +49390,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49399,7 +49399,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49414,16 +49414,16 @@ }, "delete": { "tags": [ - "Theme" + "Unit" ], - "summary": "Delete a Theme resource.", + "summary": "Delete a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", + "operationId": "deleteUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -49454,16 +49454,16 @@ }, "patch": { "tags": [ - "Theme" + "Unit" ], - "summary": "Partially update information about a Theme resource.", + "summary": "Partially update information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTheme", + "operationId": "updateUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -49481,14 +49481,14 @@ } ], "requestBody": { - "description": "Partially update information about a Theme resource.", + "description": "Partially update information about a Unit resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" }, "included": { "type": "array", @@ -49502,14 +49502,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -49521,7 +49521,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49530,7 +49530,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/Unit" } } } @@ -49547,14 +49547,14 @@ } } }, - "/unit": { + "/user": { "get": { "tags": [ - "Unit" + "User" ], - "summary": "List with basic information of Unit resources.", + "summary": "List with basic information of User resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUnitList", + "operationId": "getUserList", "parameters": [ { "name": "limit", @@ -49583,7 +49583,7 @@ ], "responses": { "200": { - "description": "List of Unit resources.", + "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49602,7 +49602,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } ] @@ -49616,16 +49616,16 @@ "type": "object", "properties": { "first": { - "example": "/unit?limit=25" + "example": "/user?limit=25" }, "last": { - "example": "/unit?limit=25&page=11" + "example": "/user?limit=25&page=11" }, "next": { - "example": "/unit?limit=25&page=4" + "example": "/user?limit=25&page=4" }, "prev": { - "example": "/unit?limit=25&page=2" + "example": "/user?limit=25&page=2" } } } @@ -49646,7 +49646,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49661,11 +49661,11 @@ }, "post": { "tags": [ - "Unit" + "User" ], - "summary": "Create a new Unit resources.", + "summary": "Create a new User resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUnit", + "operationId": "createUser", "parameters": [ { "name": "_response", @@ -49687,7 +49687,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" }, "included": { "type": "array", @@ -49701,14 +49701,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -49720,7 +49720,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49729,7 +49729,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49743,19 +49743,19 @@ } } }, - "/unit/{id}": { + "/user/{id}": { "get": { "tags": [ - "Unit" + "User" ], - "summary": "Detailed information about a Unit resource.", + "summary": "Detailed information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUnit", + "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -49765,7 +49765,7 @@ ], "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -49777,7 +49777,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49786,7 +49786,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49801,16 +49801,16 @@ }, "delete": { "tags": [ - "Unit" + "User" ], - "summary": "Delete a Unit resource.", + "summary": "Delete a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUnit", + "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -49841,16 +49841,16 @@ }, "patch": { "tags": [ - "Unit" + "User" ], - "summary": "Partially update information about a Unit resource.", + "summary": "Partially update information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUnit", + "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -49868,14 +49868,14 @@ } ], "requestBody": { - "description": "Partially update information about a Unit resource.", + "description": "Partially update information about a User resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" }, "included": { "type": "array", @@ -49889,14 +49889,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -49908,7 +49908,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49917,7 +49917,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/User" } } } @@ -49934,14 +49934,14 @@ } } }, - "/user": { + "/user-access-key": { "get": { "tags": [ - "User" + "User Access Key" ], - "summary": "List with basic information of User resources.", + "summary": "List with basic information of User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserList", + "operationId": "getUserAccessKeyList", "parameters": [ { "name": "limit", @@ -49970,7 +49970,7 @@ ], "responses": { "200": { - "description": "List of User resources.", + "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49989,7 +49989,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } ] @@ -50003,16 +50003,16 @@ "type": "object", "properties": { "first": { - "example": "/user?limit=25" + "example": "/user-access-key?limit=25" }, "last": { - "example": "/user?limit=25&page=11" + "example": "/user-access-key?limit=25&page=11" }, "next": { - "example": "/user?limit=25&page=4" + "example": "/user-access-key?limit=25&page=4" }, "prev": { - "example": "/user?limit=25&page=2" + "example": "/user-access-key?limit=25&page=2" } } } @@ -50033,7 +50033,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50048,11 +50048,11 @@ }, "post": { "tags": [ - "User" + "User Access Key" ], - "summary": "Create a new User resources.", + "summary": "Create a new User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUser", + "operationId": "createUserAccessKey", "parameters": [ { "name": "_response", @@ -50074,7 +50074,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" }, "included": { "type": "array", @@ -50088,14 +50088,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -50107,7 +50107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50116,7 +50116,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50130,19 +50130,19 @@ } } }, - "/user/{id}": { + "/user-access-key/{id}": { "get": { "tags": [ - "User" + "User Access Key" ], - "summary": "Detailed information about a User resource.", + "summary": "Detailed information about a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUser", + "operationId": "getUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -50152,7 +50152,7 @@ ], "responses": { "200": { - "description": "Detail of User", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -50164,7 +50164,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50173,7 +50173,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50188,16 +50188,16 @@ }, "delete": { "tags": [ - "User" + "User Access Key" ], - "summary": "Delete a User resource.", + "summary": "Delete a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUser", + "operationId": "deleteUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -50228,16 +50228,16 @@ }, "patch": { "tags": [ - "User" + "User Access Key" ], - "summary": "Partially update information about a User resource.", + "summary": "Partially update information about a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUser", + "operationId": "updateUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -50255,14 +50255,14 @@ } ], "requestBody": { - "description": "Partially update information about a User resource.", + "description": "Partially update information about a User Access Key resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" }, "included": { "type": "array", @@ -50276,14 +50276,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -50295,7 +50295,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50304,7 +50304,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50321,14 +50321,14 @@ } } }, - "/user-access-key": { + "/user-config": { "get": { "tags": [ - "User Access Key" + "User Config" ], - "summary": "List with basic information of User Access Key resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKeyList", + "summary": "List with basic information of User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfigList", "parameters": [ { "name": "limit", @@ -50357,7 +50357,7 @@ ], "responses": { "200": { - "description": "List of User Access Key resources.", + "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -50376,7 +50376,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } ] @@ -50390,16 +50390,16 @@ "type": "object", "properties": { "first": { - "example": "/user-access-key?limit=25" + "example": "/user-config?limit=25" }, "last": { - "example": "/user-access-key?limit=25&page=11" + "example": "/user-config?limit=25&page=11" }, "next": { - "example": "/user-access-key?limit=25&page=4" + "example": "/user-config?limit=25&page=4" }, "prev": { - "example": "/user-access-key?limit=25&page=2" + "example": "/user-config?limit=25&page=2" } } } @@ -50420,7 +50420,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50435,11 +50435,11 @@ }, "post": { "tags": [ - "User Access Key" + "User Config" ], - "summary": "Create a new User Access Key resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserAccessKey", + "summary": "Create a new User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createUserConfig", "parameters": [ { "name": "_response", @@ -50461,7 +50461,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" }, "included": { "type": "array", @@ -50475,14 +50475,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -50494,7 +50494,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50503,7 +50503,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50517,19 +50517,19 @@ } } }, - "/user-access-key/{id}": { + "/user-config/{id}": { "get": { "tags": [ - "User Access Key" + "User Config" ], - "summary": "Detailed information about a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", + "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_access_key", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -50539,7 +50539,7 @@ ], "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -50551,7 +50551,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50560,7 +50560,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50575,16 +50575,16 @@ }, "delete": { "tags": [ - "User Access Key" + "User Config" ], - "summary": "Delete a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", + "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_access_key", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -50615,16 +50615,16 @@ }, "patch": { "tags": [ - "User Access Key" + "User Config" ], - "summary": "Partially update information about a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", + "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_access_key", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -50642,14 +50642,14 @@ } ], "requestBody": { - "description": "Partially update information about a User Access Key resource.", + "description": "Partially update information about a User Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" }, "included": { "type": "array", @@ -50663,14 +50663,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -50682,7 +50682,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50691,7 +50691,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50708,14 +50708,14 @@ } } }, - "/user-config": { + "/user-recovery": { "get": { "tags": [ - "User Config" + "User Recovery" ], - "summary": "List with basic information of User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfigList", + "summary": "List with basic information of User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecoveryList", "parameters": [ { "name": "limit", @@ -50744,7 +50744,7 @@ ], "responses": { "200": { - "description": "List of User Config resources.", + "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -50763,7 +50763,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } ] @@ -50777,16 +50777,16 @@ "type": "object", "properties": { "first": { - "example": "/user-config?limit=25" + "example": "/user-recovery?limit=25" }, "last": { - "example": "/user-config?limit=25&page=11" + "example": "/user-recovery?limit=25&page=11" }, "next": { - "example": "/user-config?limit=25&page=4" + "example": "/user-recovery?limit=25&page=4" }, "prev": { - "example": "/user-config?limit=25&page=2" + "example": "/user-recovery?limit=25&page=2" } } } @@ -50807,7 +50807,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -50822,11 +50822,11 @@ }, "post": { "tags": [ - "User Config" + "User Recovery" ], - "summary": "Create a new User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createUserConfig", + "summary": "Create a new User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserRecovery", "parameters": [ { "name": "_response", @@ -50848,7 +50848,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" }, "included": { "type": "array", @@ -50862,14 +50862,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -50881,7 +50881,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -50890,7 +50890,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -50904,19 +50904,19 @@ } } }, - "/user-config/{id}": { + "/user-recovery/{id}": { "get": { "tags": [ - "User Config" + "User Recovery" ], - "summary": "Detailed information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfig", + "summary": "Detailed information about a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -50926,7 +50926,7 @@ ], "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -50938,7 +50938,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -50947,7 +50947,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -50962,16 +50962,16 @@ }, "delete": { "tags": [ - "User Config" + "User Recovery" ], - "summary": "Delete a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteUserConfig", + "summary": "Delete a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -51002,16 +51002,16 @@ }, "patch": { "tags": [ - "User Config" + "User Recovery" ], - "summary": "Partially update information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateUserConfig", + "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_config", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -51029,14 +51029,14 @@ } ], "requestBody": { - "description": "Partially update information about a User Config resource.", + "description": "Partially update information about a User Recovery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" }, "included": { "type": "array", @@ -51050,14 +51050,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -51069,7 +51069,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -51078,7 +51078,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -51095,14 +51095,14 @@ } } }, - "/user-recovery": { + "/webhook": { "get": { "tags": [ - "User Recovery" + "Webhook" ], - "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 resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhookList", "parameters": [ { "name": "limit", @@ -51131,7 +51131,7 @@ ], "responses": { "200": { - "description": "List of User Recovery resources.", + "description": "List of Webhook resources.", "content": { "application/vnd.api+json": { "schema": { @@ -51150,7 +51150,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } ] @@ -51164,16 +51164,16 @@ "type": "object", "properties": { "first": { - "example": "/user-recovery?limit=25" + "example": "/webhook?limit=25" }, "last": { - "example": "/user-recovery?limit=25&page=11" + "example": "/webhook?limit=25&page=11" }, "next": { - "example": "/user-recovery?limit=25&page=4" + "example": "/webhook?limit=25&page=4" }, "prev": { - "example": "/user-recovery?limit=25&page=2" + "example": "/webhook?limit=25&page=2" } } } @@ -51194,7 +51194,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51209,11 +51209,11 @@ }, "post": { "tags": [ - "User Recovery" + "Webhook" ], - "summary": "Create a new User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserRecovery", + "summary": "Create a new Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createWebhook", "parameters": [ { "name": "_response", @@ -51235,7 +51235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" }, "included": { "type": "array", @@ -51249,14 +51249,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -51268,7 +51268,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51277,7 +51277,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51291,19 +51291,19 @@ } } }, - "/user-recovery/{id}": { + "/webhook/{id}": { "get": { "tags": [ - "User Recovery" + "Webhook" ], - "summary": "Detailed information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecovery", + "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_recovery", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -51313,7 +51313,7 @@ ], "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -51325,7 +51325,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51334,7 +51334,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51349,16 +51349,16 @@ }, "delete": { "tags": [ - "User Recovery" + "Webhook" ], - "summary": "Delete a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserRecovery", + "summary": "Delete a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -51389,16 +51389,16 @@ }, "patch": { "tags": [ - "User Recovery" + "Webhook" ], - "summary": "Partially update information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserRecovery", + "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_recovery", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -51416,14 +51416,14 @@ } ], "requestBody": { - "description": "Partially update information about a User Recovery resource.", + "description": "Partially update information about a Webhook resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" }, "included": { "type": "array", @@ -51437,14 +51437,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -51456,7 +51456,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51465,7 +51465,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/Webhook" } } } @@ -51482,14 +51482,14 @@ } } }, - "/webhook": { + "/webhook-event-log": { "get": { "tags": [ - "Webhook" + "Webhook Event Log" ], - "summary": "List with basic information of Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhookList", + "summary": "List with basic information of Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "getWebhookEventLogList", "parameters": [ { "name": "limit", @@ -51518,7 +51518,7 @@ ], "responses": { "200": { - "description": "List of Webhook resources.", + "description": "List of Webhook Event Log resources.", "content": { "application/vnd.api+json": { "schema": { @@ -51537,7 +51537,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } ] @@ -51551,16 +51551,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook?limit=25" + "example": "/webhook-event-log?limit=25" }, "last": { - "example": "/webhook?limit=25&page=11" + "example": "/webhook-event-log?limit=25&page=11" }, "next": { - "example": "/webhook?limit=25&page=4" + "example": "/webhook-event-log?limit=25&page=4" }, "prev": { - "example": "/webhook?limit=25&page=2" + "example": "/webhook-event-log?limit=25&page=2" } } } @@ -51581,7 +51581,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -51596,11 +51596,11 @@ }, "post": { "tags": [ - "Webhook" + "Webhook Event Log" ], - "summary": "Create a new Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createWebhook", + "summary": "Create a new Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "createWebhookEventLog", "parameters": [ { "name": "_response", @@ -51622,7 +51622,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" }, "included": { "type": "array", @@ -51636,14 +51636,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { @@ -51655,7 +51655,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -51664,7 +51664,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -51678,19 +51678,19 @@ } } }, - "/webhook/{id}": { + "/webhook-event-log/{id}": { "get": { "tags": [ - "Webhook" + "Webhook Event Log" ], - "summary": "Detailed information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhook", + "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", + "description": "Identifier for the webhook_event_log", "required": true, "schema": { "type": "string", @@ -51700,7 +51700,7 @@ ], "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { @@ -51712,7 +51712,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -51721,7 +51721,7 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WebhookEventLog" } } } @@ -51736,403 +51736,16 @@ }, "delete": { "tags": [ - "Webhook" + "Webhook Event Log" ], - "summary": "Delete a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteWebhook", + "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", - "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/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$ref": "#/components/schemas/Webhook" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "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/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$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": { - "$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", @@ -52346,6 +51959,21 @@ } } }, + "/usage-data/needs-approval": { + "delete": { + "tags": [ + "Usage data" + ], + "summary": "Get information about the usage data approval request.", + "description": "Get whether the usage data approval request is necessary or not.", + "operationId": "getNeedsUsageDataApprovalRequest", + "responses": { + "200": { + "description": "Returns true if it is needed, false if it is not." + } + } + } + }, "/_action/scheduled-task/run": { "post": { "tags": [ @@ -52742,7 +52370,7 @@ "System Operations" ], "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "description": "Dispachtes an product indexing message to the message bus, with the provided ids", "operationId": "productIndexing", "responses": { "204": { @@ -54854,37 +54482,6 @@ } }, "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" @@ -55092,12 +54689,6 @@ "items": { "$ref": "#/components/schemas/AppFlowEvent" } - }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } } }, "type": "object" @@ -56364,202 +55955,6 @@ }, "type": "object" }, - "AppShippingMethodJsonApi": { - "description": "Added since version: 6.5.7.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "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": [ - "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": [ @@ -60230,10 +59625,6 @@ "labelProperty": { "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -60300,10 +59691,6 @@ "type": "string", "description": "Specifies which property or attribute of the custom entity is used." }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -63237,9 +62624,6 @@ "deepLinkCode": { "type": "string" }, - "documentNumber": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -63471,9 +62855,6 @@ "type": "string", "description": "It is a generated special code linked to email. It is used to access details of guest customer actions." }, - "documentNumber": { - "type": "string" - }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -67685,9 +67066,6 @@ "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" @@ -68457,37 +67835,6 @@ } }, "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" @@ -68567,9 +67914,6 @@ "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" @@ -68789,12 +68133,6 @@ "items": { "$ref": "#/components/schemas/AppPaymentMethod" } - }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } } }, "type": "object" @@ -69492,9 +68830,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "path": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -69582,9 +68917,6 @@ "description": "Public url of media thumbnail.", "type": "string" }, - "path": { - "type": "string" - }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -75990,9 +75322,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -76351,9 +75680,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -88795,9 +88121,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -89083,35 +88406,6 @@ } }, "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" @@ -89185,9 +88479,6 @@ "type": "string", "description": "This URL allows to track packages." }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -89243,9 +88534,6 @@ }, "tax": { "$ref": "#/components/schemas/Tax" - }, - "appShippingMethod": { - "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" @@ -93909,9 +93197,6 @@ "url": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, "errorCount": { "type": "integer", "format": "int64", @@ -94000,9 +93285,6 @@ "type": "string", "description": "URL to be called when the event occurs." }, - "onlyLiveVersion": { - "type": "boolean" - }, "errorCount": { "type": "integer", "format": "int64", @@ -94092,9 +93374,6 @@ "url": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -94179,9 +93458,6 @@ "type": "string", "description": "A URL for the webhook event log." }, - "onlyLiveVersion": { - "type": "boolean" - }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -96319,10 +95595,6 @@ "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" From 7d13fd8ceca727a276114602bd0eba6ad1776c55 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 09:41:47 +0100 Subject: [PATCH 04/63] [create-pull-request] automated change (#101) Co-authored-by: shopwareBot --- SwagGuidedShopping-adminapi.json | 55366 ++++++++++++++++++++++++++++- 1 file changed, 54573 insertions(+), 793 deletions(-) diff --git a/SwagGuidedShopping-adminapi.json b/SwagGuidedShopping-adminapi.json index 91bfd7f..0664f8f 100644 --- a/SwagGuidedShopping-adminapi.json +++ b/SwagGuidedShopping-adminapi.json @@ -3,7 +3,7 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.9999999.9999999-dev" + "version": "6.5.6.1" }, "servers": [ { @@ -11,29 +11,54283 @@ } ], "paths": { - "/search/guided-shopping-presentation": { + "/acl-role": { + "get": { + "tags": [ + "Acl Role" + ], + "summary": "List with basic information of Acl Role resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getAclRoleList", + "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 Acl Role 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/AclRole" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/acl-role?limit=25" + }, + "last": { + "example": "/acl-role?limit=25&page=11" + }, + "next": { + "example": "/acl-role?limit=25&page=4" + }, + "prev": { + "example": "/acl-role?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Acl Role" + ], + "summary": "Create a new Acl Role resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createAclRole", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AclRole" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AclRole" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/acl-role/{id}": { + "get": { + "tags": [ + "Acl Role" + ], + "summary": "Detailed information about a Acl Role resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getAclRole", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the acl_role", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AclRole" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Acl Role" + ], + "summary": "Delete a Acl Role resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteAclRole", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the acl_role", + "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": [ + "Acl Role" + ], + "summary": "Partially update information about a Acl Role resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateAclRole", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the acl_role", + "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 Acl Role resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AclRole" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AclRole" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app": { + "get": { + "tags": [ + "App" + ], + "summary": "List with basic information of App resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppList", + "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 App 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/App" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app?limit=25" + }, + "last": { + "example": "/app?limit=25&page=11" + }, + "next": { + "example": "/app?limit=25&page=4" + }, + "prev": { + "example": "/app?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App" + ], + "summary": "Create a new App resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createApp", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/App" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/App" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of App", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/App" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/App" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app/{id}": { + "get": { + "tags": [ + "App" + ], + "summary": "Detailed information about a App resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of App", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/App" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/App" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App" + ], + "summary": "Delete a App resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app", + "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": [ + "App" + ], + "summary": "Partially update information about a App resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateApp", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app", + "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 App resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/App" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/App" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of App", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/App" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/App" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-action-button": { + "get": { + "tags": [ + "App Action Button" + ], + "summary": "List with basic information of App Action Button resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppActionButtonList", + "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 App Action Button 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/AppActionButton" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-action-button?limit=25" + }, + "last": { + "example": "/app-action-button?limit=25&page=11" + }, + "next": { + "example": "/app-action-button?limit=25&page=4" + }, + "prev": { + "example": "/app-action-button?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Action Button" + ], + "summary": "Create a new App Action Button resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createAppActionButton", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppActionButton", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-action-button/{id}": { + "get": { + "tags": [ + "App Action Button" + ], + "summary": "Detailed information about a App Action Button resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppActionButton", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_action_button", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppActionButton", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Action Button" + ], + "summary": "Delete a App Action Button resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteAppActionButton", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_action_button", + "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": [ + "App Action Button" + ], + "summary": "Partially update information about a App Action Button resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateAppActionButton", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_action_button", + "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 App Action Button resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppActionButton", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-administration-snippet": { + "get": { + "tags": [ + "App Administration Snippet" + ], + "summary": "List with basic information of App Administration Snippet resources.", + "description": "Available since: 6.4.15.0", + "operationId": "getAppAdministrationSnippetList", + "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 App Administration Snippet 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/AppAdministrationSnippet" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-administration-snippet?limit=25" + }, + "last": { + "example": "/app-administration-snippet?limit=25&page=11" + }, + "next": { + "example": "/app-administration-snippet?limit=25&page=4" + }, + "prev": { + "example": "/app-administration-snippet?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Administration Snippet" + ], + "summary": "Create a new App Administration Snippet resources.", + "description": "Available since: 6.4.15.0", + "operationId": "createAppAdministrationSnippet", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppAdministrationSnippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-administration-snippet/{id}": { + "get": { + "tags": [ + "App Administration Snippet" + ], + "summary": "Detailed information about a App Administration Snippet resource.", + "description": "Available since: 6.4.15.0", + "operationId": "getAppAdministrationSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_administration_snippet", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppAdministrationSnippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Administration Snippet" + ], + "summary": "Delete a App Administration Snippet resource.", + "description": "Available since: 6.4.15.0", + "operationId": "deleteAppAdministrationSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_administration_snippet", + "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": [ + "App Administration Snippet" + ], + "summary": "Partially update information about a App Administration Snippet resource.", + "description": "Available since: 6.4.15.0", + "operationId": "updateAppAdministrationSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_administration_snippet", + "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 App Administration Snippet resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppAdministrationSnippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-cms-block": { + "get": { + "tags": [ + "App Cms Block" + ], + "summary": "List with basic information of App Cms Block resources.", + "description": "Available since: 6.4.2.0", + "operationId": "getAppCmsBlockList", + "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 App Cms Block 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/AppCmsBlock" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-cms-block?limit=25" + }, + "last": { + "example": "/app-cms-block?limit=25&page=11" + }, + "next": { + "example": "/app-cms-block?limit=25&page=4" + }, + "prev": { + "example": "/app-cms-block?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Cms Block" + ], + "summary": "Create a new App Cms Block resources.", + "description": "Available since: 6.4.2.0", + "operationId": "createAppCmsBlock", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppCmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-cms-block/{id}": { + "get": { + "tags": [ + "App Cms Block" + ], + "summary": "Detailed information about a App Cms Block resource.", + "description": "Available since: 6.4.2.0", + "operationId": "getAppCmsBlock", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_cms_block", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppCmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Cms Block" + ], + "summary": "Delete a App Cms Block resource.", + "description": "Available since: 6.4.2.0", + "operationId": "deleteAppCmsBlock", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_cms_block", + "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": [ + "App Cms Block" + ], + "summary": "Partially update information about a App Cms Block resource.", + "description": "Available since: 6.4.2.0", + "operationId": "updateAppCmsBlock", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_cms_block", + "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 App Cms Block resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppCmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-flow-action": { + "get": { + "tags": [ + "App Flow Action" + ], + "summary": "List with basic information of App Flow Action resources.", + "description": "Available since: 6.4.10.0", + "operationId": "getAppFlowActionList", + "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 App Flow Action 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/AppFlowAction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-flow-action?limit=25" + }, + "last": { + "example": "/app-flow-action?limit=25&page=11" + }, + "next": { + "example": "/app-flow-action?limit=25&page=4" + }, + "prev": { + "example": "/app-flow-action?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Flow Action" + ], + "summary": "Create a new App Flow Action resources.", + "description": "Available since: 6.4.10.0", + "operationId": "createAppFlowAction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppFlowAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-flow-action/{id}": { + "get": { + "tags": [ + "App Flow Action" + ], + "summary": "Detailed information about a App Flow Action resource.", + "description": "Available since: 6.4.10.0", + "operationId": "getAppFlowAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_flow_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppFlowAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Flow Action" + ], + "summary": "Delete a App Flow Action resource.", + "description": "Available since: 6.4.10.0", + "operationId": "deleteAppFlowAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_flow_action", + "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": [ + "App Flow Action" + ], + "summary": "Partially update information about a App Flow Action resource.", + "description": "Available since: 6.4.10.0", + "operationId": "updateAppFlowAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_flow_action", + "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 App Flow Action resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppFlowAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-flow-event": { + "get": { + "tags": [ + "App Flow Event" + ], + "summary": "List with basic information of App Flow Event resources.", + "description": "Available since: 6.5.2.0", + "operationId": "getAppFlowEventList", + "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 App Flow Event 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/AppFlowEvent" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-flow-event?limit=25" + }, + "last": { + "example": "/app-flow-event?limit=25&page=11" + }, + "next": { + "example": "/app-flow-event?limit=25&page=4" + }, + "prev": { + "example": "/app-flow-event?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Flow Event" + ], + "summary": "Create a new App Flow Event resources.", + "description": "Available since: 6.5.2.0", + "operationId": "createAppFlowEvent", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppFlowEvent", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-flow-event/{id}": { + "get": { + "tags": [ + "App Flow Event" + ], + "summary": "Detailed information about a App Flow Event resource.", + "description": "Available since: 6.5.2.0", + "operationId": "getAppFlowEvent", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_flow_event", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppFlowEvent", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Flow Event" + ], + "summary": "Delete a App Flow Event resource.", + "description": "Available since: 6.5.2.0", + "operationId": "deleteAppFlowEvent", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_flow_event", + "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": [ + "App Flow Event" + ], + "summary": "Partially update information about a App Flow Event resource.", + "description": "Available since: 6.5.2.0", + "operationId": "updateAppFlowEvent", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_flow_event", + "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 App Flow Event resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppFlowEvent", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-payment-method": { + "get": { + "tags": [ + "App Payment Method" + ], + "summary": "List with basic information of App Payment Method resources.", + "description": "Available since: 6.4.1.0", + "operationId": "getAppPaymentMethodList", + "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 App Payment Method 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/AppPaymentMethod" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-payment-method?limit=25" + }, + "last": { + "example": "/app-payment-method?limit=25&page=11" + }, + "next": { + "example": "/app-payment-method?limit=25&page=4" + }, + "prev": { + "example": "/app-payment-method?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Payment Method" + ], + "summary": "Create a new App Payment Method resources.", + "description": "Available since: 6.4.1.0", + "operationId": "createAppPaymentMethod", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppPaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-payment-method/{id}": { + "get": { + "tags": [ + "App Payment Method" + ], + "summary": "Detailed information about a App Payment Method resource.", + "description": "Available since: 6.4.1.0", + "operationId": "getAppPaymentMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_payment_method", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppPaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Payment Method" + ], + "summary": "Delete a App Payment Method resource.", + "description": "Available since: 6.4.1.0", + "operationId": "deleteAppPaymentMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_payment_method", + "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": [ + "App Payment Method" + ], + "summary": "Partially update information about a App Payment Method resource.", + "description": "Available since: 6.4.1.0", + "operationId": "updateAppPaymentMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_payment_method", + "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 App Payment Method resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppPaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-script-condition": { + "get": { + "tags": [ + "App Script Condition" + ], + "summary": "List with basic information of App Script Condition resources.", + "description": "Available since: 6.4.10.3", + "operationId": "getAppScriptConditionList", + "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 App Script Condition 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/AppScriptCondition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-script-condition?limit=25" + }, + "last": { + "example": "/app-script-condition?limit=25&page=11" + }, + "next": { + "example": "/app-script-condition?limit=25&page=4" + }, + "prev": { + "example": "/app-script-condition?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Script Condition" + ], + "summary": "Create a new App Script Condition resources.", + "description": "Available since: 6.4.10.3", + "operationId": "createAppScriptCondition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-script-condition/{id}": { + "get": { + "tags": [ + "App Script Condition" + ], + "summary": "Detailed information about a App Script Condition resource.", + "description": "Available since: 6.4.10.3", + "operationId": "getAppScriptCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_script_condition", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Script Condition" + ], + "summary": "Delete a App Script Condition resource.", + "description": "Available since: 6.4.10.3", + "operationId": "deleteAppScriptCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_script_condition", + "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": [ + "App Script Condition" + ], + "summary": "Partially update information about a App Script Condition resource.", + "description": "Available since: 6.4.10.3", + "operationId": "updateAppScriptCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_script_condition", + "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 App Script Condition resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-template": { + "get": { + "tags": [ + "App Template" + ], + "summary": "List with basic information of App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppTemplateList", + "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 App Template 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/AppTemplate" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-template?limit=25" + }, + "last": { + "example": "/app-template?limit=25&page=11" + }, + "next": { + "example": "/app-template?limit=25&page=4" + }, + "prev": { + "example": "/app-template?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Template" + ], + "summary": "Create a new App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createAppTemplate", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-template/{id}": { + "get": { + "tags": [ + "App Template" + ], + "summary": "Detailed information about a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_template", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Template" + ], + "summary": "Delete a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteAppTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_template", + "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": [ + "App Template" + ], + "summary": "Partially update information about a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateAppTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_template", + "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 App Template resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/category": { + "get": { + "tags": [ + "Category" + ], + "summary": "List with basic information of Category resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCategoryList", + "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 Category 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/Category" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/category?limit=25" + }, + "last": { + "example": "/category?limit=25&page=11" + }, + "next": { + "example": "/category?limit=25&page=4" + }, + "prev": { + "example": "/category?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Category" + ], + "summary": "Create a new Category resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCategory", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Category" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Category" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/category/{id}": { + "get": { + "tags": [ + "Category" + ], + "summary": "Detailed information about a Category resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCategory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the category", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Category" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Category" + ], + "summary": "Delete a Category resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCategory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the category", + "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": [ + "Category" + ], + "summary": "Partially update information about a Category resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCategory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the category", + "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 Category resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Category" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Category" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-block": { + "get": { + "tags": [ + "Cms Block" + ], + "summary": "List with basic information of Cms Block resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsBlockList", + "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 Cms Block 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/CmsBlock" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/cms-block?limit=25" + }, + "last": { + "example": "/cms-block?limit=25&page=11" + }, + "next": { + "example": "/cms-block?limit=25&page=4" + }, + "prev": { + "example": "/cms-block?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Cms Block" + ], + "summary": "Create a new Cms Block resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCmsBlock", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-block/{id}": { + "get": { + "tags": [ + "Cms Block" + ], + "summary": "Detailed information about a Cms Block resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsBlock", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_block", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Cms Block" + ], + "summary": "Delete a Cms Block resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCmsBlock", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_block", + "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": [ + "Cms Block" + ], + "summary": "Partially update information about a Cms Block resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCmsBlock", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_block", + "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 Cms Block resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-page": { + "get": { + "tags": [ + "Cms Page" + ], + "summary": "List with basic information of Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsPageList", + "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 Cms Page 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/CmsPage" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/cms-page?limit=25" + }, + "last": { + "example": "/cms-page?limit=25&page=11" + }, + "next": { + "example": "/cms-page?limit=25&page=4" + }, + "prev": { + "example": "/cms-page?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Cms Page" + ], + "summary": "Create a new Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCmsPage", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-page/{id}": { + "get": { + "tags": [ + "Cms Page" + ], + "summary": "Detailed information about a Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Cms Page" + ], + "summary": "Delete a Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Cms Page" + ], + "summary": "Partially update information about a Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Cms Page resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-section": { + "get": { + "tags": [ + "Cms Section" + ], + "summary": "List with basic information of Cms Section resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsSectionList", + "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 Cms Section 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/CmsSection" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/cms-section?limit=25" + }, + "last": { + "example": "/cms-section?limit=25&page=11" + }, + "next": { + "example": "/cms-section?limit=25&page=4" + }, + "prev": { + "example": "/cms-section?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Cms Section" + ], + "summary": "Create a new Cms Section resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCmsSection", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-section/{id}": { + "get": { + "tags": [ + "Cms Section" + ], + "summary": "Detailed information about a Cms Section resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsSection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_section", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Cms Section" + ], + "summary": "Delete a Cms Section resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCmsSection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_section", + "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": [ + "Cms Section" + ], + "summary": "Partially update information about a Cms Section resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCmsSection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_section", + "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 Cms Section resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-slot": { + "get": { + "tags": [ + "Cms Slot" + ], + "summary": "List with basic information of Cms Slot resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsSlotList", + "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 Cms Slot 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/CmsSlot" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/cms-slot?limit=25" + }, + "last": { + "example": "/cms-slot?limit=25&page=11" + }, + "next": { + "example": "/cms-slot?limit=25&page=4" + }, + "prev": { + "example": "/cms-slot?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Cms Slot" + ], + "summary": "Create a new Cms Slot resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCmsSlot", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-slot/{id}": { + "get": { + "tags": [ + "Cms Slot" + ], + "summary": "Detailed information about a Cms Slot resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsSlot", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_slot", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Cms Slot" + ], + "summary": "Delete a Cms Slot resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCmsSlot", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_slot", + "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": [ + "Cms Slot" + ], + "summary": "Partially update information about a Cms Slot resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCmsSlot", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_slot", + "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 Cms Slot resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/country": { + "get": { + "tags": [ + "Country" + ], + "summary": "List with basic information of Country resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCountryList", + "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 Country 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/Country" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/country?limit=25" + }, + "last": { + "example": "/country?limit=25&page=11" + }, + "next": { + "example": "/country?limit=25&page=4" + }, + "prev": { + "example": "/country?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Country" + ], + "summary": "Create a new Country resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCountry", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Country" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Country" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/country/{id}": { + "get": { + "tags": [ + "Country" + ], + "summary": "Detailed information about a Country resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCountry", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the country", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Country" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Country" + ], + "summary": "Delete a Country resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCountry", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the country", + "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": [ + "Country" + ], + "summary": "Partially update information about a Country resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCountry", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the country", + "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 Country resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Country" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Country" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/country-state": { + "get": { + "tags": [ + "Country State" + ], + "summary": "List with basic information of Country State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCountryStateList", + "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 Country State 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/CountryState" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/country-state?limit=25" + }, + "last": { + "example": "/country-state?limit=25&page=11" + }, + "next": { + "example": "/country-state?limit=25&page=4" + }, + "prev": { + "example": "/country-state?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Country State" + ], + "summary": "Create a new Country State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCountryState", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CountryState" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CountryState" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/country-state/{id}": { + "get": { + "tags": [ + "Country State" + ], + "summary": "Detailed information about a Country State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCountryState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the country_state", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CountryState" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Country State" + ], + "summary": "Delete a Country State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCountryState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the country_state", + "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": [ + "Country State" + ], + "summary": "Partially update information about a Country State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCountryState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the country_state", + "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 Country State resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CountryState" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CountryState" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/currency": { + "get": { + "tags": [ + "Currency" + ], + "summary": "List with basic information of Currency resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCurrencyList", + "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 Currency 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/Currency" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/currency?limit=25" + }, + "last": { + "example": "/currency?limit=25&page=11" + }, + "next": { + "example": "/currency?limit=25&page=4" + }, + "prev": { + "example": "/currency?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Currency" + ], + "summary": "Create a new Currency resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCurrency", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Currency" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Currency" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/currency/{id}": { + "get": { + "tags": [ + "Currency" + ], + "summary": "Detailed information about a Currency resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCurrency", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the currency", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Currency" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Currency" + ], + "summary": "Delete a Currency resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCurrency", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the currency", + "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": [ + "Currency" + ], + "summary": "Partially update information about a Currency resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCurrency", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the currency", + "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 Currency resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Currency" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Currency" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/currency-country-rounding": { + "get": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "List with basic information of Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "getCurrencyCountryRoundingList", + "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 Currency Country Rounding 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/CurrencyCountryRounding" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/currency-country-rounding?limit=25" + }, + "last": { + "example": "/currency-country-rounding?limit=25&page=11" + }, + "next": { + "example": "/currency-country-rounding?limit=25&page=4" + }, + "prev": { + "example": "/currency-country-rounding?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Create a new Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "createCurrencyCountryRounding", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/currency-country-rounding/{id}": { + "get": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Detailed information about a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "getCurrencyCountryRounding", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the currency_country_rounding", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Delete a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "deleteCurrencyCountryRounding", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the currency_country_rounding", + "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": [ + "Currency Country Rounding" + ], + "summary": "Partially update information about a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "updateCurrencyCountryRounding", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the currency_country_rounding", + "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 Currency Country Rounding resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-entity": { + "get": { + "tags": [ + "Custom Entity" + ], + "summary": "List with basic information of Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "getCustomEntityList", + "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 Custom Entity 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/CustomEntity" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/custom-entity?limit=25" + }, + "last": { + "example": "/custom-entity?limit=25&page=11" + }, + "next": { + "example": "/custom-entity?limit=25&page=4" + }, + "prev": { + "example": "/custom-entity?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Custom Entity" + ], + "summary": "Create a new Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "createCustomEntity", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-entity/{id}": { + "get": { + "tags": [ + "Custom Entity" + ], + "summary": "Detailed information about a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "getCustomEntity", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_entity", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Custom Entity" + ], + "summary": "Delete a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "deleteCustomEntity", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_entity", + "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": [ + "Custom Entity" + ], + "summary": "Partially update information about a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "updateCustomEntity", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_entity", + "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 Custom Entity resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field": { + "get": { + "tags": [ + "Custom Field" + ], + "summary": "List with basic information of Custom Field resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomFieldList", + "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 Custom Field 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/CustomField" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/custom-field?limit=25" + }, + "last": { + "example": "/custom-field?limit=25&page=11" + }, + "next": { + "example": "/custom-field?limit=25&page=4" + }, + "prev": { + "example": "/custom-field?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Custom Field" + ], + "summary": "Create a new Custom Field resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomField", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomField" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomField" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field/{id}": { + "get": { + "tags": [ + "Custom Field" + ], + "summary": "Detailed information about a Custom Field resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomField" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Custom Field" + ], + "summary": "Delete a Custom Field resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field", + "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": [ + "Custom Field" + ], + "summary": "Partially update information about a Custom Field resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field", + "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 Custom Field resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomField" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomField" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field-set": { + "get": { + "tags": [ + "Custom Field Set" + ], + "summary": "List with basic information of Custom Field Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomFieldSetList", + "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 Custom Field Set 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/CustomFieldSet" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/custom-field-set?limit=25" + }, + "last": { + "example": "/custom-field-set?limit=25&page=11" + }, + "next": { + "example": "/custom-field-set?limit=25&page=4" + }, + "prev": { + "example": "/custom-field-set?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Custom Field Set" + ], + "summary": "Create a new Custom Field Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomFieldSet", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field-set/{id}": { + "get": { + "tags": [ + "Custom Field Set" + ], + "summary": "Detailed information about a Custom Field Set resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomFieldSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field_set", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Custom Field Set" + ], + "summary": "Delete a Custom Field Set resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomFieldSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field_set", + "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": [ + "Custom Field Set" + ], + "summary": "Partially update information about a Custom Field Set resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomFieldSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field_set", + "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 Custom Field Set resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field-set-relation": { + "get": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "List with basic information of Custom Field Set Relation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomFieldSetRelationList", + "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 Custom Field Set Relation 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/CustomFieldSetRelation" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/custom-field-set-relation?limit=25" + }, + "last": { + "example": "/custom-field-set-relation?limit=25&page=11" + }, + "next": { + "example": "/custom-field-set-relation?limit=25&page=4" + }, + "prev": { + "example": "/custom-field-set-relation?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Create a new Custom Field Set Relation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomFieldSetRelation", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field-set-relation/{id}": { + "get": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Detailed information about a Custom Field Set Relation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomFieldSetRelation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field_set_relation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Delete a Custom Field Set Relation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomFieldSetRelation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field_set_relation", + "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": [ + "Custom Field Set Relation" + ], + "summary": "Partially update information about a Custom Field Set Relation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomFieldSetRelation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_field_set_relation", + "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 Custom Field Set Relation resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer": { + "get": { + "tags": [ + "Customer" + ], + "summary": "List with basic information of Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerList", + "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 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/Customer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer?limit=25" + }, + "last": { + "example": "/customer?limit=25&page=11" + }, + "next": { + "example": "/customer?limit=25&page=4" + }, + "prev": { + "example": "/customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer" + ], + "summary": "Create a new Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomer", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer/{id}": { + "get": { + "tags": [ + "Customer" + ], + "summary": "Detailed information about a Customer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer" + ], + "summary": "Delete a Customer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Customer" + ], + "summary": "Partially update information about a Customer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Customer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Customer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-address": { + "get": { + "tags": [ + "Customer Address" + ], + "summary": "List with basic information of Customer Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerAddressList", + "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 Customer Address 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/CustomerAddress" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer-address?limit=25" + }, + "last": { + "example": "/customer-address?limit=25&page=11" + }, + "next": { + "example": "/customer-address?limit=25&page=4" + }, + "prev": { + "example": "/customer-address?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer Address" + ], + "summary": "Create a new Customer Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomerAddress", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-address/{id}": { + "get": { + "tags": [ + "Customer Address" + ], + "summary": "Detailed information about a Customer Address resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_address", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer Address" + ], + "summary": "Delete a Customer Address resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomerAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_address", + "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": [ + "Customer Address" + ], + "summary": "Partially update information about a Customer Address resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomerAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_address", + "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 Customer Address resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-group": { + "get": { + "tags": [ + "Customer Group" + ], + "summary": "List with basic information of Customer Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerGroupList", + "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 Customer 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/CustomerGroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer-group?limit=25" + }, + "last": { + "example": "/customer-group?limit=25&page=11" + }, + "next": { + "example": "/customer-group?limit=25&page=4" + }, + "prev": { + "example": "/customer-group?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer Group" + ], + "summary": "Create a new Customer Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomerGroup", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-group/{id}": { + "get": { + "tags": [ + "Customer Group" + ], + "summary": "Detailed information about a Customer Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer Group" + ], + "summary": "Delete a Customer Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomerGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_group", + "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": [ + "Customer Group" + ], + "summary": "Partially update information about a Customer Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomerGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_group", + "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 Customer Group resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-recovery": { + "get": { + "tags": [ + "Customer Recovery" + ], + "summary": "List with basic information of Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getCustomerRecoveryList", + "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 Customer Recovery 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/CustomerRecovery" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer-recovery?limit=25" + }, + "last": { + "example": "/customer-recovery?limit=25&page=11" + }, + "next": { + "example": "/customer-recovery?limit=25&page=4" + }, + "prev": { + "example": "/customer-recovery?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer Recovery" + ], + "summary": "Create a new Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createCustomerRecovery", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-recovery/{id}": { + "get": { + "tags": [ + "Customer Recovery" + ], + "summary": "Detailed information about a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getCustomerRecovery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_recovery", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer Recovery" + ], + "summary": "Delete a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteCustomerRecovery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_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": [ + "Customer Recovery" + ], + "summary": "Partially update information about a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateCustomerRecovery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_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 Customer Recovery resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-wishlist": { + "get": { + "tags": [ + "Customer Wishlist" + ], + "summary": "List with basic information of Customer Wishlist resources.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlistList", + "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 Customer Wishlist 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/CustomerWishlist" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer-wishlist?limit=25" + }, + "last": { + "example": "/customer-wishlist?limit=25&page=11" + }, + "next": { + "example": "/customer-wishlist?limit=25&page=4" + }, + "prev": { + "example": "/customer-wishlist?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Create a new Customer Wishlist resources.", + "description": "Available since: 6.3.4.0", + "operationId": "createCustomerWishlist", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-wishlist/{id}": { + "get": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Detailed information about a Customer Wishlist resource.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlist", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_wishlist", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Delete a Customer Wishlist resource.", + "description": "Available since: 6.3.4.0", + "operationId": "deleteCustomerWishlist", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_wishlist", + "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": [ + "Customer Wishlist" + ], + "summary": "Partially update information about a Customer Wishlist resource.", + "description": "Available since: 6.3.4.0", + "operationId": "updateCustomerWishlist", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_wishlist", + "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 Customer Wishlist resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-wishlist-product": { + "get": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "List with basic information of Customer Wishlist Product resources.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlistProductList", + "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 Customer Wishlist Product 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/CustomerWishlistProduct" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer-wishlist-product?limit=25" + }, + "last": { + "example": "/customer-wishlist-product?limit=25&page=11" + }, + "next": { + "example": "/customer-wishlist-product?limit=25&page=4" + }, + "prev": { + "example": "/customer-wishlist-product?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Create a new Customer Wishlist Product resources.", + "description": "Available since: 6.3.4.0", + "operationId": "createCustomerWishlistProduct", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-wishlist-product/{id}": { + "get": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Detailed information about a Customer Wishlist Product resource.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlistProduct", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_wishlist_product", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Delete a Customer Wishlist Product resource.", + "description": "Available since: 6.3.4.0", + "operationId": "deleteCustomerWishlistProduct", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_wishlist_product", + "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": [ + "Customer Wishlist Product" + ], + "summary": "Partially update information about a Customer Wishlist Product resource.", + "description": "Available since: 6.3.4.0", + "operationId": "updateCustomerWishlistProduct", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_wishlist_product", + "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 Customer Wishlist Product resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/delivery-time": { + "get": { + "tags": [ + "Delivery Time" + ], + "summary": "List with basic information of Delivery Time resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDeliveryTimeList", + "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 Delivery Time 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/DeliveryTime" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/delivery-time?limit=25" + }, + "last": { + "example": "/delivery-time?limit=25&page=11" + }, + "next": { + "example": "/delivery-time?limit=25&page=4" + }, + "prev": { + "example": "/delivery-time?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Delivery Time" + ], + "summary": "Create a new Delivery Time resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDeliveryTime", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/delivery-time/{id}": { + "get": { + "tags": [ + "Delivery Time" + ], + "summary": "Detailed information about a Delivery Time resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDeliveryTime", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the delivery_time", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Delivery Time" + ], + "summary": "Delete a Delivery Time resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDeliveryTime", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the delivery_time", + "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": [ + "Delivery Time" + ], + "summary": "Partially update information about a Delivery Time resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDeliveryTime", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the delivery_time", + "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 Delivery Time resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document": { + "get": { + "tags": [ + "Document" + ], + "summary": "List with basic information of Document resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentList", + "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 Document 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/Document" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/document?limit=25" + }, + "last": { + "example": "/document?limit=25&page=11" + }, + "next": { + "example": "/document?limit=25&page=4" + }, + "prev": { + "example": "/document?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Document" + ], + "summary": "Create a new Document resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDocument", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Document" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Document" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document/{id}": { + "get": { + "tags": [ + "Document" + ], + "summary": "Detailed information about a Document resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Document" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Document" + ], + "summary": "Delete a Document resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document", + "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": [ + "Document" + ], + "summary": "Partially update information about a Document resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document", + "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 Document resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Document" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Document" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config": { + "get": { + "tags": [ + "Document Base Config" + ], + "summary": "List with basic information of Document Base Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentBaseConfigList", + "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 Document Base Config 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/DocumentBaseConfig" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/document-base-config?limit=25" + }, + "last": { + "example": "/document-base-config?limit=25&page=11" + }, + "next": { + "example": "/document-base-config?limit=25&page=4" + }, + "prev": { + "example": "/document-base-config?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Document Base Config" + ], + "summary": "Create a new Document Base Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDocumentBaseConfig", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config/{id}": { + "get": { + "tags": [ + "Document Base Config" + ], + "summary": "Detailed information about a Document Base Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentBaseConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Document Base Config" + ], + "summary": "Delete a Document Base Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDocumentBaseConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config", + "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": [ + "Document Base Config" + ], + "summary": "Partially update information about a Document Base Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDocumentBaseConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config", + "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 Document Base Config resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config-sales-channel": { + "get": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "List with basic information of Document Base Config Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentBaseConfigSalesChannelList", + "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 Document Base Config Sales Channel 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/DocumentBaseConfigSalesChannel" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/document-base-config-sales-channel?limit=25" + }, + "last": { + "example": "/document-base-config-sales-channel?limit=25&page=11" + }, + "next": { + "example": "/document-base-config-sales-channel?limit=25&page=4" + }, + "prev": { + "example": "/document-base-config-sales-channel?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Create a new Document Base Config Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDocumentBaseConfigSalesChannel", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config-sales-channel/{id}": { + "get": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Detailed information about a Document Base Config Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentBaseConfigSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config_sales_channel", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Delete a Document Base Config Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDocumentBaseConfigSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config_sales_channel", + "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": [ + "Document Base Config Sales Channel" + ], + "summary": "Partially update information about a Document Base Config Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDocumentBaseConfigSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config_sales_channel", + "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 Document Base Config Sales Channel resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-type": { + "get": { + "tags": [ + "Document Type" + ], + "summary": "List with basic information of Document Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentTypeList", + "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 Document Type 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/DocumentType" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/document-type?limit=25" + }, + "last": { + "example": "/document-type?limit=25&page=11" + }, + "next": { + "example": "/document-type?limit=25&page=4" + }, + "prev": { + "example": "/document-type?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Document Type" + ], + "summary": "Create a new Document Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDocumentType", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-type/{id}": { + "get": { + "tags": [ + "Document Type" + ], + "summary": "Detailed information about a Document Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_type", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Document Type" + ], + "summary": "Delete a Document Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDocumentType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_type", + "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": [ + "Document Type" + ], + "summary": "Partially update information about a Document Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDocumentType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_type", + "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 Document Type resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow": { + "get": { + "tags": [ + "Flow" + ], + "summary": "List with basic information of Flow resources.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlowList", + "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 Flow 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/Flow" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/flow?limit=25" + }, + "last": { + "example": "/flow?limit=25&page=11" + }, + "next": { + "example": "/flow?limit=25&page=4" + }, + "prev": { + "example": "/flow?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Flow" + ], + "summary": "Create a new Flow resources.", + "description": "Available since: 6.4.6.0", + "operationId": "createFlow", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flow" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flow" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow/{id}": { + "get": { + "tags": [ + "Flow" + ], + "summary": "Detailed information about a Flow resource.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlow", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flow" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Flow" + ], + "summary": "Delete a Flow resource.", + "description": "Available since: 6.4.6.0", + "operationId": "deleteFlow", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow", + "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": [ + "Flow" + ], + "summary": "Partially update information about a Flow resource.", + "description": "Available since: 6.4.6.0", + "operationId": "updateFlow", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow", + "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 Flow resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flow" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Flow" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow-sequence": { + "get": { + "tags": [ + "Flow Sequence" + ], + "summary": "List with basic information of Flow Sequence resources.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlowSequenceList", + "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 Flow Sequence 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/FlowSequence" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/flow-sequence?limit=25" + }, + "last": { + "example": "/flow-sequence?limit=25&page=11" + }, + "next": { + "example": "/flow-sequence?limit=25&page=4" + }, + "prev": { + "example": "/flow-sequence?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Flow Sequence" + ], + "summary": "Create a new Flow Sequence resources.", + "description": "Available since: 6.4.6.0", + "operationId": "createFlowSequence", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow-sequence/{id}": { + "get": { + "tags": [ + "Flow Sequence" + ], + "summary": "Detailed information about a Flow Sequence resource.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlowSequence", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow_sequence", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Flow Sequence" + ], + "summary": "Delete a Flow Sequence resource.", + "description": "Available since: 6.4.6.0", + "operationId": "deleteFlowSequence", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow_sequence", + "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": [ + "Flow Sequence" + ], + "summary": "Partially update information about a Flow Sequence resource.", + "description": "Available since: 6.4.6.0", + "operationId": "updateFlowSequence", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow_sequence", + "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 Flow Sequence resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow-template": { + "get": { + "tags": [ + "Flow Template" + ], + "summary": "List with basic information of Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "getFlowTemplateList", + "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 Flow Template 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/FlowTemplate" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/flow-template?limit=25" + }, + "last": { + "example": "/flow-template?limit=25&page=11" + }, + "next": { + "example": "/flow-template?limit=25&page=4" + }, + "prev": { + "example": "/flow-template?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Flow Template" + ], + "summary": "Create a new Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "createFlowTemplate", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow-template/{id}": { + "get": { + "tags": [ + "Flow Template" + ], + "summary": "Detailed information about a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "getFlowTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow_template", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Flow Template" + ], + "summary": "Delete a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "deleteFlowTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow_template", + "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": [ + "Flow Template" + ], + "summary": "Partially update information about a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "updateFlowTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the flow_template", + "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 Flow Template resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-appointment": { + "get": { + "tags": [ + "Guided Shopping Appointment" + ], + "summary": "List with basic information of Guided Shopping Appointment resources.", + "description": "", + "operationId": "getGuidedShoppingAppointmentList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Appointment 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/GuidedShoppingAppointment" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-appointment?limit=25" + }, + "last": { + "example": "/guided-shopping-appointment?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-appointment?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-appointment?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Appointment" + ], + "summary": "Create a new appointment", + "description": "", + "operationId": "createAppointment", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Appointment" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "204": { + "description": "" + } + } + } + }, + "/guided-shopping-appointment/{id}": { + "get": { + "tags": [ + "Guided Shopping Appointment" + ], + "summary": "Detailed information about a Guided Shopping Appointment resource.", + "description": "", + "operationId": "getGuidedShoppingAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Appointment" + ], + "summary": "Delete a Guided Shopping Appointment resource.", + "description": "", + "operationId": "deleteGuidedShoppingAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Appointment" + ], + "summary": "Partially update information about a Guided Shopping Appointment resource.", + "description": "", + "operationId": "updateGuidedShoppingAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Appointment resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointment" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-appointment-attendee": { + "get": { + "tags": [ + "Guided Shopping Appointment Attendee" + ], + "summary": "List with basic information of Guided Shopping Appointment Attendee resources.", + "description": "", + "operationId": "getGuidedShoppingAppointmentAttendeeList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Appointment Attendee 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/GuidedShoppingAppointmentAttendee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-appointment-attendee?limit=25" + }, + "last": { + "example": "/guided-shopping-appointment-attendee?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-appointment-attendee?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-appointment-attendee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Guided Shopping Appointment Attendee" + ], + "summary": "Create a new Guided Shopping Appointment Attendee resources.", + "description": "", + "operationId": "createGuidedShoppingAppointmentAttendee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-appointment-attendee/{id}": { + "get": { + "tags": [ + "Guided Shopping Appointment Attendee" + ], + "summary": "Detailed information about a Guided Shopping Appointment Attendee resource.", + "description": "", + "operationId": "getGuidedShoppingAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Appointment Attendee" + ], + "summary": "Delete a Guided Shopping Appointment Attendee resource.", + "description": "", + "operationId": "deleteGuidedShoppingAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Appointment Attendee" + ], + "summary": "Partially update information about a Guided Shopping Appointment Attendee resource.", + "description": "", + "operationId": "updateGuidedShoppingAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Appointment Attendee resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-appointment-video-chat": { + "get": { + "tags": [ + "Guided Shopping Appointment Video Chat" + ], + "summary": "List with basic information of Guided Shopping Appointment Video Chat resources.", + "description": "", + "operationId": "getGuidedShoppingAppointmentVideoChatList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Appointment Video Chat 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/GuidedShoppingAppointmentVideoChat" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-appointment-video-chat?limit=25" + }, + "last": { + "example": "/guided-shopping-appointment-video-chat?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-appointment-video-chat?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-appointment-video-chat?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Guided Shopping Appointment Video Chat" + ], + "summary": "Create a new Guided Shopping Appointment Video Chat resources.", + "description": "", + "operationId": "createGuidedShoppingAppointmentVideoChat", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-appointment-video-chat/{id}": { + "get": { + "tags": [ + "Guided Shopping Appointment Video Chat" + ], + "summary": "Detailed information about a Guided Shopping Appointment Video Chat resource.", + "description": "", + "operationId": "getGuidedShoppingAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Appointment Video Chat" + ], + "summary": "Delete a Guided Shopping Appointment Video Chat resource.", + "description": "", + "operationId": "deleteGuidedShoppingAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Appointment Video Chat" + ], + "summary": "Partially update information about a Guided Shopping Appointment Video Chat resource.", + "description": "", + "operationId": "updateGuidedShoppingAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Appointment Video Chat resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-attendee-product-collection": { + "get": { + "tags": [ + "Guided Shopping Attendee Product Collection" + ], + "summary": "List with basic information of Guided Shopping Attendee Product Collection resources.", + "description": "", + "operationId": "getGuidedShoppingAttendeeProductCollectionList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Attendee Product Collection 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/GuidedShoppingAttendeeProductCollection" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-attendee-product-collection?limit=25" + }, + "last": { + "example": "/guided-shopping-attendee-product-collection?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-attendee-product-collection?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-attendee-product-collection?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Guided Shopping Attendee Product Collection" + ], + "summary": "Create a new Guided Shopping Attendee Product Collection resources.", + "description": "", + "operationId": "createGuidedShoppingAttendeeProductCollection", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-attendee-product-collection/{id}": { + "get": { + "tags": [ + "Guided Shopping Attendee Product Collection" + ], + "summary": "Detailed information about a Guided Shopping Attendee Product Collection resource.", + "description": "", + "operationId": "getGuidedShoppingAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Attendee Product Collection" + ], + "summary": "Delete a Guided Shopping Attendee Product Collection resource.", + "description": "", + "operationId": "deleteGuidedShoppingAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Attendee Product Collection" + ], + "summary": "Partially update information about a Guided Shopping Attendee Product Collection resource.", + "description": "", + "operationId": "updateGuidedShoppingAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Attendee Product Collection resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-interaction": { + "get": { + "tags": [ + "Guided Shopping Interaction" + ], + "summary": "List with basic information of Guided Shopping Interaction resources.", + "description": "", + "operationId": "getGuidedShoppingInteractionList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Interaction 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/GuidedShoppingInteraction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-interaction?limit=25" + }, + "last": { + "example": "/guided-shopping-interaction?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-interaction?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-interaction?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Guided Shopping Interaction" + ], + "summary": "Create a new Guided Shopping Interaction resources.", + "description": "", + "operationId": "createGuidedShoppingInteraction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-interaction/{id}": { + "get": { + "tags": [ + "Guided Shopping Interaction" + ], + "summary": "Detailed information about a Guided Shopping Interaction resource.", + "description": "", + "operationId": "getGuidedShoppingInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Interaction" + ], + "summary": "Delete a Guided Shopping Interaction resource.", + "description": "", + "operationId": "deleteGuidedShoppingInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Interaction" + ], + "summary": "Partially update information about a Guided Shopping Interaction resource.", + "description": "", + "operationId": "updateGuidedShoppingInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Interaction resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingInteraction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-presentation": { + "get": { + "tags": [ + "Guided Shopping Presentation" + ], + "summary": "List with basic information of Guided Shopping Presentation resources.", + "description": "", + "operationId": "getGuidedShoppingPresentationList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Presentation 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/GuidedShoppingPresentation" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-presentation?limit=25" + }, + "last": { + "example": "/guided-shopping-presentation?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-presentation?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-presentation?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Presentation" + ], + "summary": "Create a new presentation", + "description": "", + "operationId": "createPresentation", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Presentation" + } + } + }, + "required": false + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "204": { + "description": "" + } + } + } + }, + "/guided-shopping-presentation/{id}": { + "get": { + "tags": [ + "Guided Shopping Presentation" + ], + "summary": "Detailed information about a Guided Shopping Presentation resource.", + "description": "", + "operationId": "getGuidedShoppingPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Presentation" + ], + "summary": "Delete a Guided Shopping Presentation resource.", + "description": "", + "operationId": "deleteGuidedShoppingPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Presentation" + ], + "summary": "Partially update information about a Guided Shopping Presentation resource.", + "description": "", + "operationId": "updateGuidedShoppingPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Presentation resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentation" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-presentation-cms-page": { + "get": { + "tags": [ + "Guided Shopping Presentation Cms Page" + ], + "summary": "List with basic information of Guided Shopping Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getGuidedShoppingPresentationCmsPageList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Guided Shopping Presentation Cms Page 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/GuidedShoppingPresentationCmsPage" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/guided-shopping-presentation-cms-page?limit=25" + }, + "last": { + "example": "/guided-shopping-presentation-cms-page?limit=25&page=11" + }, + "next": { + "example": "/guided-shopping-presentation-cms-page?limit=25&page=4" + }, + "prev": { + "example": "/guided-shopping-presentation-cms-page?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Guided Shopping Presentation Cms Page" + ], + "summary": "Create a new Guided Shopping Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createGuidedShoppingPresentationCmsPage", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/guided-shopping-presentation-cms-page/{id}": { + "get": { + "tags": [ + "Guided Shopping Presentation Cms Page" + ], + "summary": "Detailed information about a Guided Shopping Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getGuidedShoppingPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of GuidedShoppingPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Guided Shopping Presentation Cms Page" + ], + "summary": "Delete a Guided Shopping Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteGuidedShoppingPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Guided Shopping Presentation Cms Page" + ], + "summary": "Partially update information about a Guided Shopping Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateGuidedShoppingPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the guided_shopping_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Guided Shopping Presentation Cms Page resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of GuidedShoppingPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-file": { + "get": { + "tags": [ + "Import Export File" + ], + "summary": "List with basic information of Import Export File resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportFileList", + "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 Import Export File 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/ImportExportFile" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/import-export-file?limit=25" + }, + "last": { + "example": "/import-export-file?limit=25&page=11" + }, + "next": { + "example": "/import-export-file?limit=25&page=4" + }, + "prev": { + "example": "/import-export-file?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Import Export File" + ], + "summary": "Create a new Import Export File resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createImportExportFile", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-file/{id}": { + "get": { + "tags": [ + "Import Export File" + ], + "summary": "Detailed information about a Import Export File resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportFile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_file", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Import Export File" + ], + "summary": "Delete a Import Export File resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteImportExportFile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_file", + "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": [ + "Import Export File" + ], + "summary": "Partially update information about a Import Export File resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateImportExportFile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_file", + "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 Import Export File resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-log": { + "get": { + "tags": [ + "Import Export Log" + ], + "summary": "List with basic information of Import Export Log resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportLogList", + "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 Import Export 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/ImportExportLog" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/import-export-log?limit=25" + }, + "last": { + "example": "/import-export-log?limit=25&page=11" + }, + "next": { + "example": "/import-export-log?limit=25&page=4" + }, + "prev": { + "example": "/import-export-log?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Import Export Log" + ], + "summary": "Create a new Import Export Log resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createImportExportLog", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-log/{id}": { + "get": { + "tags": [ + "Import Export Log" + ], + "summary": "Detailed information about a Import Export Log resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_log", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Import Export Log" + ], + "summary": "Delete a Import Export Log resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteImportExportLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_log", + "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": [ + "Import Export Log" + ], + "summary": "Partially update information about a Import Export Log resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateImportExportLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_log", + "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 Import Export Log resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-profile": { + "get": { + "tags": [ + "Import Export Profile" + ], + "summary": "List with basic information of Import Export Profile resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportProfileList", + "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 Import Export Profile 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/ImportExportProfile" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/import-export-profile?limit=25" + }, + "last": { + "example": "/import-export-profile?limit=25&page=11" + }, + "next": { + "example": "/import-export-profile?limit=25&page=4" + }, + "prev": { + "example": "/import-export-profile?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Import Export Profile" + ], + "summary": "Create a new Import Export Profile resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createImportExportProfile", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-profile/{id}": { + "get": { + "tags": [ + "Import Export Profile" + ], + "summary": "Detailed information about a Import Export Profile resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getImportExportProfile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_profile", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Import Export Profile" + ], + "summary": "Delete a Import Export Profile resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteImportExportProfile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_profile", + "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": [ + "Import Export Profile" + ], + "summary": "Partially update information about a Import Export Profile resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateImportExportProfile", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the import_export_profile", + "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 Import Export Profile resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/integration": { + "get": { + "tags": [ + "Integration" + ], + "summary": "List with basic information of Integration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getIntegrationList", + "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 Integration 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/Integration" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/integration?limit=25" + }, + "last": { + "example": "/integration?limit=25&page=11" + }, + "next": { + "example": "/integration?limit=25&page=4" + }, + "prev": { + "example": "/integration?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Integration" + ], + "summary": "Create a new Integration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createIntegration", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Integration" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Integration" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/integration/{id}": { + "get": { + "tags": [ + "Integration" + ], + "summary": "Detailed information about a Integration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getIntegration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the integration", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Integration" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Integration" + ], + "summary": "Delete a Integration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteIntegration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the integration", + "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": [ + "Integration" + ], + "summary": "Partially update information about a Integration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateIntegration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the integration", + "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 Integration resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Integration" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Integration" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/landing-page": { + "get": { + "tags": [ + "Landing Page" + ], + "summary": "List with basic information of Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "getLandingPageList", + "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 Landing Page 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/LandingPage" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/landing-page?limit=25" + }, + "last": { + "example": "/landing-page?limit=25&page=11" + }, + "next": { + "example": "/landing-page?limit=25&page=4" + }, + "prev": { + "example": "/landing-page?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Landing Page" + ], + "summary": "Create a new Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "createLandingPage", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/landing-page/{id}": { + "get": { + "tags": [ + "Landing Page" + ], + "summary": "Detailed information about a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "getLandingPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the landing_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Landing Page" + ], + "summary": "Delete a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "deleteLandingPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the landing_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Landing Page" + ], + "summary": "Partially update information about a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "updateLandingPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the landing_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Landing Page resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/language": { + "get": { + "tags": [ + "Language" + ], + "summary": "List with basic information of Language resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getLanguageList", + "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 Language 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/Language" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/language?limit=25" + }, + "last": { + "example": "/language?limit=25&page=11" + }, + "next": { + "example": "/language?limit=25&page=4" + }, + "prev": { + "example": "/language?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Language" + ], + "summary": "Create a new Language resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createLanguage", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Language" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Language" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/language/{id}": { + "get": { + "tags": [ + "Language" + ], + "summary": "Detailed information about a Language resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getLanguage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the language", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Language" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Language" + ], + "summary": "Delete a Language resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteLanguage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the language", + "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": [ + "Language" + ], + "summary": "Partially update information about a Language resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateLanguage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the language", + "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 Language resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Language" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Language" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/locale": { + "get": { + "tags": [ + "Locale" + ], + "summary": "List with basic information of Locale resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getLocaleList", + "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 Locale 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/Locale" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/locale?limit=25" + }, + "last": { + "example": "/locale?limit=25&page=11" + }, + "next": { + "example": "/locale?limit=25&page=4" + }, + "prev": { + "example": "/locale?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Locale" + ], + "summary": "Create a new Locale resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createLocale", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Locale" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Locale" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/locale/{id}": { + "get": { + "tags": [ + "Locale" + ], + "summary": "Detailed information about a Locale resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getLocale", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the locale", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Locale" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Locale" + ], + "summary": "Delete a Locale resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteLocale", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the locale", + "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": [ + "Locale" + ], + "summary": "Partially update information about a Locale resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateLocale", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the locale", + "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 Locale resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Locale" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Locale" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/log-entry": { + "get": { + "tags": [ + "Log Entry" + ], + "summary": "List with basic information of Log Entry resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getLogEntryList", + "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 Log Entry 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/LogEntry" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/log-entry?limit=25" + }, + "last": { + "example": "/log-entry?limit=25&page=11" + }, + "next": { + "example": "/log-entry?limit=25&page=4" + }, + "prev": { + "example": "/log-entry?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Log Entry" + ], + "summary": "Create a new Log Entry resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createLogEntry", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/log-entry/{id}": { + "get": { + "tags": [ + "Log Entry" + ], + "summary": "Detailed information about a Log Entry resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getLogEntry", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the log_entry", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Log Entry" + ], + "summary": "Delete a Log Entry resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteLogEntry", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the log_entry", + "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": [ + "Log Entry" + ], + "summary": "Partially update information about a Log Entry resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateLogEntry", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the log_entry", + "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 Log Entry resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-header-footer": { + "get": { + "tags": [ + "Mail Header Footer" + ], + "summary": "List with basic information of Mail Header Footer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailHeaderFooterList", + "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 Mail Header Footer 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/MailHeaderFooter" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/mail-header-footer?limit=25" + }, + "last": { + "example": "/mail-header-footer?limit=25&page=11" + }, + "next": { + "example": "/mail-header-footer?limit=25&page=4" + }, + "prev": { + "example": "/mail-header-footer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Create a new Mail Header Footer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMailHeaderFooter", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-header-footer/{id}": { + "get": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Detailed information about a Mail Header Footer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailHeaderFooter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_header_footer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Delete a Mail Header Footer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMailHeaderFooter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_header_footer", + "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": [ + "Mail Header Footer" + ], + "summary": "Partially update information about a Mail Header Footer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMailHeaderFooter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_header_footer", + "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 Mail Header Footer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-template": { + "get": { + "tags": [ + "Mail Template" + ], + "summary": "List with basic information of Mail Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailTemplateList", + "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 Mail Template 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/MailTemplate" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/mail-template?limit=25" + }, + "last": { + "example": "/mail-template?limit=25&page=11" + }, + "next": { + "example": "/mail-template?limit=25&page=4" + }, + "prev": { + "example": "/mail-template?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Mail Template" + ], + "summary": "Create a new Mail Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMailTemplate", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-template/{id}": { + "get": { + "tags": [ + "Mail Template" + ], + "summary": "Detailed information about a Mail Template resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_template", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Mail Template" + ], + "summary": "Delete a Mail Template resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMailTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_template", + "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": [ + "Mail Template" + ], + "summary": "Partially update information about a Mail Template resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMailTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_template", + "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 Mail Template resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-template-type": { + "get": { + "tags": [ + "Mail Template Type" + ], + "summary": "List with basic information of Mail Template Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailTemplateTypeList", + "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 Mail Template Type 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/MailTemplateType" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/mail-template-type?limit=25" + }, + "last": { + "example": "/mail-template-type?limit=25&page=11" + }, + "next": { + "example": "/mail-template-type?limit=25&page=4" + }, + "prev": { + "example": "/mail-template-type?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Mail Template Type" + ], + "summary": "Create a new Mail Template Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMailTemplateType", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-template-type/{id}": { + "get": { + "tags": [ + "Mail Template Type" + ], + "summary": "Detailed information about a Mail Template Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailTemplateType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_template_type", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Mail Template Type" + ], + "summary": "Delete a Mail Template Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMailTemplateType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_template_type", + "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": [ + "Mail Template Type" + ], + "summary": "Partially update information about a Mail Template Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMailTemplateType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the mail_template_type", + "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 Mail Template Type resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/main-category": { + "get": { + "tags": [ + "Main Category" + ], + "summary": "List with basic information of Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getMainCategoryList", + "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 Main Category 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/MainCategory" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/main-category?limit=25" + }, + "last": { + "example": "/main-category?limit=25&page=11" + }, + "next": { + "example": "/main-category?limit=25&page=4" + }, + "prev": { + "example": "/main-category?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Main Category" + ], + "summary": "Create a new Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createMainCategory", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/main-category/{id}": { + "get": { + "tags": [ + "Main Category" + ], + "summary": "Detailed information about a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getMainCategory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the main_category", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Main Category" + ], + "summary": "Delete a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteMainCategory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the main_category", + "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": [ + "Main Category" + ], + "summary": "Partially update information about a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateMainCategory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the main_category", + "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 Main Category resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media": { + "get": { + "tags": [ + "Media" + ], + "summary": "List with basic information of Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaList", + "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 Media 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/Media" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media?limit=25" + }, + "last": { + "example": "/media?limit=25&page=11" + }, + "next": { + "example": "/media?limit=25&page=4" + }, + "prev": { + "example": "/media?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media" + ], + "summary": "Create a new Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMedia", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Media" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Media" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media/{id}": { + "get": { + "tags": [ + "Media" + ], + "summary": "Detailed information about a Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMedia", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Media" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media" + ], + "summary": "Delete a Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMedia", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media", + "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": [ + "Media" + ], + "summary": "Partially update information about a Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMedia", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media", + "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 Media resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Media" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Media" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-default-folder": { + "get": { + "tags": [ + "Media Default Folder" + ], + "summary": "List with basic information of Media Default Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaDefaultFolderList", + "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 Media Default Folder 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/MediaDefaultFolder" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media-default-folder?limit=25" + }, + "last": { + "example": "/media-default-folder?limit=25&page=11" + }, + "next": { + "example": "/media-default-folder?limit=25&page=4" + }, + "prev": { + "example": "/media-default-folder?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media Default Folder" + ], + "summary": "Create a new Media Default Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMediaDefaultFolder", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-default-folder/{id}": { + "get": { + "tags": [ + "Media Default Folder" + ], + "summary": "Detailed information about a Media Default Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaDefaultFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_default_folder", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media Default Folder" + ], + "summary": "Delete a Media Default Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMediaDefaultFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_default_folder", + "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": [ + "Media Default Folder" + ], + "summary": "Partially update information about a Media Default Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMediaDefaultFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_default_folder", + "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 Media Default Folder resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder": { + "get": { + "tags": [ + "Media Folder" + ], + "summary": "List with basic information of Media Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaFolderList", + "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 Media Folder 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/MediaFolder" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media-folder?limit=25" + }, + "last": { + "example": "/media-folder?limit=25&page=11" + }, + "next": { + "example": "/media-folder?limit=25&page=4" + }, + "prev": { + "example": "/media-folder?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Create a new Media Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMediaFolder", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder/{id}": { + "get": { + "tags": [ + "Media Folder" + ], + "summary": "Detailed information about a Media Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media Folder" + ], + "summary": "Delete a Media Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMediaFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder", + "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": [ + "Media Folder" + ], + "summary": "Partially update information about a Media Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMediaFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder", + "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 Media Folder resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder-configuration": { + "get": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "List with basic information of Media Folder Configuration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaFolderConfigurationList", + "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 Media Folder Configuration 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/MediaFolderConfiguration" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media-folder-configuration?limit=25" + }, + "last": { + "example": "/media-folder-configuration?limit=25&page=11" + }, + "next": { + "example": "/media-folder-configuration?limit=25&page=4" + }, + "prev": { + "example": "/media-folder-configuration?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Create a new Media Folder Configuration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMediaFolderConfiguration", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder-configuration/{id}": { + "get": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Detailed information about a Media Folder Configuration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaFolderConfiguration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder_configuration", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Delete a Media Folder Configuration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMediaFolderConfiguration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder_configuration", + "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": [ + "Media Folder Configuration" + ], + "summary": "Partially update information about a Media Folder Configuration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMediaFolderConfiguration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder_configuration", + "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 Media Folder Configuration resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-thumbnail": { + "get": { + "tags": [ + "Media Thumbnail" + ], + "summary": "List with basic information of Media Thumbnail resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaThumbnailList", + "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 Media Thumbnail 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/MediaThumbnail" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media-thumbnail?limit=25" + }, + "last": { + "example": "/media-thumbnail?limit=25&page=11" + }, + "next": { + "example": "/media-thumbnail?limit=25&page=4" + }, + "prev": { + "example": "/media-thumbnail?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Create a new Media Thumbnail resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMediaThumbnail", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-thumbnail/{id}": { + "get": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Detailed information about a Media Thumbnail resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaThumbnail", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_thumbnail", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Delete a Media Thumbnail resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMediaThumbnail", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_thumbnail", + "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": [ + "Media Thumbnail" + ], + "summary": "Partially update information about a Media Thumbnail resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMediaThumbnail", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_thumbnail", + "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 Media Thumbnail resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-thumbnail-size": { + "get": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "List with basic information of Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaThumbnailSizeList", + "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 Media Thumbnail Size 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/MediaThumbnailSize" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media-thumbnail-size?limit=25" + }, + "last": { + "example": "/media-thumbnail-size?limit=25&page=11" + }, + "next": { + "example": "/media-thumbnail-size?limit=25&page=4" + }, + "prev": { + "example": "/media-thumbnail-size?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Create a new Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMediaThumbnailSize", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-thumbnail-size/{id}": { + "get": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Detailed information about a Media Thumbnail Size resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaThumbnailSize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_thumbnail_size", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Delete a Media Thumbnail Size resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMediaThumbnailSize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_thumbnail_size", + "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": [ + "Media Thumbnail Size" + ], + "summary": "Partially update information about a Media Thumbnail Size resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMediaThumbnailSize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_thumbnail_size", + "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 Media Thumbnail Size resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/newsletter-recipient": { + "get": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "List with basic information of Newsletter Recipient resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNewsletterRecipientList", + "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 Newsletter Recipient 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/NewsletterRecipient" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/newsletter-recipient?limit=25" + }, + "last": { + "example": "/newsletter-recipient?limit=25&page=11" + }, + "next": { + "example": "/newsletter-recipient?limit=25&page=4" + }, + "prev": { + "example": "/newsletter-recipient?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Create a new Newsletter Recipient resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNewsletterRecipient", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/newsletter-recipient/{id}": { + "get": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Detailed information about a Newsletter Recipient resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNewsletterRecipient", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the newsletter_recipient", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Delete a Newsletter Recipient resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNewsletterRecipient", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the newsletter_recipient", + "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": [ + "Newsletter Recipient" + ], + "summary": "Partially update information about a Newsletter Recipient resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNewsletterRecipient", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the newsletter_recipient", + "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 Newsletter Recipient resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/notification": { + "get": { + "tags": [ + "Notification" + ], + "summary": "List with basic information of Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotificationList", + "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 Notification 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/Notification" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/notification?limit=25" + }, + "last": { + "example": "/notification?limit=25&page=11" + }, + "next": { + "example": "/notification?limit=25&page=4" + }, + "prev": { + "example": "/notification?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Notification" + ], + "summary": "Create a new Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createNotification", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/notification/{id}": { + "get": { + "tags": [ + "Notification" + ], + "summary": "Detailed information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotification", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the notification", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Notification" + ], + "summary": "Delete a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteNotification", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the notification", + "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": [ + "Notification" + ], + "summary": "Partially update information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "updateNotification", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the notification", + "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 Notification resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Notification" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range": { + "get": { + "tags": [ + "Number Range" + ], + "summary": "List with basic information of Number Range resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeList", + "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 Number Range 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/NumberRange" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/number-range?limit=25" + }, + "last": { + "example": "/number-range?limit=25&page=11" + }, + "next": { + "example": "/number-range?limit=25&page=4" + }, + "prev": { + "example": "/number-range?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Number Range" + ], + "summary": "Create a new Number Range resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNumberRange", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range/{id}": { + "get": { + "tags": [ + "Number Range" + ], + "summary": "Detailed information about a Number Range resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRange", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Number Range" + ], + "summary": "Delete a Number Range resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNumberRange", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range", + "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": [ + "Number Range" + ], + "summary": "Partially update information about a Number Range resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNumberRange", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range", + "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 Number Range resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-sales-channel": { + "get": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "List with basic information of Number Range Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeSalesChannelList", + "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 Number Range Sales Channel 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/NumberRangeSalesChannel" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/number-range-sales-channel?limit=25" + }, + "last": { + "example": "/number-range-sales-channel?limit=25&page=11" + }, + "next": { + "example": "/number-range-sales-channel?limit=25&page=4" + }, + "prev": { + "example": "/number-range-sales-channel?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Create a new Number Range Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNumberRangeSalesChannel", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-sales-channel/{id}": { + "get": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Detailed information about a Number Range Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_sales_channel", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Delete a Number Range Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNumberRangeSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_sales_channel", + "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": [ + "Number Range Sales Channel" + ], + "summary": "Partially update information about a Number Range Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNumberRangeSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_sales_channel", + "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 Number Range Sales Channel resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-state": { + "get": { + "tags": [ + "Number Range State" + ], + "summary": "List with basic information of Number Range State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeStateList", + "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 Number Range State 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/NumberRangeState" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/number-range-state?limit=25" + }, + "last": { + "example": "/number-range-state?limit=25&page=11" + }, + "next": { + "example": "/number-range-state?limit=25&page=4" + }, + "prev": { + "example": "/number-range-state?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Number Range State" + ], + "summary": "Create a new Number Range State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNumberRangeState", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-state/{id}": { + "get": { + "tags": [ + "Number Range State" + ], + "summary": "Detailed information about a Number Range State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_state", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Number Range State" + ], + "summary": "Delete a Number Range State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNumberRangeState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_state", + "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": [ + "Number Range State" + ], + "summary": "Partially update information about a Number Range State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNumberRangeState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_state", + "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 Number Range State resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-type": { + "get": { + "tags": [ + "Number Range Type" + ], + "summary": "List with basic information of Number Range Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeTypeList", + "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 Number Range Type 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/NumberRangeType" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/number-range-type?limit=25" + }, + "last": { + "example": "/number-range-type?limit=25&page=11" + }, + "next": { + "example": "/number-range-type?limit=25&page=4" + }, + "prev": { + "example": "/number-range-type?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Number Range Type" + ], + "summary": "Create a new Number Range Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNumberRangeType", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-type/{id}": { + "get": { + "tags": [ + "Number Range Type" + ], + "summary": "Detailed information about a Number Range Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNumberRangeType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_type", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Number Range Type" + ], + "summary": "Delete a Number Range Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNumberRangeType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_type", + "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": [ + "Number Range Type" + ], + "summary": "Partially update information about a Number Range Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNumberRangeType", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the number_range_type", + "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 Number Range Type resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order": { + "get": { + "tags": [ + "Order" + ], + "summary": "List with basic information of Order resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderList", + "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 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/Order" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order?limit=25" + }, + "last": { + "example": "/order?limit=25&page=11" + }, + "next": { + "example": "/order?limit=25&page=4" + }, + "prev": { + "example": "/order?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order" + ], + "summary": "Create a new Order resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrder", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order/{id}": { + "get": { + "tags": [ + "Order" + ], + "summary": "Detailed information about a Order resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order" + ], + "summary": "Delete a Order resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the 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" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Order" + ], + "summary": "Partially update information about a Order resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the 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 Order resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Order" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-address": { + "get": { + "tags": [ + "Order Address" + ], + "summary": "List with basic information of Order Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderAddressList", + "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 Order Address 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/OrderAddress" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-address?limit=25" + }, + "last": { + "example": "/order-address?limit=25&page=11" + }, + "next": { + "example": "/order-address?limit=25&page=4" + }, + "prev": { + "example": "/order-address?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Address" + ], + "summary": "Create a new Order Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderAddress", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-address/{id}": { + "get": { + "tags": [ + "Order Address" + ], + "summary": "Detailed information about a Order Address resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_address", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Address" + ], + "summary": "Delete a Order Address resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_address", + "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": [ + "Order Address" + ], + "summary": "Partially update information about a Order Address resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_address", + "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 Order Address resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-customer": { + "get": { + "tags": [ + "Order Customer" + ], + "summary": "List with basic information of Order Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderCustomerList", + "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 Order 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/OrderCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-customer?limit=25" + }, + "last": { + "example": "/order-customer?limit=25&page=11" + }, + "next": { + "example": "/order-customer?limit=25&page=4" + }, + "prev": { + "example": "/order-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Customer" + ], + "summary": "Create a new Order Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderCustomer", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-customer/{id}": { + "get": { + "tags": [ + "Order Customer" + ], + "summary": "Detailed information about a Order Customer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Customer" + ], + "summary": "Delete a Order Customer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Order Customer" + ], + "summary": "Partially update information about a Order Customer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Order Customer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-delivery": { + "get": { + "tags": [ + "Order Delivery" + ], + "summary": "List with basic information of Order Delivery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderDeliveryList", + "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 Order Delivery 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/OrderDelivery" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-delivery?limit=25" + }, + "last": { + "example": "/order-delivery?limit=25&page=11" + }, + "next": { + "example": "/order-delivery?limit=25&page=4" + }, + "prev": { + "example": "/order-delivery?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Delivery" + ], + "summary": "Create a new Order Delivery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderDelivery", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-delivery/{id}": { + "get": { + "tags": [ + "Order Delivery" + ], + "summary": "Detailed information about a Order Delivery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_delivery", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Delivery" + ], + "summary": "Delete a Order Delivery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_delivery", + "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": [ + "Order Delivery" + ], + "summary": "Partially update information about a Order Delivery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_delivery", + "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 Order Delivery resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-delivery-position": { + "get": { + "tags": [ + "Order Delivery Position" + ], + "summary": "List with basic information of Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderDeliveryPositionList", + "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 Order Delivery Position 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/OrderDeliveryPosition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-delivery-position?limit=25" + }, + "last": { + "example": "/order-delivery-position?limit=25&page=11" + }, + "next": { + "example": "/order-delivery-position?limit=25&page=4" + }, + "prev": { + "example": "/order-delivery-position?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Create a new Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderDeliveryPosition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-delivery-position/{id}": { + "get": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Detailed information about a Order Delivery Position resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_delivery_position", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Delete a Order Delivery Position resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_delivery_position", + "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": [ + "Order Delivery Position" + ], + "summary": "Partially update information about a Order Delivery Position resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_delivery_position", + "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 Order Delivery Position resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-line-item": { + "get": { + "tags": [ + "Order Line Item" + ], + "summary": "List with basic information of Order Line Item resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderLineItemList", + "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 Order Line Item 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/OrderLineItem" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-line-item?limit=25" + }, + "last": { + "example": "/order-line-item?limit=25&page=11" + }, + "next": { + "example": "/order-line-item?limit=25&page=4" + }, + "prev": { + "example": "/order-line-item?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Line Item" + ], + "summary": "Create a new Order Line Item resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderLineItem", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-line-item/{id}": { + "get": { + "tags": [ + "Order Line Item" + ], + "summary": "Detailed information about a Order Line Item resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_line_item", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Line Item" + ], + "summary": "Delete a Order Line Item resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_line_item", + "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": [ + "Order Line Item" + ], + "summary": "Partially update information about a Order Line Item resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_line_item", + "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 Order Line Item resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-line-item-download": { + "get": { + "tags": [ + "Order Line Item Download" + ], + "summary": "List with basic information of Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownloadList", + "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 Order Line Item Download 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/OrderLineItemDownload" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-line-item-download?limit=25" + }, + "last": { + "example": "/order-line-item-download?limit=25&page=11" + }, + "next": { + "example": "/order-line-item-download?limit=25&page=4" + }, + "prev": { + "example": "/order-line-item-download?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Create a new Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createOrderLineItemDownload", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-line-item-download/{id}": { + "get": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Detailed information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownload", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_line_item_download", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Delete a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteOrderLineItemDownload", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_line_item_download", + "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": [ + "Order Line Item Download" + ], + "summary": "Partially update information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateOrderLineItemDownload", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_line_item_download", + "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 Order Line Item Download resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction": { + "get": { + "tags": [ + "Order Transaction" + ], + "summary": "List with basic information of Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransactionList", + "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 Order Transaction 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/OrderTransaction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-transaction?limit=25" + }, + "last": { + "example": "/order-transaction?limit=25&page=11" + }, + "next": { + "example": "/order-transaction?limit=25&page=4" + }, + "prev": { + "example": "/order-transaction?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Create a new Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderTransaction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction/{id}": { + "get": { + "tags": [ + "Order Transaction" + ], + "summary": "Detailed information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Transaction" + ], + "summary": "Delete a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction", + "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": [ + "Order Transaction" + ], + "summary": "Partially update information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction", + "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 Order Transaction resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture": { + "get": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "List with basic information of Order Transaction Capture resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureList", + "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 Order Transaction Capture 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/OrderTransactionCapture" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-transaction-capture?limit=25" + }, + "last": { + "example": "/order-transaction-capture?limit=25&page=11" + }, + "next": { + "example": "/order-transaction-capture?limit=25&page=4" + }, + "prev": { + "example": "/order-transaction-capture?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Create a new Order Transaction Capture resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCapture", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture/{id}": { + "get": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Detailed information about a Order Transaction Capture resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCapture", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Delete a Order Transaction Capture resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCapture", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture", + "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": [ + "Order Transaction Capture" + ], + "summary": "Partially update information about a Order Transaction Capture resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCapture", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture", + "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 Order Transaction Capture resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund": { + "get": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "List with basic information of Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundList", + "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 Order Transaction Capture Refund 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/OrderTransactionCaptureRefund" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-transaction-capture-refund?limit=25" + }, + "last": { + "example": "/order-transaction-capture-refund?limit=25&page=11" + }, + "next": { + "example": "/order-transaction-capture-refund?limit=25&page=4" + }, + "prev": { + "example": "/order-transaction-capture-refund?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Create a new Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCaptureRefund", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund/{id}": { + "get": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Detailed information about a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefund", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Delete a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCaptureRefund", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund", + "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": [ + "Order Transaction Capture Refund" + ], + "summary": "Partially update information about a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCaptureRefund", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund", + "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 Order Transaction Capture Refund resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund-position": { + "get": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "List with basic information of Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundPositionList", + "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 Order Transaction Capture Refund Position 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/OrderTransactionCaptureRefundPosition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-transaction-capture-refund-position?limit=25" + }, + "last": { + "example": "/order-transaction-capture-refund-position?limit=25&page=11" + }, + "next": { + "example": "/order-transaction-capture-refund-position?limit=25&page=4" + }, + "prev": { + "example": "/order-transaction-capture-refund-position?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Create a new Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCaptureRefundPosition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund-position/{id}": { + "get": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund_position", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Delete a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCaptureRefundPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund_position", + "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": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCaptureRefundPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund_position", + "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 Order Transaction Capture Refund Position resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/payment-method": { + "get": { + "tags": [ + "Payment Method" + ], + "summary": "List with basic information of Payment Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPaymentMethodList", + "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 Payment Method 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/PaymentMethod" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/payment-method?limit=25" + }, + "last": { + "example": "/payment-method?limit=25&page=11" + }, + "next": { + "example": "/payment-method?limit=25&page=4" + }, + "prev": { + "example": "/payment-method?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Create a new Payment Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPaymentMethod", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/payment-method/{id}": { + "get": { + "tags": [ + "Payment Method" + ], + "summary": "Detailed information about a Payment Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPaymentMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the payment_method", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Payment Method" + ], + "summary": "Delete a Payment Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePaymentMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the payment_method", + "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": [ + "Payment Method" + ], + "summary": "Partially update information about a Payment Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePaymentMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the payment_method", + "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 Payment Method resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/plugin": { + "get": { + "tags": [ + "Plugin" + ], + "summary": "List with basic information of Plugin resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPluginList", + "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 Plugin 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/Plugin" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/plugin?limit=25" + }, + "last": { + "example": "/plugin?limit=25&page=11" + }, + "next": { + "example": "/plugin?limit=25&page=4" + }, + "prev": { + "example": "/plugin?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Plugin" + ], + "summary": "Create a new Plugin resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPlugin", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/plugin/{id}": { + "get": { + "tags": [ + "Plugin" + ], + "summary": "Detailed information about a Plugin resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPlugin", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the plugin", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Plugin" + ], + "summary": "Delete a Plugin resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePlugin", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the plugin", + "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": [ + "Plugin" + ], + "summary": "Partially update information about a Plugin resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePlugin", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the plugin", + "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 Plugin resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plugin" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product": { + "get": { + "tags": [ + "Product" + ], + "summary": "List with basic information of Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductList", + "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 Product 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/Product" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product?limit=25" + }, + "last": { + "example": "/product?limit=25&page=11" + }, + "next": { + "example": "/product?limit=25&page=4" + }, + "prev": { + "example": "/product?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product" + ], + "summary": "Create a new Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProduct", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product/{id}": { + "get": { + "tags": [ + "Product" + ], + "summary": "Detailed information about a Product resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProduct", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product" + ], + "summary": "Delete a Product resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProduct", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product", + "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": [ + "Product" + ], + "summary": "Partially update information about a Product resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProduct", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product", + "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 Product resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Product" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-configurator-setting": { + "get": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "List with basic information of Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductConfiguratorSettingList", + "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 Product Configurator Setting 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/ProductConfiguratorSetting" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-configurator-setting?limit=25" + }, + "last": { + "example": "/product-configurator-setting?limit=25&page=11" + }, + "next": { + "example": "/product-configurator-setting?limit=25&page=4" + }, + "prev": { + "example": "/product-configurator-setting?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Create a new Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductConfiguratorSetting", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-configurator-setting/{id}": { + "get": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Detailed information about a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductConfiguratorSetting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_configurator_setting", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Delete a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductConfiguratorSetting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_configurator_setting", + "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": [ + "Product Configurator Setting" + ], + "summary": "Partially update information about a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductConfiguratorSetting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_configurator_setting", + "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 Product Configurator Setting resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-cross-selling": { + "get": { + "tags": [ + "Product Cross Selling" + ], + "summary": "List with basic information of Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSellingList", + "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 Product Cross Selling 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/ProductCrossSelling" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-cross-selling?limit=25" + }, + "last": { + "example": "/product-cross-selling?limit=25&page=11" + }, + "next": { + "example": "/product-cross-selling?limit=25&page=4" + }, + "prev": { + "example": "/product-cross-selling?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Create a new Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductCrossSelling", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-cross-selling/{id}": { + "get": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Detailed information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSelling", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_cross_selling", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Delete a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductCrossSelling", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_cross_selling", + "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": [ + "Product Cross Selling" + ], + "summary": "Partially update information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductCrossSelling", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_cross_selling", + "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 Product Cross Selling resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-cross-selling-assigned-products": { + "get": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "List with basic information of Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProductsList", + "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 Product Cross Selling Assigned Products 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/ProductCrossSellingAssignedProducts" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-cross-selling-assigned-products?limit=25" + }, + "last": { + "example": "/product-cross-selling-assigned-products?limit=25&page=11" + }, + "next": { + "example": "/product-cross-selling-assigned-products?limit=25&page=4" + }, + "prev": { + "example": "/product-cross-selling-assigned-products?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Create a new Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createProductCrossSellingAssignedProducts", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-cross-selling-assigned-products/{id}": { + "get": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProducts", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_cross_selling_assigned_products", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Delete a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteProductCrossSellingAssignedProducts", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_cross_selling_assigned_products", + "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": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateProductCrossSellingAssignedProducts", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_cross_selling_assigned_products", + "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 Product Cross Selling Assigned Products resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-download": { + "get": { + "tags": [ + "Product Download" + ], + "summary": "List with basic information of Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownloadList", + "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 Product Download 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/ProductDownload" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-download?limit=25" + }, + "last": { + "example": "/product-download?limit=25&page=11" + }, + "next": { + "example": "/product-download?limit=25&page=4" + }, + "prev": { + "example": "/product-download?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Download" + ], + "summary": "Create a new Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createProductDownload", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-download/{id}": { + "get": { + "tags": [ + "Product Download" + ], + "summary": "Detailed information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownload", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_download", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Download" + ], + "summary": "Delete a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteProductDownload", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_download", + "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": [ + "Product Download" + ], + "summary": "Partially update information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateProductDownload", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_download", + "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 Product Download resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-export": { + "get": { + "tags": [ + "Product Export" + ], + "summary": "List with basic information of Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExportList", + "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 Product Export 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/ProductExport" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-export?limit=25" + }, + "last": { + "example": "/product-export?limit=25&page=11" + }, + "next": { + "example": "/product-export?limit=25&page=4" + }, + "prev": { + "example": "/product-export?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Export" + ], + "summary": "Create a new Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductExport", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-export/{id}": { + "get": { + "tags": [ + "Product Export" + ], + "summary": "Detailed information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExport", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_export", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Export" + ], + "summary": "Delete a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductExport", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_export", + "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": [ + "Product Export" + ], + "summary": "Partially update information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductExport", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_export", + "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 Product Export resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-feature-set": { + "get": { + "tags": [ + "Product Feature Set" + ], + "summary": "List with basic information of Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSetList", + "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 Product Feature Set 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/ProductFeatureSet" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-feature-set?limit=25" + }, + "last": { + "example": "/product-feature-set?limit=25&page=11" + }, + "next": { + "example": "/product-feature-set?limit=25&page=4" + }, + "prev": { + "example": "/product-feature-set?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Create a new Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "createProductFeatureSet", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-feature-set/{id}": { + "get": { + "tags": [ + "Product Feature Set" + ], + "summary": "Detailed information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_feature_set", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Feature Set" + ], + "summary": "Delete a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "deleteProductFeatureSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_feature_set", + "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": [ + "Product Feature Set" + ], + "summary": "Partially update information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "updateProductFeatureSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_feature_set", + "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 Product Feature Set resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-keyword-dictionary": { + "get": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "List with basic information of Product Keyword Dictionary resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductKeywordDictionaryList", + "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 Product Keyword Dictionary 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/ProductKeywordDictionary" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-keyword-dictionary?limit=25" + }, + "last": { + "example": "/product-keyword-dictionary?limit=25&page=11" + }, + "next": { + "example": "/product-keyword-dictionary?limit=25&page=4" + }, + "prev": { + "example": "/product-keyword-dictionary?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Create a new Product Keyword Dictionary resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductKeywordDictionary", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-keyword-dictionary/{id}": { + "get": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Detailed information about a Product Keyword Dictionary resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductKeywordDictionary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_keyword_dictionary", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Delete a Product Keyword Dictionary resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductKeywordDictionary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_keyword_dictionary", + "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": [ + "Product Keyword Dictionary" + ], + "summary": "Partially update information about a Product Keyword Dictionary resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductKeywordDictionary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_keyword_dictionary", + "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 Product Keyword Dictionary resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-manufacturer": { + "get": { + "tags": [ + "Product Manufacturer" + ], + "summary": "List with basic information of Product Manufacturer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductManufacturerList", + "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 Product Manufacturer 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/ProductManufacturer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-manufacturer?limit=25" + }, + "last": { + "example": "/product-manufacturer?limit=25&page=11" + }, + "next": { + "example": "/product-manufacturer?limit=25&page=4" + }, + "prev": { + "example": "/product-manufacturer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Create a new Product Manufacturer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductManufacturer", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-manufacturer/{id}": { + "get": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Detailed information about a Product Manufacturer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductManufacturer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_manufacturer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Delete a Product Manufacturer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductManufacturer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_manufacturer", + "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": [ + "Product Manufacturer" + ], + "summary": "Partially update information about a Product Manufacturer resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductManufacturer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_manufacturer", + "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 Product Manufacturer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-media": { + "get": { + "tags": [ + "Product Media" + ], + "summary": "List with basic information of Product Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductMediaList", + "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 Product Media 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/ProductMedia" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-media?limit=25" + }, + "last": { + "example": "/product-media?limit=25&page=11" + }, + "next": { + "example": "/product-media?limit=25&page=4" + }, + "prev": { + "example": "/product-media?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Media" + ], + "summary": "Create a new Product Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductMedia", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-media/{id}": { + "get": { + "tags": [ + "Product Media" + ], + "summary": "Detailed information about a Product Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductMedia", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_media", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Media" + ], + "summary": "Delete a Product Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductMedia", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_media", + "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": [ + "Product Media" + ], + "summary": "Partially update information about a Product Media resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductMedia", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_media", + "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 Product Media resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-price": { + "get": { + "tags": [ + "Product Price" + ], + "summary": "List with basic information of Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductPriceList", + "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 Product 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/ProductPrice" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-price?limit=25" + }, + "last": { + "example": "/product-price?limit=25&page=11" + }, + "next": { + "example": "/product-price?limit=25&page=4" + }, + "prev": { + "example": "/product-price?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Price" + ], + "summary": "Create a new Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductPrice", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-price/{id}": { + "get": { + "tags": [ + "Product Price" + ], + "summary": "Detailed information about a Product Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Price" + ], + "summary": "Delete a Product Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_price", + "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": [ + "Product Price" + ], + "summary": "Partially update information about a Product Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_price", + "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 Product Price resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review": { + "get": { + "tags": [ + "Product Review" + ], + "summary": "List with basic information of Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductReviewList", + "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 Product Review 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/ProductReview" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-review?limit=25" + }, + "last": { + "example": "/product-review?limit=25&page=11" + }, + "next": { + "example": "/product-review?limit=25&page=4" + }, + "prev": { + "example": "/product-review?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Review" + ], + "summary": "Create a new Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductReview", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review/{id}": { + "get": { + "tags": [ + "Product Review" + ], + "summary": "Detailed information about a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductReview", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Review" + ], + "summary": "Delete a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductReview", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review", + "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": [ + "Product Review" + ], + "summary": "Partially update information about a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductReview", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review", + "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 Product Review resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-config": { + "get": { + "tags": [ + "Product Search Config" + ], + "summary": "List with basic information of Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigList", + "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 Product Search Config 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/ProductSearchConfig" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-search-config?limit=25" + }, + "last": { + "example": "/product-search-config?limit=25&page=11" + }, + "next": { + "example": "/product-search-config?limit=25&page=4" + }, + "prev": { + "example": "/product-search-config?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Create a new Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createProductSearchConfig", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-config/{id}": { + "get": { + "tags": [ + "Product Search Config" + ], + "summary": "Detailed information about a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Search Config" + ], + "summary": "Delete a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteProductSearchConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_config", + "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": [ + "Product Search Config" + ], + "summary": "Partially update information about a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateProductSearchConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_config", + "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 Product Search Config resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-config-field": { + "get": { + "tags": [ + "Product Search Config Field" + ], + "summary": "List with basic information of Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigFieldList", + "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 Product Search Config Field 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/ProductSearchConfigField" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-search-config-field?limit=25" + }, + "last": { + "example": "/product-search-config-field?limit=25&page=11" + }, + "next": { + "example": "/product-search-config-field?limit=25&page=4" + }, + "prev": { + "example": "/product-search-config-field?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Create a new Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createProductSearchConfigField", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-config-field/{id}": { + "get": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Detailed information about a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_config_field", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Delete a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteProductSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_config_field", + "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": [ + "Product Search Config Field" + ], + "summary": "Partially update information about a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateProductSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_config_field", + "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 Product Search Config Field resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-keyword": { + "get": { + "tags": [ + "Product Search Keyword" + ], + "summary": "List with basic information of Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductSearchKeywordList", + "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 Product Search Keyword 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/ProductSearchKeyword" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-search-keyword?limit=25" + }, + "last": { + "example": "/product-search-keyword?limit=25&page=11" + }, + "next": { + "example": "/product-search-keyword?limit=25&page=4" + }, + "prev": { + "example": "/product-search-keyword?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Create a new Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductSearchKeyword", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-keyword/{id}": { + "get": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Detailed information about a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductSearchKeyword", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_keyword", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Delete a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductSearchKeyword", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_keyword", + "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": [ + "Product Search Keyword" + ], + "summary": "Partially update information about a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductSearchKeyword", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_search_keyword", + "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 Product Search Keyword resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-sorting": { + "get": { + "tags": [ + "Product Sorting" + ], + "summary": "List with basic information of Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSortingList", + "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 Product Sorting 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/ProductSorting" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-sorting?limit=25" + }, + "last": { + "example": "/product-sorting?limit=25&page=11" + }, + "next": { + "example": "/product-sorting?limit=25&page=4" + }, + "prev": { + "example": "/product-sorting?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Create a new Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "createProductSorting", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-sorting/{id}": { + "get": { + "tags": [ + "Product Sorting" + ], + "summary": "Detailed information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSorting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_sorting", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Sorting" + ], + "summary": "Delete a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "deleteProductSorting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_sorting", + "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": [ + "Product Sorting" + ], + "summary": "Partially update information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "updateProductSorting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_sorting", + "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 Product Sorting resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-stream": { + "get": { + "tags": [ + "Product Stream" + ], + "summary": "List with basic information of Product Stream resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductStreamList", + "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 Product Stream 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/ProductStream" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-stream?limit=25" + }, + "last": { + "example": "/product-stream?limit=25&page=11" + }, + "next": { + "example": "/product-stream?limit=25&page=4" + }, + "prev": { + "example": "/product-stream?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Create a new Product Stream resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductStream", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-stream/{id}": { + "get": { + "tags": [ + "Product Stream" + ], + "summary": "Detailed information about a Product Stream resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductStream", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_stream", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Stream" + ], + "summary": "Delete a Product Stream resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductStream", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_stream", + "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": [ + "Product Stream" + ], + "summary": "Partially update information about a Product Stream resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductStream", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_stream", + "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 Product Stream resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-stream-filter": { + "get": { + "tags": [ + "Product Stream Filter" + ], + "summary": "List with basic information of Product Stream Filter resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductStreamFilterList", + "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 Product Stream Filter 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/ProductStreamFilter" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-stream-filter?limit=25" + }, + "last": { + "example": "/product-stream-filter?limit=25&page=11" + }, + "next": { + "example": "/product-stream-filter?limit=25&page=4" + }, + "prev": { + "example": "/product-stream-filter?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Create a new Product Stream Filter resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductStreamFilter", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-stream-filter/{id}": { + "get": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Detailed information about a Product Stream Filter resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_stream_filter", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Delete a Product Stream Filter resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_stream_filter", + "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": [ + "Product Stream Filter" + ], + "summary": "Partially update information about a Product Stream Filter resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_stream_filter", + "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 Product Stream Filter resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-visibility": { + "get": { + "tags": [ + "Product Visibility" + ], + "summary": "List with basic information of Product Visibility resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductVisibilityList", + "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 Product Visibility 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/ProductVisibility" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-visibility?limit=25" + }, + "last": { + "example": "/product-visibility?limit=25&page=11" + }, + "next": { + "example": "/product-visibility?limit=25&page=4" + }, + "prev": { + "example": "/product-visibility?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Create a new Product Visibility resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductVisibility", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-visibility/{id}": { + "get": { + "tags": [ + "Product Visibility" + ], + "summary": "Detailed information about a Product Visibility resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductVisibility", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_visibility", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Visibility" + ], + "summary": "Delete a Product Visibility resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductVisibility", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_visibility", + "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": [ + "Product Visibility" + ], + "summary": "Partially update information about a Product Visibility resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductVisibility", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_visibility", + "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 Product Visibility resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion": { + "get": { + "tags": [ + "Promotion" + ], + "summary": "List with basic information of Promotion resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionList", + "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 Promotion 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/Promotion" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/promotion?limit=25" + }, + "last": { + "example": "/promotion?limit=25&page=11" + }, + "next": { + "example": "/promotion?limit=25&page=4" + }, + "prev": { + "example": "/promotion?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Promotion" + ], + "summary": "Create a new Promotion resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPromotion", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Promotion" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Promotion" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion/{id}": { + "get": { + "tags": [ + "Promotion" + ], + "summary": "Detailed information about a Promotion resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotion", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Promotion" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Promotion" + ], + "summary": "Delete a Promotion resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePromotion", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion", + "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": [ + "Promotion" + ], + "summary": "Partially update information about a Promotion resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePromotion", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion", + "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 Promotion resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Promotion" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Promotion" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-discount": { + "get": { + "tags": [ + "Promotion Discount" + ], + "summary": "List with basic information of Promotion Discount resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionDiscountList", + "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 Promotion Discount 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/PromotionDiscount" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/promotion-discount?limit=25" + }, + "last": { + "example": "/promotion-discount?limit=25&page=11" + }, + "next": { + "example": "/promotion-discount?limit=25&page=4" + }, + "prev": { + "example": "/promotion-discount?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Create a new Promotion Discount resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPromotionDiscount", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-discount/{id}": { + "get": { + "tags": [ + "Promotion Discount" + ], + "summary": "Detailed information about a Promotion Discount resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionDiscount", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_discount", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Promotion Discount" + ], + "summary": "Delete a Promotion Discount resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePromotionDiscount", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_discount", + "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": [ + "Promotion Discount" + ], + "summary": "Partially update information about a Promotion Discount resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePromotionDiscount", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_discount", + "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 Promotion Discount resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-discount-prices": { + "get": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "List with basic information of Promotion Discount Prices resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionDiscountPricesList", + "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 Promotion Discount Prices 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/PromotionDiscountPrices" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/promotion-discount-prices?limit=25" + }, + "last": { + "example": "/promotion-discount-prices?limit=25&page=11" + }, + "next": { + "example": "/promotion-discount-prices?limit=25&page=4" + }, + "prev": { + "example": "/promotion-discount-prices?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Create a new Promotion Discount Prices resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPromotionDiscountPrices", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-discount-prices/{id}": { + "get": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Detailed information about a Promotion Discount Prices resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionDiscountPrices", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_discount_prices", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Delete a Promotion Discount Prices resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePromotionDiscountPrices", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_discount_prices", + "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": [ + "Promotion Discount Prices" + ], + "summary": "Partially update information about a Promotion Discount Prices resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePromotionDiscountPrices", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_discount_prices", + "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 Promotion Discount Prices resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-individual-code": { + "get": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "List with basic information of Promotion Individual Code resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionIndividualCodeList", + "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 Promotion Individual Code 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/PromotionIndividualCode" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/promotion-individual-code?limit=25" + }, + "last": { + "example": "/promotion-individual-code?limit=25&page=11" + }, + "next": { + "example": "/promotion-individual-code?limit=25&page=4" + }, + "prev": { + "example": "/promotion-individual-code?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Create a new Promotion Individual Code resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPromotionIndividualCode", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-individual-code/{id}": { + "get": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Detailed information about a Promotion Individual Code resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionIndividualCode", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_individual_code", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Delete a Promotion Individual Code resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePromotionIndividualCode", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_individual_code", + "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": [ + "Promotion Individual Code" + ], + "summary": "Partially update information about a Promotion Individual Code resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePromotionIndividualCode", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_individual_code", + "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 Promotion Individual Code resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-sales-channel": { + "get": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "List with basic information of Promotion Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionSalesChannelList", + "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 Promotion Sales Channel 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/PromotionSalesChannel" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/promotion-sales-channel?limit=25" + }, + "last": { + "example": "/promotion-sales-channel?limit=25&page=11" + }, + "next": { + "example": "/promotion-sales-channel?limit=25&page=4" + }, + "prev": { + "example": "/promotion-sales-channel?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Create a new Promotion Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPromotionSalesChannel", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-sales-channel/{id}": { + "get": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Detailed information about a Promotion Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_sales_channel", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Delete a Promotion Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePromotionSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_sales_channel", + "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": [ + "Promotion Sales Channel" + ], + "summary": "Partially update information about a Promotion Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePromotionSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_sales_channel", + "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 Promotion Sales Channel resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-setgroup": { + "get": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "List with basic information of Promotion Setgroup resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionSetgroupList", + "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 Promotion Setgroup 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/PromotionSetgroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/promotion-setgroup?limit=25" + }, + "last": { + "example": "/promotion-setgroup?limit=25&page=11" + }, + "next": { + "example": "/promotion-setgroup?limit=25&page=4" + }, + "prev": { + "example": "/promotion-setgroup?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Create a new Promotion Setgroup resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPromotionSetgroup", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-setgroup/{id}": { + "get": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Detailed information about a Promotion Setgroup resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPromotionSetgroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_setgroup", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Delete a Promotion Setgroup resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePromotionSetgroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_setgroup", + "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": [ + "Promotion Setgroup" + ], + "summary": "Partially update information about a Promotion Setgroup resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePromotionSetgroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the promotion_setgroup", + "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 Promotion Setgroup resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/property-group": { + "get": { + "tags": [ + "Property Group" + ], + "summary": "List with basic information of Property Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPropertyGroupList", + "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 Property 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/PropertyGroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/property-group?limit=25" + }, + "last": { + "example": "/property-group?limit=25&page=11" + }, + "next": { + "example": "/property-group?limit=25&page=4" + }, + "prev": { + "example": "/property-group?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Property Group" + ], + "summary": "Create a new Property Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPropertyGroup", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/property-group/{id}": { + "get": { + "tags": [ + "Property Group" + ], + "summary": "Detailed information about a Property Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPropertyGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the property_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Property Group" + ], + "summary": "Delete a Property Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePropertyGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the property_group", + "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": [ + "Property Group" + ], + "summary": "Partially update information about a Property Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePropertyGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the property_group", + "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 Property Group resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/property-group-option": { + "get": { + "tags": [ + "Property Group Option" + ], + "summary": "List with basic information of Property Group Option resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getPropertyGroupOptionList", + "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 Property Group Option 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/PropertyGroupOption" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/property-group-option?limit=25" + }, + "last": { + "example": "/property-group-option?limit=25&page=11" + }, + "next": { + "example": "/property-group-option?limit=25&page=4" + }, + "prev": { + "example": "/property-group-option?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Create a new Property Group Option resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createPropertyGroupOption", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/property-group-option/{id}": { + "get": { + "tags": [ + "Property Group Option" + ], + "summary": "Detailed information about a Property Group Option resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getPropertyGroupOption", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the property_group_option", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Property Group Option" + ], + "summary": "Delete a Property Group Option resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deletePropertyGroupOption", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the property_group_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": [ + "Property Group Option" + ], + "summary": "Partially update information about a Property Group Option resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updatePropertyGroupOption", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the property_group_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 Property Group Option resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/rule": { + "get": { + "tags": [ + "Rule" + ], + "summary": "List with basic information of Rule resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getRuleList", + "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 Rule 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/Rule" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/rule?limit=25" + }, + "last": { + "example": "/rule?limit=25&page=11" + }, + "next": { + "example": "/rule?limit=25&page=4" + }, + "prev": { + "example": "/rule?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Rule" + ], + "summary": "Create a new Rule resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createRule", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rule" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rule" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/rule/{id}": { + "get": { + "tags": [ + "Rule" + ], + "summary": "Detailed information about a Rule resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the rule", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rule" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Rule" + ], + "summary": "Delete a Rule resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the rule", + "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": [ + "Rule" + ], + "summary": "Partially update information about a Rule resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the rule", + "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 Rule resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rule" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rule" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/rule-condition": { + "get": { + "tags": [ + "Rule Condition" + ], + "summary": "List with basic information of Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getRuleConditionList", + "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 Rule Condition 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/RuleCondition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/rule-condition?limit=25" + }, + "last": { + "example": "/rule-condition?limit=25&page=11" + }, + "next": { + "example": "/rule-condition?limit=25&page=4" + }, + "prev": { + "example": "/rule-condition?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Create a new Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createRuleCondition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/rule-condition/{id}": { + "get": { + "tags": [ + "Rule Condition" + ], + "summary": "Detailed information about a Rule Condition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getRuleCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the rule_condition", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Rule Condition" + ], + "summary": "Delete a Rule Condition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteRuleCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the rule_condition", + "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": [ + "Rule Condition" + ], + "summary": "Partially update information about a Rule Condition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateRuleCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the rule_condition", + "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 Rule Condition resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel": { + "get": { + "tags": [ + "Sales Channel" + ], + "summary": "List with basic information of Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelList", + "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 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/SalesChannel" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel?limit=25" + }, + "last": { + "example": "/sales-channel?limit=25&page=11" + }, + "next": { + "example": "/sales-channel?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Create a new Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannel", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel/{id}": { + "get": { + "tags": [ + "Sales Channel" + ], + "summary": "Detailed information about a Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sales Channel" + ], + "summary": "Delete a Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel", + "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": [ + "Sales Channel" + ], + "summary": "Partially update information about a Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel", + "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 resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-analytics": { + "get": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "List with basic information of Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalyticsList", + "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 Analytics 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/SalesChannelAnalytics" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel-analytics?limit=25" + }, + "last": { + "example": "/sales-channel-analytics?limit=25&page=11" + }, + "next": { + "example": "/sales-channel-analytics?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel-analytics?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Create a new Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createSalesChannelAnalytics", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-analytics/{id}": { + "get": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Detailed information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalytics", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_analytics", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Delete a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteSalesChannelAnalytics", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_analytics", + "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": [ + "Sales Channel Analytics" + ], + "summary": "Partially update information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateSalesChannelAnalytics", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_analytics", + "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 Analytics resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-domain": { + "get": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "List with basic information of Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelDomainList", + "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 Domain 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/SalesChannelDomain" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel-domain?limit=25" + }, + "last": { + "example": "/sales-channel-domain?limit=25&page=11" + }, + "next": { + "example": "/sales-channel-domain?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel-domain?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Create a new Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelDomain", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-domain/{id}": { + "get": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Detailed information about a Sales Channel Domain resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelDomain", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_domain", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Delete a Sales Channel Domain resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalesChannelDomain", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_domain", + "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": [ + "Sales Channel Domain" + ], + "summary": "Partially update information about a Sales Channel Domain resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSalesChannelDomain", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sales_channel_domain", + "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 Domain resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-type": { + "get": { + "tags": [ + "Sales Channel Type" + ], + "summary": "List with basic information of Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelTypeList", + "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 Type 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/SalesChannelType" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sales-channel-type?limit=25" + }, + "last": { + "example": "/sales-channel-type?limit=25&page=11" + }, + "next": { + "example": "/sales-channel-type?limit=25&page=4" + }, + "prev": { + "example": "/sales-channel-type?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Create a new Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelType", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-type/{id}": { + "get": { + "tags": [ + "Sales Channel Type" + ], + "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_type", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sales Channel Type" + ], + "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_type", + "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": [ + "Sales Channel Type" + ], + "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_type", + "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 Type resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/salutation": { + "get": { + "tags": [ + "Salutation" + ], + "summary": "List with basic information of Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalutationList", + "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 Salutation 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/Salutation" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/salutation?limit=25" + }, + "last": { + "example": "/salutation?limit=25&page=11" + }, + "next": { + "example": "/salutation?limit=25&page=4" + }, + "prev": { + "example": "/salutation?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Salutation" + ], + "summary": "Create a new Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalutation", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Salutation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Salutation" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/salutation/{id}": { + "get": { + "tags": [ + "Salutation" + ], + "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 salutation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Salutation" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Salutation" + ], + "summary": "Delete a Salutation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalutation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the salutation", + "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": [ + "Salutation" + ], + "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 salutation", + "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 Salutation resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Salutation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Salutation" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/scheduled-task": { + "get": { + "tags": [ + "Scheduled Task" + ], + "summary": "List with basic information of Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTaskList", + "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 Scheduled Task 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/ScheduledTask" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/scheduled-task?limit=25" + }, + "last": { + "example": "/scheduled-task?limit=25&page=11" + }, + "next": { + "example": "/scheduled-task?limit=25&page=4" + }, + "prev": { + "example": "/scheduled-task?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Create a new Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createScheduledTask", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/scheduled-task/{id}": { + "get": { + "tags": [ + "Scheduled Task" + ], + "summary": "Detailed information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTask", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the scheduled_task", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Scheduled Task" + ], + "summary": "Delete a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteScheduledTask", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the scheduled_task", + "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": [ + "Scheduled Task" + ], + "summary": "Partially update information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateScheduledTask", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the scheduled_task", + "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 Scheduled Task resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/script": { + "get": { + "tags": [ + "Script" + ], + "summary": "List with basic information of Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getScriptList", + "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 Script 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/Script" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/script?limit=25" + }, + "last": { + "example": "/script?limit=25&page=11" + }, + "next": { + "example": "/script?limit=25&page=4" + }, + "prev": { + "example": "/script?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Script" + ], + "summary": "Create a new Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createScript", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Script" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Script" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/script/{id}": { + "get": { + "tags": [ + "Script" + ], + "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 script", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Script" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Script" + ], + "summary": "Delete a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteScript", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the script", + "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": [ + "Script" + ], + "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 script", + "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 Script resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Script" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Script" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/seo-url": { + "get": { + "tags": [ + "Seo Url" + ], + "summary": "List with basic information of Seo Url resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrlList", + "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 Seo Url 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/SeoUrl" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/seo-url?limit=25" + }, + "last": { + "example": "/seo-url?limit=25&page=11" + }, + "next": { + "example": "/seo-url?limit=25&page=4" + }, + "prev": { + "example": "/seo-url?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Create a new Seo Url resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSeoUrl", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/seo-url/{id}": { + "get": { + "tags": [ + "Seo Url" + ], + "summary": "Detailed information about a Seo Url resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrl", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the seo_url", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Seo Url" + ], + "summary": "Delete a Seo Url resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSeoUrl", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the seo_url", + "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": [ + "Seo Url" + ], + "summary": "Partially update information about a Seo Url resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSeoUrl", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the seo_url", + "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 Seo Url resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/seo-url-template": { + "get": { + "tags": [ + "Seo Url Template" + ], + "summary": "List with basic information of Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSeoUrlTemplateList", + "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 Seo Url Template 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/SeoUrlTemplate" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/seo-url-template?limit=25" + }, + "last": { + "example": "/seo-url-template?limit=25&page=11" + }, + "next": { + "example": "/seo-url-template?limit=25&page=4" + }, + "prev": { + "example": "/seo-url-template?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Create a new Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSeoUrlTemplate", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/seo-url-template/{id}": { + "get": { + "tags": [ + "Seo Url Template" + ], + "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 seo_url_template", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Seo Url Template" + ], + "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 seo_url_template", + "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": [ + "Seo Url Template" + ], + "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 seo_url_template", + "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 Seo Url Template resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/shipping-method": { + "get": { + "tags": [ + "Shipping Method" + ], + "summary": "List with basic information of Shipping Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getShippingMethodList", + "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 Shipping Method 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/ShippingMethod" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/shipping-method?limit=25" + }, + "last": { + "example": "/shipping-method?limit=25&page=11" + }, + "next": { + "example": "/shipping-method?limit=25&page=4" + }, + "prev": { + "example": "/shipping-method?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Create a new Shipping Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createShippingMethod", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/shipping-method/{id}": { + "get": { + "tags": [ + "Shipping Method" + ], + "summary": "Detailed information about a Shipping Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getShippingMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the shipping_method", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Shipping Method" + ], + "summary": "Delete a Shipping Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteShippingMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the shipping_method", + "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": [ + "Shipping Method" + ], + "summary": "Partially update information about a Shipping Method resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateShippingMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the shipping_method", + "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 Shipping Method resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/shipping-method-price": { + "get": { + "tags": [ + "Shipping Method Price" + ], + "summary": "List with basic information of Shipping Method Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getShippingMethodPriceList", + "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 Shipping Method 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/ShippingMethodPrice" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/shipping-method-price?limit=25" + }, + "last": { + "example": "/shipping-method-price?limit=25&page=11" + }, + "next": { + "example": "/shipping-method-price?limit=25&page=4" + }, + "prev": { + "example": "/shipping-method-price?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Create a new Shipping Method Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createShippingMethodPrice", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/shipping-method-price/{id}": { + "get": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Detailed information about a Shipping Method Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getShippingMethodPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the shipping_method_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Delete a Shipping Method Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteShippingMethodPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the shipping_method_price", + "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": [ + "Shipping Method Price" + ], + "summary": "Partially update information about a Shipping Method Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateShippingMethodPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the shipping_method_price", + "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 Shipping Method Price resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet": { + "get": { + "tags": [ + "Snippet" + ], + "summary": "List with basic information of Snippet resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSnippetList", + "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 Snippet 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/Snippet" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/snippet?limit=25" + }, + "last": { + "example": "/snippet?limit=25&page=11" + }, + "next": { + "example": "/snippet?limit=25&page=4" + }, + "prev": { + "example": "/snippet?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Snippet" + ], + "summary": "Create a new Snippet resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSnippet", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Snippet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Snippet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet/{id}": { + "get": { + "tags": [ + "Snippet" + ], + "summary": "Detailed information about a Snippet resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Snippet" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Snippet" + ], + "summary": "Delete a Snippet resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet", + "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": [ + "Snippet" + ], + "summary": "Partially update information about a Snippet resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet", + "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 Snippet resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Snippet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Snippet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet-set": { + "get": { + "tags": [ + "Snippet Set" + ], + "summary": "List with basic information of Snippet Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSnippetSetList", + "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 Snippet Set 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/SnippetSet" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/snippet-set?limit=25" + }, + "last": { + "example": "/snippet-set?limit=25&page=11" + }, + "next": { + "example": "/snippet-set?limit=25&page=4" + }, + "prev": { + "example": "/snippet-set?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Create a new Snippet Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSnippetSet", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet-set/{id}": { + "get": { + "tags": [ + "Snippet Set" + ], + "summary": "Detailed information about a Snippet Set resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSnippetSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet_set", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Snippet Set" + ], + "summary": "Delete a Snippet Set resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSnippetSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet_set", + "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": [ + "Snippet Set" + ], + "summary": "Partially update information about a Snippet Set resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSnippetSet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet_set", + "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 Snippet Set resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine": { + "get": { + "tags": [ + "State Machine" + ], + "summary": "List with basic information of State Machine resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineList", + "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 State Machine 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/StateMachine" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/state-machine?limit=25" + }, + "last": { + "example": "/state-machine?limit=25&page=11" + }, + "next": { + "example": "/state-machine?limit=25&page=4" + }, + "prev": { + "example": "/state-machine?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "State Machine" + ], + "summary": "Create a new State Machine resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createStateMachine", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine/{id}": { + "get": { + "tags": [ + "State Machine" + ], + "summary": "Detailed information about a State Machine resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachine", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "State Machine" + ], + "summary": "Delete a State Machine resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteStateMachine", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine", + "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": [ + "State Machine" + ], + "summary": "Partially update information about a State Machine resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateStateMachine", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine", + "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 State Machine resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-history": { + "get": { + "tags": [ + "State Machine History" + ], + "summary": "List with basic information of State Machine History resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineHistoryList", + "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 State Machine History 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/StateMachineHistory" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/state-machine-history?limit=25" + }, + "last": { + "example": "/state-machine-history?limit=25&page=11" + }, + "next": { + "example": "/state-machine-history?limit=25&page=4" + }, + "prev": { + "example": "/state-machine-history?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Create a new State Machine History resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createStateMachineHistory", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-history/{id}": { + "get": { + "tags": [ + "State Machine History" + ], + "summary": "Detailed information about a State Machine History resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineHistory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_history", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "State Machine History" + ], + "summary": "Delete a State Machine History resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteStateMachineHistory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_history", + "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": [ + "State Machine History" + ], + "summary": "Partially update information about a State Machine History resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateStateMachineHistory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_history", + "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 State Machine History resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-state": { + "get": { + "tags": [ + "State Machine State" + ], + "summary": "List with basic information of State Machine State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineStateList", + "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 State Machine State 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/StateMachineState" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/state-machine-state?limit=25" + }, + "last": { + "example": "/state-machine-state?limit=25&page=11" + }, + "next": { + "example": "/state-machine-state?limit=25&page=4" + }, + "prev": { + "example": "/state-machine-state?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Create a new State Machine State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createStateMachineState", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-state/{id}": { + "get": { + "tags": [ + "State Machine State" + ], + "summary": "Detailed information about a State Machine State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_state", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "State Machine State" + ], + "summary": "Delete a State Machine State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteStateMachineState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_state", + "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": [ + "State Machine State" + ], + "summary": "Partially update information about a State Machine State resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateStateMachineState", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_state", + "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 State Machine State resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-transition": { + "get": { + "tags": [ + "State Machine Transition" + ], + "summary": "List with basic information of State Machine Transition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineTransitionList", + "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 State Machine Transition 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/StateMachineTransition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/state-machine-transition?limit=25" + }, + "last": { + "example": "/state-machine-transition?limit=25&page=11" + }, + "next": { + "example": "/state-machine-transition?limit=25&page=4" + }, + "prev": { + "example": "/state-machine-transition?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Create a new State Machine Transition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createStateMachineTransition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-transition/{id}": { + "get": { + "tags": [ + "State Machine Transition" + ], + "summary": "Detailed information about a State Machine Transition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineTransition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_transition", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "State Machine Transition" + ], + "summary": "Delete a State Machine Transition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteStateMachineTransition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_transition", + "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": [ + "State Machine Transition" + ], + "summary": "Partially update information about a State Machine Transition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateStateMachineTransition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_transition", + "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 State Machine Transition resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/system-config": { + "get": { + "tags": [ + "System Config" + ], + "summary": "List with basic information of System Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSystemConfigList", + "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 System Config 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/SystemConfig" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/system-config?limit=25" + }, + "last": { + "example": "/system-config?limit=25&page=11" + }, + "next": { + "example": "/system-config?limit=25&page=4" + }, + "prev": { + "example": "/system-config?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "System Config" + ], + "summary": "Create a new System Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSystemConfig", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/system-config/{id}": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Detailed information about a System Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSystemConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the system_config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "System Config" + ], + "summary": "Delete a System Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSystemConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the system_config", + "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": [ + "System Config" + ], + "summary": "Partially update information about a System Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSystemConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the system_config", + "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 System Config resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tag": { + "get": { + "tags": [ + "Tag" + ], + "summary": "List with basic information of Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getTagList", + "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 Tag 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/Tag" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/tag?limit=25" + }, + "last": { + "example": "/tag?limit=25&page=11" + }, + "next": { + "example": "/tag?limit=25&page=4" + }, + "prev": { + "example": "/tag?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Tag" + ], + "summary": "Create a new Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTag", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tag/{id}": { + "get": { + "tags": [ + "Tag" + ], + "summary": "Detailed information about a Tag resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tag", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Tag" + ], + "summary": "Delete a Tag resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tag", + "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": [ + "Tag" + ], + "summary": "Partially update information about a Tag resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tag", + "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 Tag resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tag" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax": { + "get": { + "tags": [ + "Tax" + ], + "summary": "List with basic information of Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getTaxList", + "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 Tax 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/Tax" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/tax?limit=25" + }, + "last": { + "example": "/tax?limit=25&page=11" + }, + "next": { + "example": "/tax?limit=25&page=4" + }, + "prev": { + "example": "/tax?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Tax" + ], + "summary": "Create a new Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTax", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tax" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tax" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax/{id}": { + "get": { + "tags": [ + "Tax" + ], + "summary": "Detailed information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTax", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tax", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tax" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Tax" + ], + "summary": "Delete a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTax", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tax", + "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": [ + "Tax" + ], + "summary": "Partially update information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTax", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tax", + "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 Tax resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tax" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tax" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-provider": { + "get": { + "tags": [ + "Tax Provider" + ], + "summary": "List with basic information of Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProviderList", + "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 Tax Provider 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/TaxProvider" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/tax-provider?limit=25" + }, + "last": { + "example": "/tax-provider?limit=25&page=11" + }, + "next": { + "example": "/tax-provider?limit=25&page=4" + }, + "prev": { + "example": "/tax-provider?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Create a new Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "createTaxProvider", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-provider/{id}": { + "get": { + "tags": [ + "Tax Provider" + ], + "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 tax_provider", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Tax Provider" + ], + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tax_provider", + "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": [ + "Tax Provider" + ], + "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 tax_provider", + "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 Tax Provider resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-rule": { + "get": { + "tags": [ + "Tax Rule" + ], + "summary": "List with basic information of Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleList", + "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 Tax Rule 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/TaxRule" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/tax-rule?limit=25" + }, + "last": { + "example": "/tax-rule?limit=25&page=11" + }, + "next": { + "example": "/tax-rule?limit=25&page=4" + }, + "prev": { + "example": "/tax-rule?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Tax Rule" + ], + "summary": "Create a new Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRule", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-rule/{id}": { + "get": { + "tags": [ + "Tax Rule" + ], + "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_rule", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Tax Rule" + ], + "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_rule", + "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": [ + "Tax Rule" + ], + "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_rule", + "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 Tax Rule resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-rule-type": { + "get": { + "tags": [ + "Tax Rule Type" + ], + "summary": "List with basic information of Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleTypeList", + "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 Tax Rule Type 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/TaxRuleType" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/tax-rule-type?limit=25" + }, + "last": { + "example": "/tax-rule-type?limit=25&page=11" + }, + "next": { + "example": "/tax-rule-type?limit=25&page=4" + }, + "prev": { + "example": "/tax-rule-type?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Tax Rule Type" + ], + "summary": "Create a new Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRuleType", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-rule-type/{id}": { + "get": { + "tags": [ + "Tax Rule Type" + ], + "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_rule_type", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Tax Rule Type" + ], + "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_rule_type", + "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": [ + "Tax Rule Type" + ], + "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_rule_type", + "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 Tax Rule Type resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/theme": { + "get": { + "tags": [ + "Theme" + ], + "summary": "List with basic information of Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getThemeList", + "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 Theme 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/Theme" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/theme?limit=25" + }, + "last": { + "example": "/theme?limit=25&page=11" + }, + "next": { + "example": "/theme?limit=25&page=4" + }, + "prev": { + "example": "/theme?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Theme" + ], + "summary": "Create a new Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTheme", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/theme/{id}": { + "get": { + "tags": [ + "Theme" + ], + "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 theme", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Theme" + ], + "summary": "Delete a Theme resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTheme", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the theme", + "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": [ + "Theme" + ], + "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 theme", + "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 Theme resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/unit": { + "get": { + "tags": [ + "Unit" + ], + "summary": "List with basic information of Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUnitList", + "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 Unit 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/Unit" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/unit?limit=25" + }, + "last": { + "example": "/unit?limit=25&page=11" + }, + "next": { + "example": "/unit?limit=25&page=4" + }, + "prev": { + "example": "/unit?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Unit" + ], + "summary": "Create a new Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUnit", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/unit/{id}": { + "get": { + "tags": [ + "Unit" + ], + "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 unit", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Unit" + ], + "summary": "Delete a Unit resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUnit", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the unit", + "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": [ + "Unit" + ], + "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 unit", + "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 Unit resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Unit" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user": { + "get": { + "tags": [ + "User" + ], + "summary": "List with basic information of User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserList", + "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 User 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/User" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/user?limit=25" + }, + "last": { + "example": "/user?limit=25&page=11" + }, + "next": { + "example": "/user?limit=25&page=4" + }, + "prev": { + "example": "/user?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "User" + ], + "summary": "Create a new User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUser", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/User" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/User" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user/{id}": { + "get": { + "tags": [ + "User" + ], + "summary": "Detailed information about a User resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUser", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/User" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "User" + ], + "summary": "Delete a User resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUser", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user", + "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" + ], + "summary": "Partially update information about a User resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUser", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user", + "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 resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/User" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/User" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-access-key": { + "get": { + "tags": [ + "User Access Key" + ], + "summary": "List with basic information of User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKeyList", + "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 User Access Key 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/UserAccessKey" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/user-access-key?limit=25" + }, + "last": { + "example": "/user-access-key?limit=25&page=11" + }, + "next": { + "example": "/user-access-key?limit=25&page=4" + }, + "prev": { + "example": "/user-access-key?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Create a new User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserAccessKey", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-access-key/{id}": { + "get": { + "tags": [ + "User Access Key" + ], + "summary": "Detailed information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKey", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_access_key", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "User Access Key" + ], + "summary": "Delete a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserAccessKey", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_access_key", + "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 Access Key" + ], + "summary": "Partially update information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUserAccessKey", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_access_key", + "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 Access Key resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-config": { + "get": { + "tags": [ + "User Config" + ], + "summary": "List with basic information of User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfigList", + "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 User Config 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/UserConfig" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/user-config?limit=25" + }, + "last": { + "example": "/user-config?limit=25&page=11" + }, + "next": { + "example": "/user-config?limit=25&page=4" + }, + "prev": { + "example": "/user-config?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "User Config" + ], + "summary": "Create a new User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createUserConfig", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-config/{id}": { + "get": { + "tags": [ + "User Config" + ], + "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_config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "User Config" + ], + "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_config", + "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 Config" + ], + "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_config", + "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 Config resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-recovery": { + "get": { + "tags": [ + "User Recovery" + ], + "summary": "List with basic information of User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecoveryList", + "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 User Recovery 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/UserRecovery" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/user-recovery?limit=25" + }, + "last": { + "example": "/user-recovery?limit=25&page=11" + }, + "next": { + "example": "/user-recovery?limit=25&page=4" + }, + "prev": { + "example": "/user-recovery?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "User Recovery" + ], + "summary": "Create a new User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserRecovery", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserRecovery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-recovery/{id}": { + "get": { + "tags": [ + "User Recovery" + ], + "summary": "Detailed information about a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecovery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_recovery", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "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": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "User Recovery" + ], + "summary": "Delete a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserRecovery", + "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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserRecovery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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": [ - "Presentation" + "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" + ] + } + } ], - "summary": "Search presentations", - "description": "Return list of presentations", - "operationId": "searchPresentations", - "parameters": [], "requestBody": { - "required": false, "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GetListBodyRequest" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "", + "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": { + "$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": { + "$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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$ref": "#/components/schemas/Webhook" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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", @@ -44,45 +54298,340 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Presentation" + "$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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$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" }, - "aggregations": { - "type": "array", - "items": { - "type": "object" + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + } } } + ] + } + }, + "application/json": { + "schema": { + "$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", + "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 Event Log" + ], + "summary": "Partially update information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "updateWebhookEventLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the webhook_event_log", + "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 Event Log resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } } } + }, + "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": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/guided-shopping-presentation": { + "/search/guided-shopping-presentation": { "post": { "tags": [ "Presentation" ], - "summary": "Create a new presentation", - "description": "", - "operationId": "createPresentation", + "summary": "Search presentations", + "description": "Return list of presentations", + "operationId": "searchPresentations", "parameters": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Presentation" + "$ref": "#/components/schemas/GetListBodyRequest" } } } }, "responses": { - "204": { - "description": "" + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Presentation" + } + }, + "aggregations": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } } } } @@ -668,32 +55217,6 @@ } } }, - "/guided-shopping-appointment": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Create a new appointment", - "description": "", - "operationId": "createAppointment", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Appointment" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - } - }, "/guided-shopping-appointment/{appointmentId}": { "get": { "tags": [ @@ -1845,37 +56368,6 @@ } }, "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" @@ -2059,12 +56551,6 @@ "items": { "$ref": "#/components/schemas/AppFlowEvent" } - }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } } }, "type": "object" @@ -3273,202 +57759,6 @@ }, "type": "object" }, - "AppShippingMethodJsonApi": { - "description": "Added since version: 6.5.7.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "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": [ - "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": [ @@ -7045,10 +61335,6 @@ "labelProperty": { "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -7107,10 +61393,6 @@ "labelProperty": { "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, "createdAt": { "type": "string", "format": "date-time", @@ -10009,9 +64291,6 @@ "deepLinkCode": { "type": "string" }, - "documentNumber": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -10232,9 +64511,6 @@ "deepLinkCode": { "type": "string" }, - "documentNumber": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -16112,9 +70388,6 @@ "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" @@ -16884,37 +71157,6 @@ } }, "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" @@ -16982,9 +71224,6 @@ "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" @@ -17200,12 +71439,6 @@ "items": { "$ref": "#/components/schemas/AppPaymentMethod" } - }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } } }, "type": "object" @@ -17882,9 +72115,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "path": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -17968,9 +72198,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "path": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -23974,9 +78201,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -24323,9 +78547,6 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36558,9 +90779,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36846,35 +91064,6 @@ } }, "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" @@ -36936,9 +91125,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36993,9 +91179,6 @@ }, "tax": { "$ref": "#/components/schemas/Tax" - }, - "appShippingMethod": { - "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" @@ -41893,9 +96076,6 @@ "url": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, "errorCount": { "type": "integer", "format": "int64", @@ -41980,9 +96160,6 @@ "url": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, "errorCount": { "type": "integer", "format": "int64", @@ -42069,9 +96246,6 @@ "url": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -42143,9 +96317,6 @@ "url": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -42162,389 +96333,6 @@ }, "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" - } - } - } - } - }, - "flowBulderActionsResponse": { - "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" - } - } - } - }, - "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" - ] - } - } - }, "PresentationCmsPage": { "type": "object", "properties": { @@ -43892,12 +97680,8 @@ ], "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": "Acl Role", + "description": "The endpoint for operations on Acl Role" }, { "name": "App", @@ -43931,10 +97715,6 @@ "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" From c7421da0e089a7fa1584ea2c1bf7838c8f805f5f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 29 Nov 2023 14:07:24 +0100 Subject: [PATCH 05/63] [create-pull-request] automated change (#110) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 1500 ++++++++++++++++++++++++++-------- 1 file changed, 1141 insertions(+), 359 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 23eef9c..43bd573 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -3,7 +3,7 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.9999999.9999999-dev" + "version": "6.5.7.2" }, "servers": [ { @@ -4944,6 +4944,42 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_employee" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "businessPartnerCustomer": { @@ -5095,6 +5131,42 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_employee" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "businessPartnerCustomer": { "$ref": "#/components/schemas/Customer" }, @@ -10249,6 +10321,37 @@ } }, "type": "object" + }, + "quoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -11253,6 +11356,37 @@ } }, "type": "object" + }, + "quoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -36501,6 +36635,10 @@ "type": "string", "format": "date-time" }, + "sentAt": { + "type": "string", + "format": "date-time" + }, "price": { "required": [ "netPrice", @@ -37033,6 +37171,68 @@ } }, "type": "object" + }, + "comments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/comments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "a5d491060952aa8ad5fdee071be752de" + } + } + } + } + }, + "type": "object" + }, + "quoteEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/quoteEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_employee" + }, + "id": { + "type": "string", + "example": "2d59101091544ffd9a1d23090d6e2f0a" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -37115,6 +37315,10 @@ "type": "string", "format": "date-time" }, + "sentAt": { + "type": "string", + "format": "date-time" + }, "price": { "required": [ "netPrice", @@ -37336,22 +37540,31 @@ "items": { "$ref": "#/components/schemas/QuoteTransaction" } + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + }, + "quoteEmployees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } } }, "type": "object" }, - "QuoteDeliveryJsonApi": { - "description": "Added since version: 6.5.3.0", + "QuoteCommentJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "comment", "quoteId", - "shippingMethodId", - "shippingDateEarliest", - "shippingDateLatest", "createdAt" ], "properties": { @@ -37363,6 +37576,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "comment": { + "type": "string" + }, + "seenAt": { + "type": "string", + "format": "date-time" + }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -37371,77 +37591,323 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingDateEarliest": { + "customerId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "shippingDateLatest": { + "createdById": { "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" + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "quote": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/quote" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } + } + }, + "type": "object" + }, + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "QuoteComment": { + "required": [ + "comment", + "quoteId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "comment": { + "type": "string" + }, + "seenAt": { + "type": "string", + "format": "date-time" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "quote": { + "$ref": "#/components/schemas/Quote" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "QuoteDeliveryJsonApi": { + "description": "Added since version: 6.5.3.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "quoteId", + "shippingMethodId", + "shippingDateEarliest", + "shippingDateLatest", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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", @@ -37985,6 +38451,178 @@ }, "type": "object" }, + "QuoteEmployeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "quoteId", + "employeeId", + "firstName", + "lastName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "quote": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/quote" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } + } + }, + "type": "object" + }, + "employee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/employee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "QuoteEmployee": { + "required": [ + "quoteId", + "employeeId", + "firstName", + "lastName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "quote": { + "$ref": "#/components/schemas/Quote" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "type": "object" + }, "QuoteLineItemJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ @@ -38134,6 +38772,12 @@ }, "type": "object" }, + "productPrice": { + "type": "object" + }, + "purchasePrice": { + "type": "object" + }, "discount": { "properties": { "type": { @@ -38509,6 +39153,12 @@ }, "type": "object" }, + "productPrice": { + "type": "object" + }, + "purchasePrice": { + "type": "object" + }, "discount": { "properties": { "type": { @@ -45382,6 +46032,37 @@ } }, "type": "object" + }, + "quoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/quoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -45899,6 +46580,37 @@ } }, "type": "object" + }, + "quoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/quoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -50515,6 +51227,37 @@ } }, "type": "object" + }, + "createdQuoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "860bc13329c5b039ddeccbd9cced778d" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -51178,6 +51921,37 @@ } }, "type": "object" + }, + "createdQuoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "860bc13329c5b039ddeccbd9cced778d" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -52379,6 +53153,66 @@ }, "type": "object" }, + "flowBulderActionsResponse": { + "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" + } + } + } + }, + "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" + } + } + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -52441,190 +53275,6 @@ } } }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] - } - ] - }, - "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" - } - } - } - } - }, - "flowBulderActionsResponse": { - "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" - } - } - } - }, "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)", @@ -52762,6 +53412,234 @@ } } }, + "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" + ] + } + ] + }, + "CustomPricingResponse": { + "type": "object", + "required": [ + "success", + "data" + ], + "properties": { + "success": { + "type": "boolean" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "required": [ + "entities", + "errors" + ], + "properties": { + "entities": { + "type": "array", + "maxItems": 1, + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "errors": { + "type": "array", + "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", + "items": { + "type": "string" + } + } + } + } + }, + "extensions": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + }, + "CustomPricingDeleteOperation": { + "type": "object", + "required": [ + "action", + "payload" + ], + "properties": { + "action": { + "description": "A specific verb defining what operation should be actioned for a specific data record", + "type": "string", + "enum": [ + "delete" + ] + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "anyOf": [ + { + "title": "productIds", + "type": "array", + "description": "An array of product entity UUIDs", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "title": "customerIds", + "type": "array", + "description": "An array of customer entity UUIDs", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "title": "customerGroupIds", + "type": "array", + "description": "An array of customerGroup entity UUIDs", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ] + } + } + } + }, "CustomPricingUpsertOperation": { "type": "object", "required": [ @@ -52900,110 +53778,6 @@ } } } - }, - "CustomPricingDeleteOperation": { - "type": "object", - "required": [ - "action", - "payload" - ], - "properties": { - "action": { - "description": "A specific verb defining what operation should be actioned for a specific data record", - "type": "string", - "enum": [ - "delete" - ] - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "anyOf": [ - { - "title": "productIds", - "type": "array", - "description": "An array of product entity UUIDs", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "title": "customerIds", - "type": "array", - "description": "An array of customer entity UUIDs", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "title": "customerGroupIds", - "type": "array", - "description": "An array of customerGroup entity UUIDs", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ] - } - } - } - }, - "CustomPricingResponse": { - "type": "object", - "required": [ - "success", - "data" - ], - "properties": { - "success": { - "type": "boolean" - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "result": { - "type": "array", - "items": { - "type": "object", - "required": [ - "entities", - "errors" - ], - "properties": { - "entities": { - "type": "array", - "maxItems": 1, - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "errors": { - "type": "array", - "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", - "items": { - "type": "string" - } - } - } - } - }, - "extensions": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } } }, "responses": { @@ -53680,6 +54454,10 @@ "name": "Quote", "description": "The endpoint for operations on Quote" }, + { + "name": "Quote Comment", + "description": "The endpoint for operations on Quote Comment" + }, { "name": "Quote Delivery", "description": "The endpoint for operations on Quote Delivery" @@ -53688,6 +54466,10 @@ "name": "Quote Delivery Position", "description": "The endpoint for operations on Quote Delivery Position" }, + { + "name": "Quote Employee", + "description": "The endpoint for operations on Quote Employee" + }, { "name": "Quote Line Item", "description": "The endpoint for operations on Quote Line Item" From 2c936163237093418f02716ace711f68bb7a523b Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Fri, 1 Dec 2023 14:25:22 +0100 Subject: [PATCH 06/63] Remove bundle option --- .github/workflows/plugin_commercial_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index e1f9885..93bcb0b 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -26,7 +26,7 @@ jobs: needs: vars uses: shopware/docs-ci/.github/workflows/generate_schema.yml@main with: - schema_flags: -b ${{ needs.vars.outputs.PLUGIN_NAME }} + schema_flags: '' schema_file: ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json plugin_name: ${{ needs.vars.outputs.PLUGIN_NAME }} plugin_url: ${{ needs.vars.outputs.PLUGIN_URL }} From ff1b3cd60216118c03490a74af072b877490ed57 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Fri, 1 Dec 2023 14:34:25 +0100 Subject: [PATCH 07/63] Add delta script --- .github/scripts/find_delta_paths.sh | 23 +++++++++++++++++++ .../workflows/plugin_commercial_schema.yml | 1 + 2 files changed, 24 insertions(+) create mode 100644 .github/scripts/find_delta_paths.sh diff --git a/.github/scripts/find_delta_paths.sh b/.github/scripts/find_delta_paths.sh new file mode 100644 index 0000000..4f7561e --- /dev/null +++ b/.github/scripts/find_delta_paths.sh @@ -0,0 +1,23 @@ +#!/bin/bash + +adminapi_paths=$(jq '.paths' adminapi.json) +swag_paths=$(jq '.paths' $1-adminapi.json) + +adminapi_keys=$(echo "$adminapi_paths" | jq 'keys[]') +swag_keys=$(echo "$swag_paths" | jq 'keys[]') + +result_json=$(jq '.' $1-adminapi.json) + +for key in $swag_keys +do + # Check if key is in adminapi keys + if [[ "$adminapi_keys" == *"$key"* ]]; then + # Remove leading and trailing quotes from key + key="${key%\"}" + key="${key#\"}" + + result_json=$(echo "$result_json" | jq "del(.paths.\"$key\")") + fi +done + +echo "$result_json" > $1-adminapi.json diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index 93bcb0b..effa40c 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -53,6 +53,7 @@ jobs: sudo apt-get update sudo apt-get install -y moreutils jq . ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json | sponge ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json + ./.github/scripts/find_delta_paths.sh ${{ needs.vars.outputs.PLUGIN_NAME }} - name: Create DSR PR uses: peter-evans/create-pull-request@v4 From df08eac1c56481a96e36b586be97963ce8562831 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Fri, 1 Dec 2023 14:46:07 +0100 Subject: [PATCH 08/63] Fix permissions --- .github/scripts/find_delta_paths.sh | 0 1 file changed, 0 insertions(+), 0 deletions(-) mode change 100644 => 100755 .github/scripts/find_delta_paths.sh diff --git a/.github/scripts/find_delta_paths.sh b/.github/scripts/find_delta_paths.sh old mode 100644 new mode 100755 From 5282fba0a282679a0ccdd5cb120d4da66f0b1867 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 1 Dec 2023 14:54:46 +0100 Subject: [PATCH 09/63] [create-pull-request] automated change (#113) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 15095 ++++++++++++++++++++++++++++++++- 1 file changed, 15094 insertions(+), 1 deletion(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 43bd573..5380491 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -3,7 +3,7 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.7.2" + "version": "6.5.7.3" }, "servers": [ { @@ -11,6 +11,15099 @@ } ], "paths": { + "/advanced-search-action": { + "get": { + "tags": [ + "Advanced Search Action" + ], + "summary": "List with basic information of Advanced Search Action resources.", + "description": "", + "operationId": "getAdvancedSearchActionList", + "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 Advanced Search Action 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/AdvancedSearchAction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-action?limit=25" + }, + "last": { + "example": "/advanced-search-action?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-action?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-action?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Action" + ], + "summary": "Create a new Advanced Search Action resources.", + "description": "", + "operationId": "createAdvancedSearchAction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-action/{id}": { + "get": { + "tags": [ + "Advanced Search Action" + ], + "summary": "Detailed information about a Advanced Search Action resource.", + "description": "", + "operationId": "getAdvancedSearchAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Action" + ], + "summary": "Delete a Advanced Search Action resource.", + "description": "", + "operationId": "deleteAdvancedSearchAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action", + "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": [ + "Advanced Search Action" + ], + "summary": "Partially update information about a Advanced Search Action resource.", + "description": "", + "operationId": "updateAdvancedSearchAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action", + "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 Advanced Search Action resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-action-search-term": { + "get": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "List with basic information of Advanced Search Action Search Term resources.", + "description": "", + "operationId": "getAdvancedSearchActionSearchTermList", + "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 Advanced Search Action Search Term 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/AdvancedSearchActionSearchTerm" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-action-search-term?limit=25" + }, + "last": { + "example": "/advanced-search-action-search-term?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-action-search-term?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-action-search-term?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Create a new Advanced Search Action Search Term resources.", + "description": "", + "operationId": "createAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-action-search-term/{id}": { + "get": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Detailed information about a Advanced Search Action Search Term resource.", + "description": "", + "operationId": "getAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action_search_term", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Delete a Advanced Search Action Search Term resource.", + "description": "", + "operationId": "deleteAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action_search_term", + "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": [ + "Advanced Search Action Search Term" + ], + "summary": "Partially update information about a Advanced Search Action Search Term resource.", + "description": "", + "operationId": "updateAdvancedSearchActionSearchTerm", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_action_search_term", + "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 Advanced Search Action Search Term resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-boosting": { + "get": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "List with basic information of Advanced Search Boosting resources.", + "description": "", + "operationId": "getAdvancedSearchBoostingList", + "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 Advanced Search Boosting 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/AdvancedSearchBoosting" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-boosting?limit=25" + }, + "last": { + "example": "/advanced-search-boosting?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-boosting?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-boosting?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "Create a new Advanced Search Boosting resources.", + "description": "", + "operationId": "createAdvancedSearchBoosting", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchBoosting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-boosting/{id}": { + "get": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "Detailed information about a Advanced Search Boosting resource.", + "description": "", + "operationId": "getAdvancedSearchBoosting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_boosting", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchBoosting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "Delete a Advanced Search Boosting resource.", + "description": "", + "operationId": "deleteAdvancedSearchBoosting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_boosting", + "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": [ + "Advanced Search Boosting" + ], + "summary": "Partially update information about a Advanced Search Boosting resource.", + "description": "", + "operationId": "updateAdvancedSearchBoosting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_boosting", + "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 Advanced Search Boosting resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchBoosting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-config": { + "get": { + "tags": [ + "Advanced Search Config" + ], + "summary": "List with basic information of Advanced Search Config resources.", + "description": "", + "operationId": "getAdvancedSearchConfigList", + "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 Advanced Search Config 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/AdvancedSearchConfig" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-config?limit=25" + }, + "last": { + "example": "/advanced-search-config?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-config?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-config?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Config" + ], + "summary": "Create a new Advanced Search Config resources.", + "description": "", + "operationId": "createAdvancedSearchConfig", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-config/{id}": { + "get": { + "tags": [ + "Advanced Search Config" + ], + "summary": "Detailed information about a Advanced Search Config resource.", + "description": "", + "operationId": "getAdvancedSearchConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Config" + ], + "summary": "Delete a Advanced Search Config resource.", + "description": "", + "operationId": "deleteAdvancedSearchConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config", + "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": [ + "Advanced Search Config" + ], + "summary": "Partially update information about a Advanced Search Config resource.", + "description": "", + "operationId": "updateAdvancedSearchConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config", + "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 Advanced Search Config resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-config-field": { + "get": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "List with basic information of Advanced Search Config Field resources.", + "description": "", + "operationId": "getAdvancedSearchConfigFieldList", + "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 Advanced Search Config Field 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/AdvancedSearchConfigField" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-config-field?limit=25" + }, + "last": { + "example": "/advanced-search-config-field?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-config-field?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-config-field?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "Create a new Advanced Search Config Field resources.", + "description": "", + "operationId": "createAdvancedSearchConfigField", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-config-field/{id}": { + "get": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "Detailed information about a Advanced Search Config Field resource.", + "description": "", + "operationId": "getAdvancedSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config_field", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "Delete a Advanced Search Config Field resource.", + "description": "", + "operationId": "deleteAdvancedSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config_field", + "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": [ + "Advanced Search Config Field" + ], + "summary": "Partially update information about a Advanced Search Config Field resource.", + "description": "", + "operationId": "updateAdvancedSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config_field", + "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 Advanced Search Config Field resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-entity-stream": { + "get": { + "tags": [ + "Advanced Search Entity Stream" + ], + "summary": "List with basic information of Advanced Search Entity Stream resources.", + "description": "", + "operationId": "getAdvancedSearchEntityStreamList", + "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 Advanced Search Entity Stream 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/AdvancedSearchEntityStream" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-entity-stream?limit=25" + }, + "last": { + "example": "/advanced-search-entity-stream?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-entity-stream?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-entity-stream?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Entity Stream" + ], + "summary": "Create a new Advanced Search Entity Stream resources.", + "description": "", + "operationId": "createAdvancedSearchEntityStream", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-entity-stream/{id}": { + "get": { + "tags": [ + "Advanced Search Entity Stream" + ], + "summary": "Detailed information about a Advanced Search Entity Stream resource.", + "description": "", + "operationId": "getAdvancedSearchEntityStream", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Entity Stream" + ], + "summary": "Delete a Advanced Search Entity Stream resource.", + "description": "", + "operationId": "deleteAdvancedSearchEntityStream", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream", + "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": [ + "Advanced Search Entity Stream" + ], + "summary": "Partially update information about a Advanced Search Entity Stream resource.", + "description": "", + "operationId": "updateAdvancedSearchEntityStream", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream", + "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 Advanced Search Entity Stream resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-entity-stream-filter": { + "get": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "List with basic information of Advanced Search Entity Stream Filter resources.", + "description": "", + "operationId": "getAdvancedSearchEntityStreamFilterList", + "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 Advanced Search Entity Stream Filter 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/AdvancedSearchEntityStreamFilter" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-entity-stream-filter?limit=25" + }, + "last": { + "example": "/advanced-search-entity-stream-filter?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-entity-stream-filter?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-entity-stream-filter?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Create a new Advanced Search Entity Stream Filter resources.", + "description": "", + "operationId": "createAdvancedSearchEntityStreamFilter", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-entity-stream-filter/{id}": { + "get": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Detailed information about a Advanced Search Entity Stream Filter resource.", + "description": "", + "operationId": "getAdvancedSearchEntityStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream_filter", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Delete a Advanced Search Entity Stream Filter resource.", + "description": "", + "operationId": "deleteAdvancedSearchEntityStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream_filter", + "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": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Partially update information about a Advanced Search Entity Stream Filter resource.", + "description": "", + "operationId": "updateAdvancedSearchEntityStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream_filter", + "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 Advanced Search Entity Stream Filter resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-synonym": { + "get": { + "tags": [ + "Advanced Search Synonym" + ], + "summary": "List with basic information of Advanced Search Synonym resources.", + "description": "", + "operationId": "getAdvancedSearchSynonymList", + "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 Advanced Search Synonym 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/AdvancedSearchSynonym" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/advanced-search-synonym?limit=25" + }, + "last": { + "example": "/advanced-search-synonym?limit=25&page=11" + }, + "next": { + "example": "/advanced-search-synonym?limit=25&page=4" + }, + "prev": { + "example": "/advanced-search-synonym?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Advanced Search Synonym" + ], + "summary": "Create a new Advanced Search Synonym resources.", + "description": "", + "operationId": "createAdvancedSearchSynonym", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchSynonym", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-synonym/{id}": { + "get": { + "tags": [ + "Advanced Search Synonym" + ], + "summary": "Detailed information about a Advanced Search Synonym resource.", + "description": "", + "operationId": "getAdvancedSearchSynonym", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_synonym", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchSynonym", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Advanced Search Synonym" + ], + "summary": "Delete a Advanced Search Synonym resource.", + "description": "", + "operationId": "deleteAdvancedSearchSynonym", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_synonym", + "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": [ + "Advanced Search Synonym" + ], + "summary": "Partially update information about a Advanced Search Synonym resource.", + "description": "", + "operationId": "updateAdvancedSearchSynonym", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_synonym", + "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 Advanced Search Synonym resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AdvancedSearchSynonym", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-shipping-method": { + "get": { + "tags": [ + "App Shipping Method" + ], + "summary": "List with basic information of App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "getAppShippingMethodList", + "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 App Shipping Method 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/AppShippingMethod" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/app-shipping-method?limit=25" + }, + "last": { + "example": "/app-shipping-method?limit=25&page=11" + }, + "next": { + "example": "/app-shipping-method?limit=25&page=4" + }, + "prev": { + "example": "/app-shipping-method?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "App Shipping Method" + ], + "summary": "Create a new App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "createAppShippingMethod", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-shipping-method/{id}": { + "get": { + "tags": [ + "App Shipping Method" + ], + "summary": "Detailed information about a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "getAppShippingMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_shipping_method", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "App Shipping Method" + ], + "summary": "Delete a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "deleteAppShippingMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_shipping_method", + "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": [ + "App Shipping Method" + ], + "summary": "Partially update information about a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "updateAppShippingMethod", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the app_shipping_method", + "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 App Shipping Method resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-business-partner": { + "get": { + "tags": [ + "B2b Business Partner" + ], + "summary": "List with basic information of B2b Business Partner resources.", + "description": "", + "operationId": "getB2bBusinessPartnerList", + "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 B2b Business Partner 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/B2bBusinessPartner" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-business-partner?limit=25" + }, + "last": { + "example": "/b2b-business-partner?limit=25&page=11" + }, + "next": { + "example": "/b2b-business-partner?limit=25&page=4" + }, + "prev": { + "example": "/b2b-business-partner?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "B2b Business Partner" + ], + "summary": "Create a new B2b Business Partner resources.", + "description": "", + "operationId": "createB2bBusinessPartner", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bBusinessPartner", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-business-partner/{id}": { + "get": { + "tags": [ + "B2b Business Partner" + ], + "summary": "Detailed information about a B2b Business Partner resource.", + "description": "", + "operationId": "getB2bBusinessPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_business_partner", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of B2bBusinessPartner", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "B2b Business Partner" + ], + "summary": "Delete a B2b Business Partner resource.", + "description": "", + "operationId": "deleteB2bBusinessPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_business_partner", + "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": [ + "B2b Business Partner" + ], + "summary": "Partially update information about a B2b Business Partner resource.", + "description": "", + "operationId": "updateB2bBusinessPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_business_partner", + "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 B2b Business Partner resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bBusinessPartner", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-role": { + "get": { + "tags": [ + "B2b Components Role" + ], + "summary": "List with basic information of B2b Components Role resources.", + "description": "", + "operationId": "getB2bComponentsRoleList", + "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 B2b Components Role 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/B2bComponentsRole" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-components-role?limit=25" + }, + "last": { + "example": "/b2b-components-role?limit=25&page=11" + }, + "next": { + "example": "/b2b-components-role?limit=25&page=4" + }, + "prev": { + "example": "/b2b-components-role?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "B2b Components Role" + ], + "summary": "Create a new B2b Components Role resources.", + "description": "", + "operationId": "createB2bComponentsRole", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bComponentsRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-role/{id}": { + "get": { + "tags": [ + "B2b Components Role" + ], + "summary": "Detailed information about a B2b Components Role resource.", + "description": "", + "operationId": "getB2bComponentsRole", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_components_role", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of B2bComponentsRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "B2b Components Role" + ], + "summary": "Delete a B2b Components Role resource.", + "description": "", + "operationId": "deleteB2bComponentsRole", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_components_role", + "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": [ + "B2b Components Role" + ], + "summary": "Partially update information about a B2b Components Role resource.", + "description": "", + "operationId": "updateB2bComponentsRole", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_components_role", + "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 B2b Components Role resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bComponentsRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-employee": { + "get": { + "tags": [ + "B2b Employee" + ], + "summary": "List with basic information of B2b Employee resources.", + "description": "", + "operationId": "getB2bEmployeeList", + "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 B2b Employee 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/B2bEmployee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-employee?limit=25" + }, + "last": { + "example": "/b2b-employee?limit=25&page=11" + }, + "next": { + "example": "/b2b-employee?limit=25&page=4" + }, + "prev": { + "example": "/b2b-employee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "B2b Employee" + ], + "summary": "Create a new B2b Employee resources.", + "description": "", + "operationId": "createB2bEmployee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-employee/{id}": { + "get": { + "tags": [ + "B2b Employee" + ], + "summary": "Detailed information about a B2b Employee resource.", + "description": "", + "operationId": "getB2bEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_employee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of B2bEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "B2b Employee" + ], + "summary": "Delete a B2b Employee resource.", + "description": "", + "operationId": "deleteB2bEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_employee", + "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": [ + "B2b Employee" + ], + "summary": "Partially update information about a B2b Employee resource.", + "description": "", + "operationId": "updateB2bEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_employee", + "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 B2b Employee resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-order-employee": { + "get": { + "tags": [ + "B2b Order Employee" + ], + "summary": "List with basic information of B2b Order Employee resources.", + "description": "", + "operationId": "getB2bOrderEmployeeList", + "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 B2b Order Employee 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/B2bOrderEmployee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-order-employee?limit=25" + }, + "last": { + "example": "/b2b-order-employee?limit=25&page=11" + }, + "next": { + "example": "/b2b-order-employee?limit=25&page=4" + }, + "prev": { + "example": "/b2b-order-employee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "B2b Order Employee" + ], + "summary": "Create a new B2b Order Employee resources.", + "description": "", + "operationId": "createB2bOrderEmployee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bOrderEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-order-employee/{id}": { + "get": { + "tags": [ + "B2b Order Employee" + ], + "summary": "Detailed information about a B2b Order Employee resource.", + "description": "", + "operationId": "getB2bOrderEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_order_employee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of B2bOrderEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "B2b Order Employee" + ], + "summary": "Delete a B2b Order Employee resource.", + "description": "", + "operationId": "deleteB2bOrderEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_order_employee", + "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": [ + "B2b Order Employee" + ], + "summary": "Partially update information about a B2b Order Employee resource.", + "description": "", + "operationId": "updateB2bOrderEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_order_employee", + "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 B2b Order Employee resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bOrderEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-permission": { + "get": { + "tags": [ + "B2b Permission" + ], + "summary": "List with basic information of B2b Permission resources.", + "description": "", + "operationId": "getB2bPermissionList", + "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 B2b Permission 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/B2bPermission" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-permission?limit=25" + }, + "last": { + "example": "/b2b-permission?limit=25&page=11" + }, + "next": { + "example": "/b2b-permission?limit=25&page=4" + }, + "prev": { + "example": "/b2b-permission?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "B2b Permission" + ], + "summary": "Create a new B2b Permission resources.", + "description": "", + "operationId": "createB2bPermission", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bPermission", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-permission/{id}": { + "get": { + "tags": [ + "B2b Permission" + ], + "summary": "Detailed information about a B2b Permission resource.", + "description": "", + "operationId": "getB2bPermission", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_permission", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of B2bPermission", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "B2b Permission" + ], + "summary": "Delete a B2b Permission resource.", + "description": "", + "operationId": "deleteB2bPermission", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_permission", + "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": [ + "B2b Permission" + ], + "summary": "Partially update information about a B2b Permission resource.", + "description": "", + "operationId": "updateB2bPermission", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_permission", + "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 B2b Permission resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bPermission", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-price": { + "get": { + "tags": [ + "Custom Price" + ], + "summary": "List with basic information of Custom Price resources.", + "description": "", + "operationId": "getCustomPriceList", + "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 Custom 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/CustomPrice" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/custom-price?limit=25" + }, + "last": { + "example": "/custom-price?limit=25&page=11" + }, + "next": { + "example": "/custom-price?limit=25&page=4" + }, + "prev": { + "example": "/custom-price?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Custom Price" + ], + "summary": "Create a new Custom Price resources.", + "description": "", + "operationId": "createCustomPrice", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-price/{id}": { + "get": { + "tags": [ + "Custom Price" + ], + "summary": "Detailed information about a Custom Price resource.", + "description": "", + "operationId": "getCustomPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_price", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Custom Price" + ], + "summary": "Delete a Custom Price resource.", + "description": "", + "operationId": "deleteCustomPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_price", + "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": [ + "Custom Price" + ], + "summary": "Partially update information about a Custom Price resource.", + "description": "", + "operationId": "updateCustomPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_price", + "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 Custom Price resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-specific-features": { + "get": { + "tags": [ + "Customer Specific Features" + ], + "summary": "List with basic information of Customer Specific Features resources.", + "description": "", + "operationId": "getCustomerSpecificFeaturesList", + "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 Customer Specific Features 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/CustomerSpecificFeatures" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/customer-specific-features?limit=25" + }, + "last": { + "example": "/customer-specific-features?limit=25&page=11" + }, + "next": { + "example": "/customer-specific-features?limit=25&page=4" + }, + "prev": { + "example": "/customer-specific-features?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Customer Specific Features" + ], + "summary": "Create a new Customer Specific Features resources.", + "description": "", + "operationId": "createCustomerSpecificFeatures", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerSpecificFeatures", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-specific-features/{id}": { + "get": { + "tags": [ + "Customer Specific Features" + ], + "summary": "Detailed information about a Customer Specific Features resource.", + "description": "", + "operationId": "getCustomerSpecificFeatures", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_specific_features", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of CustomerSpecificFeatures", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Customer Specific Features" + ], + "summary": "Delete a Customer Specific Features resource.", + "description": "", + "operationId": "deleteCustomerSpecificFeatures", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_specific_features", + "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": [ + "Customer Specific Features" + ], + "summary": "Partially update information about a Customer Specific Features resource.", + "description": "", + "operationId": "updateCustomerSpecificFeatures", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the customer_specific_features", + "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 Customer Specific Features resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CustomerSpecificFeatures", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-ai-tag": { + "get": { + "tags": [ + "Media Ai Tag" + ], + "summary": "List with basic information of Media Ai Tag resources.", + "description": "", + "operationId": "getMediaAiTagList", + "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 Media Ai Tag 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/MediaAiTag" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/media-ai-tag?limit=25" + }, + "last": { + "example": "/media-ai-tag?limit=25&page=11" + }, + "next": { + "example": "/media-ai-tag?limit=25&page=4" + }, + "prev": { + "example": "/media-ai-tag?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Media Ai Tag" + ], + "summary": "Create a new Media Ai Tag resources.", + "description": "", + "operationId": "createMediaAiTag", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaAiTag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-ai-tag/{id}": { + "get": { + "tags": [ + "Media Ai Tag" + ], + "summary": "Detailed information about a Media Ai Tag resource.", + "description": "", + "operationId": "getMediaAiTag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_ai_tag", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of MediaAiTag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Media Ai Tag" + ], + "summary": "Delete a Media Ai Tag resource.", + "description": "", + "operationId": "deleteMediaAiTag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_ai_tag", + "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": [ + "Media Ai Tag" + ], + "summary": "Partially update information about a Media Ai Tag resource.", + "description": "", + "operationId": "updateMediaAiTag", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_ai_tag", + "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 Media Ai Tag resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaAiTag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-product-warehouse": { + "get": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "List with basic information of Order Product Warehouse resources.", + "description": "", + "operationId": "getOrderProductWarehouseList", + "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 Order Product Warehouse 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/OrderProductWarehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-product-warehouse?limit=25" + }, + "last": { + "example": "/order-product-warehouse?limit=25&page=11" + }, + "next": { + "example": "/order-product-warehouse?limit=25&page=4" + }, + "prev": { + "example": "/order-product-warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "Create a new Order Product Warehouse resources.", + "description": "", + "operationId": "createOrderProductWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-product-warehouse/{id}": { + "get": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "Detailed information about a Order Product Warehouse resource.", + "description": "", + "operationId": "getOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "Delete a Order Product Warehouse resource.", + "description": "", + "operationId": "deleteOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "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": [ + "Order Product Warehouse" + ], + "summary": "Partially update information about a Order Product Warehouse resource.", + "description": "", + "operationId": "updateOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "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 Order Product Warehouse resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return": { + "get": { + "tags": [ + "Order Return" + ], + "summary": "List with basic information of Order Return resources.", + "description": "", + "operationId": "getOrderReturnList", + "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 Order Return 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/OrderReturn" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return?limit=25" + }, + "last": { + "example": "/order-return?limit=25&page=11" + }, + "next": { + "example": "/order-return?limit=25&page=4" + }, + "prev": { + "example": "/order-return?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Return" + ], + "summary": "Create a new Order Return resources.", + "description": "", + "operationId": "createOrderReturn", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return/{id}": { + "get": { + "tags": [ + "Order Return" + ], + "summary": "Detailed information about a Order Return resource.", + "description": "", + "operationId": "getOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Return" + ], + "summary": "Delete a Order Return resource.", + "description": "", + "operationId": "deleteOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "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": [ + "Order Return" + ], + "summary": "Partially update information about a Order Return resource.", + "description": "", + "operationId": "updateOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "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 Order Return resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item": { + "get": { + "tags": [ + "Order Return Line Item" + ], + "summary": "List with basic information of Order Return Line Item resources.", + "description": "", + "operationId": "getOrderReturnLineItemList", + "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 Order Return Line Item 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/OrderReturnLineItem" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return-line-item?limit=25" + }, + "last": { + "example": "/order-return-line-item?limit=25&page=11" + }, + "next": { + "example": "/order-return-line-item?limit=25&page=4" + }, + "prev": { + "example": "/order-return-line-item?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Create a new Order Return Line Item resources.", + "description": "", + "operationId": "createOrderReturnLineItem", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item/{id}": { + "get": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Detailed information about a Order Return Line Item resource.", + "description": "", + "operationId": "getOrderReturnLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Delete a Order Return Line Item resource.", + "description": "", + "operationId": "deleteOrderReturnLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item", + "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": [ + "Order Return Line Item" + ], + "summary": "Partially update information about a Order Return Line Item resource.", + "description": "", + "operationId": "updateOrderReturnLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item", + "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 Order Return Line Item resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item-reason": { + "get": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "List with basic information of Order Return Line Item Reason resources.", + "description": "", + "operationId": "getOrderReturnLineItemReasonList", + "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 Order Return Line Item Reason 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/OrderReturnLineItemReason" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return-line-item-reason?limit=25" + }, + "last": { + "example": "/order-return-line-item-reason?limit=25&page=11" + }, + "next": { + "example": "/order-return-line-item-reason?limit=25&page=4" + }, + "prev": { + "example": "/order-return-line-item-reason?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Create a new Order Return Line Item Reason resources.", + "description": "", + "operationId": "createOrderReturnLineItemReason", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item-reason/{id}": { + "get": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Detailed information about a Order Return Line Item Reason resource.", + "description": "", + "operationId": "getOrderReturnLineItemReason", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item_reason", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Delete a Order Return Line Item Reason resource.", + "description": "", + "operationId": "deleteOrderReturnLineItemReason", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item_reason", + "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": [ + "Order Return Line Item Reason" + ], + "summary": "Partially update information about a Order Return Line Item Reason resource.", + "description": "", + "operationId": "updateOrderReturnLineItemReason", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item_reason", + "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 Order Return Line Item Reason resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-warehouse-group": { + "get": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "List with basic information of Order Warehouse Group resources.", + "description": "", + "operationId": "getOrderWarehouseGroupList", + "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 Order 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/OrderWarehouseGroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-warehouse-group?limit=25" + }, + "last": { + "example": "/order-warehouse-group?limit=25&page=11" + }, + "next": { + "example": "/order-warehouse-group?limit=25&page=4" + }, + "prev": { + "example": "/order-warehouse-group?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Create a new Order Warehouse Group resources.", + "description": "", + "operationId": "createOrderWarehouseGroup", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-warehouse-group/{id}": { + "get": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Detailed information about a Order Warehouse Group resource.", + "description": "", + "operationId": "getOrderWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_warehouse_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Delete a Order Warehouse Group resource.", + "description": "", + "operationId": "deleteOrderWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_warehouse_group", + "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": [ + "Order Warehouse Group" + ], + "summary": "Partially update information about a Order Warehouse Group resource.", + "description": "", + "operationId": "updateOrderWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_warehouse_group", + "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 Order Warehouse Group resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review-summary": { + "get": { + "tags": [ + "Product Review Summary" + ], + "summary": "List with basic information of Product Review Summary resources.", + "description": "", + "operationId": "getProductReviewSummaryList", + "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 Product Review Summary 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/ProductReviewSummary" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-review-summary?limit=25" + }, + "last": { + "example": "/product-review-summary?limit=25&page=11" + }, + "next": { + "example": "/product-review-summary?limit=25&page=4" + }, + "prev": { + "example": "/product-review-summary?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Review Summary" + ], + "summary": "Create a new Product Review Summary resources.", + "description": "", + "operationId": "createProductReviewSummary", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review-summary/{id}": { + "get": { + "tags": [ + "Product Review Summary" + ], + "summary": "Detailed information about a Product Review Summary resource.", + "description": "", + "operationId": "getProductReviewSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review_summary", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Review Summary" + ], + "summary": "Delete a Product Review Summary resource.", + "description": "", + "operationId": "deleteProductReviewSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review_summary", + "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": [ + "Product Review Summary" + ], + "summary": "Partially update information about a Product Review Summary resource.", + "description": "", + "operationId": "updateProductReviewSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review_summary", + "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 Product Review Summary resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-warehouse": { + "get": { + "tags": [ + "Product Warehouse" + ], + "summary": "List with basic information of Product Warehouse resources.", + "description": "", + "operationId": "getProductWarehouseList", + "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 Product Warehouse 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/ProductWarehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-warehouse?limit=25" + }, + "last": { + "example": "/product-warehouse?limit=25&page=11" + }, + "next": { + "example": "/product-warehouse?limit=25&page=4" + }, + "prev": { + "example": "/product-warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Warehouse" + ], + "summary": "Create a new Product Warehouse resources.", + "description": "", + "operationId": "createProductWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-warehouse/{id}": { + "get": { + "tags": [ + "Product Warehouse" + ], + "summary": "Detailed information about a Product Warehouse resource.", + "description": "", + "operationId": "getProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Warehouse" + ], + "summary": "Delete a Product Warehouse resource.", + "description": "", + "operationId": "deleteProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_warehouse", + "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": [ + "Product Warehouse" + ], + "summary": "Partially update information about a Product Warehouse resource.", + "description": "", + "operationId": "updateProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_warehouse", + "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 Product Warehouse resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote": { + "get": { + "tags": [ + "Quote" + ], + "summary": "List with basic information of Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteList", + "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 Quote 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/Quote" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote?limit=25" + }, + "last": { + "example": "/quote?limit=25&page=11" + }, + "next": { + "example": "/quote?limit=25&page=4" + }, + "prev": { + "example": "/quote?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote" + ], + "summary": "Create a new Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuote", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote/{id}": { + "get": { + "tags": [ + "Quote" + ], + "summary": "Detailed information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote" + ], + "summary": "Delete a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote", + "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": [ + "Quote" + ], + "summary": "Partially update information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote", + "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 Quote resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-comment": { + "get": { + "tags": [ + "Quote Comment" + ], + "summary": "List with basic information of Quote Comment resources.", + "description": "", + "operationId": "getQuoteCommentList", + "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 Quote Comment 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/QuoteComment" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-comment?limit=25" + }, + "last": { + "example": "/quote-comment?limit=25&page=11" + }, + "next": { + "example": "/quote-comment?limit=25&page=4" + }, + "prev": { + "example": "/quote-comment?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Comment" + ], + "summary": "Create a new Quote Comment resources.", + "description": "", + "operationId": "createQuoteComment", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-comment/{id}": { + "get": { + "tags": [ + "Quote Comment" + ], + "summary": "Detailed information about a Quote Comment resource.", + "description": "", + "operationId": "getQuoteComment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_comment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Comment" + ], + "summary": "Delete a Quote Comment resource.", + "description": "", + "operationId": "deleteQuoteComment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_comment", + "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": [ + "Quote Comment" + ], + "summary": "Partially update information about a Quote Comment resource.", + "description": "", + "operationId": "updateQuoteComment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_comment", + "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 Quote Comment resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery": { + "get": { + "tags": [ + "Quote Delivery" + ], + "summary": "List with basic information of Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryList", + "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 Quote Delivery 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/QuoteDelivery" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-delivery?limit=25" + }, + "last": { + "example": "/quote-delivery?limit=25&page=11" + }, + "next": { + "example": "/quote-delivery?limit=25&page=4" + }, + "prev": { + "example": "/quote-delivery?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Delivery" + ], + "summary": "Create a new Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDelivery", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery/{id}": { + "get": { + "tags": [ + "Quote Delivery" + ], + "summary": "Detailed information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Delivery" + ], + "summary": "Delete a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery", + "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": [ + "Quote Delivery" + ], + "summary": "Partially update information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery", + "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 Quote Delivery resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery-position": { + "get": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", + "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 Quote Delivery Position 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/QuoteDeliveryPosition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-delivery-position?limit=25" + }, + "last": { + "example": "/quote-delivery-position?limit=25&page=11" + }, + "next": { + "example": "/quote-delivery-position?limit=25&page=4" + }, + "prev": { + "example": "/quote-delivery-position?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery-position/{id}": { + "get": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Detailed information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Delete a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "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": [ + "Quote Delivery Position" + ], + "summary": "Partially update information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "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 Quote Delivery Position resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-employee": { + "get": { + "tags": [ + "Quote Employee" + ], + "summary": "List with basic information of Quote Employee resources.", + "description": "", + "operationId": "getQuoteEmployeeList", + "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 Quote Employee 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/QuoteEmployee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-employee?limit=25" + }, + "last": { + "example": "/quote-employee?limit=25&page=11" + }, + "next": { + "example": "/quote-employee?limit=25&page=4" + }, + "prev": { + "example": "/quote-employee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Employee" + ], + "summary": "Create a new Quote Employee resources.", + "description": "", + "operationId": "createQuoteEmployee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-employee/{id}": { + "get": { + "tags": [ + "Quote Employee" + ], + "summary": "Detailed information about a Quote Employee resource.", + "description": "", + "operationId": "getQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Employee" + ], + "summary": "Delete a Quote Employee resource.", + "description": "", + "operationId": "deleteQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "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": [ + "Quote Employee" + ], + "summary": "Partially update information about a Quote Employee resource.", + "description": "", + "operationId": "updateQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "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 Quote Employee resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-line-item": { + "get": { + "tags": [ + "Quote Line Item" + ], + "summary": "List with basic information of Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItemList", + "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 Quote Line Item 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/QuoteLineItem" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-line-item?limit=25" + }, + "last": { + "example": "/quote-line-item?limit=25&page=11" + }, + "next": { + "example": "/quote-line-item?limit=25&page=4" + }, + "prev": { + "example": "/quote-line-item?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Line Item" + ], + "summary": "Create a new Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteLineItem", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-line-item/{id}": { + "get": { + "tags": [ + "Quote Line Item" + ], + "summary": "Detailed information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_line_item", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Line Item" + ], + "summary": "Delete a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_line_item", + "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": [ + "Quote Line Item" + ], + "summary": "Partially update information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_line_item", + "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 Quote Line Item resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-transaction": { + "get": { + "tags": [ + "Quote Transaction" + ], + "summary": "List with basic information of Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", + "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 Quote Transaction 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/QuoteTransaction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-transaction?limit=25" + }, + "last": { + "example": "/quote-transaction?limit=25&page=11" + }, + "next": { + "example": "/quote-transaction?limit=25&page=4" + }, + "prev": { + "example": "/quote-transaction?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Transaction" + ], + "summary": "Create a new Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-transaction/{id}": { + "get": { + "tags": [ + "Quote Transaction" + ], + "summary": "Detailed information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_transaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Transaction" + ], + "summary": "Delete a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_transaction", + "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": [ + "Quote Transaction" + ], + "summary": "Partially update information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_transaction", + "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 Quote Transaction resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription": { + "get": { + "tags": [ + "Subscription" + ], + "summary": "List with basic information of Subscription resources.", + "description": "", + "operationId": "getSubscriptionList", + "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 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/Subscription" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription?limit=25" + }, + "last": { + "example": "/subscription?limit=25&page=11" + }, + "next": { + "example": "/subscription?limit=25&page=4" + }, + "prev": { + "example": "/subscription?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription" + ], + "summary": "Create a new Subscription resources.", + "description": "", + "operationId": "createSubscription", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription/{id}": { + "get": { + "tags": [ + "Subscription" + ], + "summary": "Detailed information about a Subscription resource.", + "description": "", + "operationId": "getSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription" + ], + "summary": "Delete a Subscription resource.", + "description": "", + "operationId": "deleteSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "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" + ], + "summary": "Partially update information about a Subscription resource.", + "description": "", + "operationId": "updateSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "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 resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-address": { + "get": { + "tags": [ + "Subscription Address" + ], + "summary": "List with basic information of Subscription Address resources.", + "description": "", + "operationId": "getSubscriptionAddressList", + "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 Address 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/SubscriptionAddress" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-address?limit=25" + }, + "last": { + "example": "/subscription-address?limit=25&page=11" + }, + "next": { + "example": "/subscription-address?limit=25&page=4" + }, + "prev": { + "example": "/subscription-address?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Address" + ], + "summary": "Create a new Subscription Address resources.", + "description": "", + "operationId": "createSubscriptionAddress", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-address/{id}": { + "get": { + "tags": [ + "Subscription Address" + ], + "summary": "Detailed information about a Subscription Address resource.", + "description": "", + "operationId": "getSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Address" + ], + "summary": "Delete a Subscription Address resource.", + "description": "", + "operationId": "deleteSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "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 Address" + ], + "summary": "Partially update information about a Subscription Address resource.", + "description": "", + "operationId": "updateSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "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 Address resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-customer": { + "get": { + "tags": [ + "Subscription Customer" + ], + "summary": "List with basic information of Subscription Customer resources.", + "description": "", + "operationId": "getSubscriptionCustomerList", + "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 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/SubscriptionCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-customer?limit=25" + }, + "last": { + "example": "/subscription-customer?limit=25&page=11" + }, + "next": { + "example": "/subscription-customer?limit=25&page=4" + }, + "prev": { + "example": "/subscription-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Customer" + ], + "summary": "Create a new Subscription Customer resources.", + "description": "", + "operationId": "createSubscriptionCustomer", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-customer/{id}": { + "get": { + "tags": [ + "Subscription Customer" + ], + "summary": "Detailed information about a Subscription Customer resource.", + "description": "", + "operationId": "getSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Customer" + ], + "summary": "Delete a Subscription Customer resource.", + "description": "", + "operationId": "deleteSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Subscription Customer" + ], + "summary": "Partially update information about a Subscription Customer resource.", + "description": "", + "operationId": "updateSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Subscription Customer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-interval": { + "get": { + "tags": [ + "Subscription Interval" + ], + "summary": "List with basic information of Subscription Interval resources.", + "description": "", + "operationId": "getSubscriptionIntervalList", + "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 Interval 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/SubscriptionInterval" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-interval?limit=25" + }, + "last": { + "example": "/subscription-interval?limit=25&page=11" + }, + "next": { + "example": "/subscription-interval?limit=25&page=4" + }, + "prev": { + "example": "/subscription-interval?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Interval" + ], + "summary": "Create a new Subscription Interval resources.", + "description": "", + "operationId": "createSubscriptionInterval", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-interval/{id}": { + "get": { + "tags": [ + "Subscription Interval" + ], + "summary": "Detailed information about a Subscription Interval resource.", + "description": "", + "operationId": "getSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Interval" + ], + "summary": "Delete a Subscription Interval resource.", + "description": "", + "operationId": "deleteSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "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 Interval" + ], + "summary": "Partially update information about a Subscription Interval resource.", + "description": "", + "operationId": "updateSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "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 Interval resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$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": { + "$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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$ref": "#/components/schemas/SubscriptionPlan" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-delay-action": { + "get": { + "tags": [ + "Swag Delay Action" + ], + "summary": "List with basic information of Swag Delay Action resources.", + "description": "", + "operationId": "getSwagDelayActionList", + "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 Delay Action 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/SwagDelayAction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-delay-action?limit=25" + }, + "last": { + "example": "/swag-delay-action?limit=25&page=11" + }, + "next": { + "example": "/swag-delay-action?limit=25&page=4" + }, + "prev": { + "example": "/swag-delay-action?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Create a new Swag Delay Action resources.", + "description": "", + "operationId": "createSwagDelayAction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-delay-action/{id}": { + "get": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Detailed information about a Swag Delay Action resource.", + "description": "", + "operationId": "getSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Delete a Swag Delay Action resource.", + "description": "", + "operationId": "deleteSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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 Delay Action" + ], + "summary": "Partially update information about a Swag Delay Action resource.", + "description": "", + "operationId": "updateSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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 Delay Action resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "List with basic information of Warehouse resources.", + "description": "", + "operationId": "getWarehouseList", + "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 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/Warehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/warehouse?limit=25" + }, + "last": { + "example": "/warehouse?limit=25&page=11" + }, + "next": { + "example": "/warehouse?limit=25&page=4" + }, + "prev": { + "example": "/warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Create a new Warehouse resources.", + "description": "", + "operationId": "createWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse/{id}": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "Detailed information about a Warehouse resource.", + "description": "", + "operationId": "getWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse" + ], + "summary": "Delete a Warehouse resource.", + "description": "", + "operationId": "deleteWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "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": [ + "Warehouse" + ], + "summary": "Partially update information about a Warehouse resource.", + "description": "", + "operationId": "updateWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "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 Warehouse resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse-group/{id}": { + "get": { + "tags": [ + "Warehouse Group" + ], + "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}$" + } + } + ], + "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": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse Group" + ], + "summary": "Delete a Warehouse Group resource.", + "description": "", + "operationId": "deleteWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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": [ + "Warehouse Group" + ], + "summary": "Partially update information about a Warehouse Group resource.", + "description": "", + "operationId": "updateWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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 Warehouse Group resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/_action/custom-price": { "post": { "tags": [ From 35bf3a39637a7a22dc4697a90f5eeaad1bd653b9 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Fri, 1 Dec 2023 15:02:04 +0100 Subject: [PATCH 10/63] Add guided shopping --- .github/workflows/plugin_digitalsalesroom_schema.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 9f2d7d3..5aff07c 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -59,7 +59,8 @@ jobs: sudo apt-get update sudo apt-get install -y moreutils jq . ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json | sponge ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json - + ./.github/scripts/find_delta_paths.sh ${{ needs.vars.outputs.PLUGIN_NAME }} + - name: Create DSR PR uses: peter-evans/create-pull-request@v4 with: From 5a73dcf14bbc22b9dddf43188704a4303e796c0c Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Fri, 1 Dec 2023 15:08:34 +0100 Subject: [PATCH 11/63] Fix pwa version --- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 5aff07c..649736c 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -11,7 +11,7 @@ on: env: PLUGIN_NAME: SwagGuidedShopping PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagguidedshopping.git - COMPOSER_PACKAGES: shopware-pwa/shopware-pwa dev-master symfony/mercure ^0.6.2 spatie/icalendar-generator ^2.5 + COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.4 symfony/mercure ^0.6.2 spatie/icalendar-generator ^2.5 # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: From a8adca2cdb0ea80a3f4b54c1de8c9375140046eb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 1 Dec 2023 15:13:20 +0100 Subject: [PATCH 12/63] [create-pull-request] automated change (#114) Co-authored-by: shopwareBot --- SwagGuidedShopping-adminapi.json | 56876 +---------------------------- 1 file changed, 1548 insertions(+), 55328 deletions(-) diff --git a/SwagGuidedShopping-adminapi.json b/SwagGuidedShopping-adminapi.json index 0664f8f..c0f0c4e 100644 --- a/SwagGuidedShopping-adminapi.json +++ b/SwagGuidedShopping-adminapi.json @@ -3,7 +3,7 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.6.1" + "version": "6.5.7.3" }, "servers": [ { @@ -11,54730 +11,6 @@ } ], "paths": { - "/acl-role": { - "get": { - "tags": [ - "Acl Role" - ], - "summary": "List with basic information of Acl Role resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getAclRoleList", - "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 Acl Role 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/AclRole" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/acl-role?limit=25" - }, - "last": { - "example": "/acl-role?limit=25&page=11" - }, - "next": { - "example": "/acl-role?limit=25&page=4" - }, - "prev": { - "example": "/acl-role?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Acl Role" - ], - "summary": "Create a new Acl Role resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createAclRole", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AclRole" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AclRole", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AclRole" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/acl-role/{id}": { - "get": { - "tags": [ - "Acl Role" - ], - "summary": "Detailed information about a Acl Role resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getAclRole", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the acl_role", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AclRole", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AclRole" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Acl Role" - ], - "summary": "Delete a Acl Role resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteAclRole", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the acl_role", - "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": [ - "Acl Role" - ], - "summary": "Partially update information about a Acl Role resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateAclRole", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the acl_role", - "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 Acl Role resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AclRole" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AclRole", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AclRole" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app": { - "get": { - "tags": [ - "App" - ], - "summary": "List with basic information of App resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppList", - "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 App 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/App" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app?limit=25" - }, - "last": { - "example": "/app?limit=25&page=11" - }, - "next": { - "example": "/app?limit=25&page=4" - }, - "prev": { - "example": "/app?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/App" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App" - ], - "summary": "Create a new App resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createApp", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/App" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of App", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/App" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app/{id}": { - "get": { - "tags": [ - "App" - ], - "summary": "Detailed information about a App resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getApp", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of App", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/App" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App" - ], - "summary": "Delete a App resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteApp", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app", - "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": [ - "App" - ], - "summary": "Partially update information about a App resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateApp", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app", - "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 App resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/App" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of App", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/App" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-action-button": { - "get": { - "tags": [ - "App Action Button" - ], - "summary": "List with basic information of App Action Button resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppActionButtonList", - "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 App Action Button 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/AppActionButton" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-action-button?limit=25" - }, - "last": { - "example": "/app-action-button?limit=25&page=11" - }, - "next": { - "example": "/app-action-button?limit=25&page=4" - }, - "prev": { - "example": "/app-action-button?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Action Button" - ], - "summary": "Create a new App Action Button resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createAppActionButton", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppActionButton", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-action-button/{id}": { - "get": { - "tags": [ - "App Action Button" - ], - "summary": "Detailed information about a App Action Button resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppActionButton", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_action_button", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppActionButton", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Action Button" - ], - "summary": "Delete a App Action Button resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteAppActionButton", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_action_button", - "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": [ - "App Action Button" - ], - "summary": "Partially update information about a App Action Button resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateAppActionButton", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_action_button", - "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 App Action Button resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppActionButton", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-administration-snippet": { - "get": { - "tags": [ - "App Administration Snippet" - ], - "summary": "List with basic information of App Administration Snippet resources.", - "description": "Available since: 6.4.15.0", - "operationId": "getAppAdministrationSnippetList", - "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 App Administration Snippet 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/AppAdministrationSnippet" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-administration-snippet?limit=25" - }, - "last": { - "example": "/app-administration-snippet?limit=25&page=11" - }, - "next": { - "example": "/app-administration-snippet?limit=25&page=4" - }, - "prev": { - "example": "/app-administration-snippet?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Administration Snippet" - ], - "summary": "Create a new App Administration Snippet resources.", - "description": "Available since: 6.4.15.0", - "operationId": "createAppAdministrationSnippet", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppAdministrationSnippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-administration-snippet/{id}": { - "get": { - "tags": [ - "App Administration Snippet" - ], - "summary": "Detailed information about a App Administration Snippet resource.", - "description": "Available since: 6.4.15.0", - "operationId": "getAppAdministrationSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_administration_snippet", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppAdministrationSnippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Administration Snippet" - ], - "summary": "Delete a App Administration Snippet resource.", - "description": "Available since: 6.4.15.0", - "operationId": "deleteAppAdministrationSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_administration_snippet", - "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": [ - "App Administration Snippet" - ], - "summary": "Partially update information about a App Administration Snippet resource.", - "description": "Available since: 6.4.15.0", - "operationId": "updateAppAdministrationSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_administration_snippet", - "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 App Administration Snippet resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppAdministrationSnippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-cms-block": { - "get": { - "tags": [ - "App Cms Block" - ], - "summary": "List with basic information of App Cms Block resources.", - "description": "Available since: 6.4.2.0", - "operationId": "getAppCmsBlockList", - "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 App Cms Block 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/AppCmsBlock" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-cms-block?limit=25" - }, - "last": { - "example": "/app-cms-block?limit=25&page=11" - }, - "next": { - "example": "/app-cms-block?limit=25&page=4" - }, - "prev": { - "example": "/app-cms-block?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Cms Block" - ], - "summary": "Create a new App Cms Block resources.", - "description": "Available since: 6.4.2.0", - "operationId": "createAppCmsBlock", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppCmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-cms-block/{id}": { - "get": { - "tags": [ - "App Cms Block" - ], - "summary": "Detailed information about a App Cms Block resource.", - "description": "Available since: 6.4.2.0", - "operationId": "getAppCmsBlock", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_cms_block", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppCmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Cms Block" - ], - "summary": "Delete a App Cms Block resource.", - "description": "Available since: 6.4.2.0", - "operationId": "deleteAppCmsBlock", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_cms_block", - "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": [ - "App Cms Block" - ], - "summary": "Partially update information about a App Cms Block resource.", - "description": "Available since: 6.4.2.0", - "operationId": "updateAppCmsBlock", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_cms_block", - "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 App Cms Block resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppCmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-flow-action": { - "get": { - "tags": [ - "App Flow Action" - ], - "summary": "List with basic information of App Flow Action resources.", - "description": "Available since: 6.4.10.0", - "operationId": "getAppFlowActionList", - "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 App Flow Action 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/AppFlowAction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-flow-action?limit=25" - }, - "last": { - "example": "/app-flow-action?limit=25&page=11" - }, - "next": { - "example": "/app-flow-action?limit=25&page=4" - }, - "prev": { - "example": "/app-flow-action?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Flow Action" - ], - "summary": "Create a new App Flow Action resources.", - "description": "Available since: 6.4.10.0", - "operationId": "createAppFlowAction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppFlowAction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-flow-action/{id}": { - "get": { - "tags": [ - "App Flow Action" - ], - "summary": "Detailed information about a App Flow Action resource.", - "description": "Available since: 6.4.10.0", - "operationId": "getAppFlowAction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_flow_action", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppFlowAction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Flow Action" - ], - "summary": "Delete a App Flow Action resource.", - "description": "Available since: 6.4.10.0", - "operationId": "deleteAppFlowAction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_flow_action", - "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": [ - "App Flow Action" - ], - "summary": "Partially update information about a App Flow Action resource.", - "description": "Available since: 6.4.10.0", - "operationId": "updateAppFlowAction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_flow_action", - "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 App Flow Action resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppFlowAction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-flow-event": { - "get": { - "tags": [ - "App Flow Event" - ], - "summary": "List with basic information of App Flow Event resources.", - "description": "Available since: 6.5.2.0", - "operationId": "getAppFlowEventList", - "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 App Flow Event 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/AppFlowEvent" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-flow-event?limit=25" - }, - "last": { - "example": "/app-flow-event?limit=25&page=11" - }, - "next": { - "example": "/app-flow-event?limit=25&page=4" - }, - "prev": { - "example": "/app-flow-event?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Flow Event" - ], - "summary": "Create a new App Flow Event resources.", - "description": "Available since: 6.5.2.0", - "operationId": "createAppFlowEvent", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppFlowEvent", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-flow-event/{id}": { - "get": { - "tags": [ - "App Flow Event" - ], - "summary": "Detailed information about a App Flow Event resource.", - "description": "Available since: 6.5.2.0", - "operationId": "getAppFlowEvent", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_flow_event", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppFlowEvent", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Flow Event" - ], - "summary": "Delete a App Flow Event resource.", - "description": "Available since: 6.5.2.0", - "operationId": "deleteAppFlowEvent", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_flow_event", - "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": [ - "App Flow Event" - ], - "summary": "Partially update information about a App Flow Event resource.", - "description": "Available since: 6.5.2.0", - "operationId": "updateAppFlowEvent", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_flow_event", - "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 App Flow Event resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppFlowEvent", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-payment-method": { - "get": { - "tags": [ - "App Payment Method" - ], - "summary": "List with basic information of App Payment Method resources.", - "description": "Available since: 6.4.1.0", - "operationId": "getAppPaymentMethodList", - "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 App Payment Method 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/AppPaymentMethod" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-payment-method?limit=25" - }, - "last": { - "example": "/app-payment-method?limit=25&page=11" - }, - "next": { - "example": "/app-payment-method?limit=25&page=4" - }, - "prev": { - "example": "/app-payment-method?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Payment Method" - ], - "summary": "Create a new App Payment Method resources.", - "description": "Available since: 6.4.1.0", - "operationId": "createAppPaymentMethod", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppPaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-payment-method/{id}": { - "get": { - "tags": [ - "App Payment Method" - ], - "summary": "Detailed information about a App Payment Method resource.", - "description": "Available since: 6.4.1.0", - "operationId": "getAppPaymentMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_payment_method", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppPaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Payment Method" - ], - "summary": "Delete a App Payment Method resource.", - "description": "Available since: 6.4.1.0", - "operationId": "deleteAppPaymentMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_payment_method", - "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": [ - "App Payment Method" - ], - "summary": "Partially update information about a App Payment Method resource.", - "description": "Available since: 6.4.1.0", - "operationId": "updateAppPaymentMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_payment_method", - "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 App Payment Method resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppPaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-script-condition": { - "get": { - "tags": [ - "App Script Condition" - ], - "summary": "List with basic information of App Script Condition resources.", - "description": "Available since: 6.4.10.3", - "operationId": "getAppScriptConditionList", - "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 App Script Condition 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/AppScriptCondition" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-script-condition?limit=25" - }, - "last": { - "example": "/app-script-condition?limit=25&page=11" - }, - "next": { - "example": "/app-script-condition?limit=25&page=4" - }, - "prev": { - "example": "/app-script-condition?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Script Condition" - ], - "summary": "Create a new App Script Condition resources.", - "description": "Available since: 6.4.10.3", - "operationId": "createAppScriptCondition", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppScriptCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-script-condition/{id}": { - "get": { - "tags": [ - "App Script Condition" - ], - "summary": "Detailed information about a App Script Condition resource.", - "description": "Available since: 6.4.10.3", - "operationId": "getAppScriptCondition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_script_condition", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppScriptCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Script Condition" - ], - "summary": "Delete a App Script Condition resource.", - "description": "Available since: 6.4.10.3", - "operationId": "deleteAppScriptCondition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_script_condition", - "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": [ - "App Script Condition" - ], - "summary": "Partially update information about a App Script Condition resource.", - "description": "Available since: 6.4.10.3", - "operationId": "updateAppScriptCondition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_script_condition", - "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 App Script Condition resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppScriptCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-template": { - "get": { - "tags": [ - "App Template" - ], - "summary": "List with basic information of App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppTemplateList", - "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 App Template 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/AppTemplate" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-template?limit=25" - }, - "last": { - "example": "/app-template?limit=25&page=11" - }, - "next": { - "example": "/app-template?limit=25&page=4" - }, - "prev": { - "example": "/app-template?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "App Template" - ], - "summary": "Create a new App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createAppTemplate", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/app-template/{id}": { - "get": { - "tags": [ - "App Template" - ], - "summary": "Detailed information about a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AppTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Template" - ], - "summary": "Delete a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteAppTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_template", - "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": [ - "App Template" - ], - "summary": "Partially update information about a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateAppTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_template", - "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 App Template resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of AppTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/category": { - "get": { - "tags": [ - "Category" - ], - "summary": "List with basic information of Category resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCategoryList", - "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 Category 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/Category" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/category?limit=25" - }, - "last": { - "example": "/category?limit=25&page=11" - }, - "next": { - "example": "/category?limit=25&page=4" - }, - "prev": { - "example": "/category?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Category" - ], - "summary": "Create a new Category resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCategory", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Category" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Category", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Category" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/category/{id}": { - "get": { - "tags": [ - "Category" - ], - "summary": "Detailed information about a Category resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCategory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the category", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Category", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Category" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Category" - ], - "summary": "Delete a Category resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCategory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the category", - "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": [ - "Category" - ], - "summary": "Partially update information about a Category resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCategory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the category", - "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 Category resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Category" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Category", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Category" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-block": { - "get": { - "tags": [ - "Cms Block" - ], - "summary": "List with basic information of Cms Block resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsBlockList", - "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 Cms Block 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/CmsBlock" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/cms-block?limit=25" - }, - "last": { - "example": "/cms-block?limit=25&page=11" - }, - "next": { - "example": "/cms-block?limit=25&page=4" - }, - "prev": { - "example": "/cms-block?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Cms Block" - ], - "summary": "Create a new Cms Block resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCmsBlock", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-block/{id}": { - "get": { - "tags": [ - "Cms Block" - ], - "summary": "Detailed information about a Cms Block resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsBlock", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_block", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Cms Block" - ], - "summary": "Delete a Cms Block resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsBlock", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_block", - "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": [ - "Cms Block" - ], - "summary": "Partially update information about a Cms Block resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCmsBlock", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_block", - "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 Cms Block resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-page": { - "get": { - "tags": [ - "Cms Page" - ], - "summary": "List with basic information of Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsPageList", - "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 Cms Page 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/CmsPage" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/cms-page?limit=25" - }, - "last": { - "example": "/cms-page?limit=25&page=11" - }, - "next": { - "example": "/cms-page?limit=25&page=4" - }, - "prev": { - "example": "/cms-page?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Cms Page" - ], - "summary": "Create a new Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCmsPage", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-page/{id}": { - "get": { - "tags": [ - "Cms Page" - ], - "summary": "Detailed information about a Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Cms Page" - ], - "summary": "Delete a Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Cms Page" - ], - "summary": "Partially update information about a Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Cms Page resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-section": { - "get": { - "tags": [ - "Cms Section" - ], - "summary": "List with basic information of Cms Section resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsSectionList", - "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 Cms Section 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/CmsSection" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/cms-section?limit=25" - }, - "last": { - "example": "/cms-section?limit=25&page=11" - }, - "next": { - "example": "/cms-section?limit=25&page=4" - }, - "prev": { - "example": "/cms-section?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Cms Section" - ], - "summary": "Create a new Cms Section resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCmsSection", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsSection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-section/{id}": { - "get": { - "tags": [ - "Cms Section" - ], - "summary": "Detailed information about a Cms Section resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsSection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_section", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CmsSection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Cms Section" - ], - "summary": "Delete a Cms Section resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsSection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_section", - "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": [ - "Cms Section" - ], - "summary": "Partially update information about a Cms Section resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCmsSection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_section", - "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 Cms Section resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsSection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-slot": { - "get": { - "tags": [ - "Cms Slot" - ], - "summary": "List with basic information of Cms Slot resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsSlotList", - "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 Cms Slot 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/CmsSlot" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/cms-slot?limit=25" - }, - "last": { - "example": "/cms-slot?limit=25&page=11" - }, - "next": { - "example": "/cms-slot?limit=25&page=4" - }, - "prev": { - "example": "/cms-slot?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Cms Slot" - ], - "summary": "Create a new Cms Slot resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCmsSlot", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsSlot", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-slot/{id}": { - "get": { - "tags": [ - "Cms Slot" - ], - "summary": "Detailed information about a Cms Slot resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsSlot", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_slot", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CmsSlot", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Cms Slot" - ], - "summary": "Delete a Cms Slot resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsSlot", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_slot", - "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": [ - "Cms Slot" - ], - "summary": "Partially update information about a Cms Slot resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCmsSlot", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_slot", - "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 Cms Slot resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CmsSlot", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/country": { - "get": { - "tags": [ - "Country" - ], - "summary": "List with basic information of Country resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCountryList", - "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 Country 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/Country" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/country?limit=25" - }, - "last": { - "example": "/country?limit=25&page=11" - }, - "next": { - "example": "/country?limit=25&page=4" - }, - "prev": { - "example": "/country?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Country" - ], - "summary": "Create a new Country resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCountry", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Country" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Country", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Country" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/country/{id}": { - "get": { - "tags": [ - "Country" - ], - "summary": "Detailed information about a Country resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCountry", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the country", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Country", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Country" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Country" - ], - "summary": "Delete a Country resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCountry", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the country", - "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": [ - "Country" - ], - "summary": "Partially update information about a Country resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCountry", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the country", - "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 Country resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Country" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Country", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Country" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/country-state": { - "get": { - "tags": [ - "Country State" - ], - "summary": "List with basic information of Country State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCountryStateList", - "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 Country State 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/CountryState" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/country-state?limit=25" - }, - "last": { - "example": "/country-state?limit=25&page=11" - }, - "next": { - "example": "/country-state?limit=25&page=4" - }, - "prev": { - "example": "/country-state?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Country State" - ], - "summary": "Create a new Country State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCountryState", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CountryState" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CountryState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CountryState" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/country-state/{id}": { - "get": { - "tags": [ - "Country State" - ], - "summary": "Detailed information about a Country State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCountryState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the country_state", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CountryState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CountryState" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Country State" - ], - "summary": "Delete a Country State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCountryState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the country_state", - "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": [ - "Country State" - ], - "summary": "Partially update information about a Country State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCountryState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the country_state", - "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 Country State resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CountryState" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CountryState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CountryState" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/currency": { - "get": { - "tags": [ - "Currency" - ], - "summary": "List with basic information of Currency resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCurrencyList", - "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 Currency 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/Currency" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/currency?limit=25" - }, - "last": { - "example": "/currency?limit=25&page=11" - }, - "next": { - "example": "/currency?limit=25&page=4" - }, - "prev": { - "example": "/currency?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Currency" - ], - "summary": "Create a new Currency resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCurrency", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Currency" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Currency", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Currency" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/currency/{id}": { - "get": { - "tags": [ - "Currency" - ], - "summary": "Detailed information about a Currency resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCurrency", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the currency", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Currency", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Currency" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Currency" - ], - "summary": "Delete a Currency resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCurrency", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the currency", - "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": [ - "Currency" - ], - "summary": "Partially update information about a Currency resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCurrency", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the currency", - "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 Currency resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Currency" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Currency", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Currency" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/currency-country-rounding": { - "get": { - "tags": [ - "Currency Country Rounding" - ], - "summary": "List with basic information of Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "getCurrencyCountryRoundingList", - "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 Currency Country Rounding 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/CurrencyCountryRounding" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/currency-country-rounding?limit=25" - }, - "last": { - "example": "/currency-country-rounding?limit=25&page=11" - }, - "next": { - "example": "/currency-country-rounding?limit=25&page=4" - }, - "prev": { - "example": "/currency-country-rounding?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Currency Country Rounding" - ], - "summary": "Create a new Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "createCurrencyCountryRounding", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CurrencyCountryRounding", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/currency-country-rounding/{id}": { - "get": { - "tags": [ - "Currency Country Rounding" - ], - "summary": "Detailed information about a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "getCurrencyCountryRounding", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the currency_country_rounding", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CurrencyCountryRounding", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Currency Country Rounding" - ], - "summary": "Delete a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "deleteCurrencyCountryRounding", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the currency_country_rounding", - "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": [ - "Currency Country Rounding" - ], - "summary": "Partially update information about a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "updateCurrencyCountryRounding", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the currency_country_rounding", - "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 Currency Country Rounding resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CurrencyCountryRounding", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-entity": { - "get": { - "tags": [ - "Custom Entity" - ], - "summary": "List with basic information of Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "getCustomEntityList", - "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 Custom Entity 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/CustomEntity" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/custom-entity?limit=25" - }, - "last": { - "example": "/custom-entity?limit=25&page=11" - }, - "next": { - "example": "/custom-entity?limit=25&page=4" - }, - "prev": { - "example": "/custom-entity?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Custom Entity" - ], - "summary": "Create a new Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "createCustomEntity", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomEntity", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-entity/{id}": { - "get": { - "tags": [ - "Custom Entity" - ], - "summary": "Detailed information about a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "getCustomEntity", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_entity", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomEntity", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Custom Entity" - ], - "summary": "Delete a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "deleteCustomEntity", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_entity", - "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": [ - "Custom Entity" - ], - "summary": "Partially update information about a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "updateCustomEntity", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_entity", - "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 Custom Entity resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomEntity", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-field": { - "get": { - "tags": [ - "Custom Field" - ], - "summary": "List with basic information of Custom Field resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldList", - "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 Custom Field 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/CustomField" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/custom-field?limit=25" - }, - "last": { - "example": "/custom-field?limit=25&page=11" - }, - "next": { - "example": "/custom-field?limit=25&page=4" - }, - "prev": { - "example": "/custom-field?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Custom Field" - ], - "summary": "Create a new Custom Field resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomField", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomField" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomField" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-field/{id}": { - "get": { - "tags": [ - "Custom Field" - ], - "summary": "Detailed information about a Custom Field resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomField" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Custom Field" - ], - "summary": "Delete a Custom Field resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field", - "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": [ - "Custom Field" - ], - "summary": "Partially update information about a Custom Field resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field", - "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 Custom Field resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomField" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomField" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-field-set": { - "get": { - "tags": [ - "Custom Field Set" - ], - "summary": "List with basic information of Custom Field Set resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetList", - "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 Custom Field Set 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/CustomFieldSet" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/custom-field-set?limit=25" - }, - "last": { - "example": "/custom-field-set?limit=25&page=11" - }, - "next": { - "example": "/custom-field-set?limit=25&page=4" - }, - "prev": { - "example": "/custom-field-set?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Custom Field Set" - ], - "summary": "Create a new Custom Field Set resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomFieldSet", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomFieldSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-field-set/{id}": { - "get": { - "tags": [ - "Custom Field Set" - ], - "summary": "Detailed information about a Custom Field Set resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field_set", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomFieldSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Custom Field Set" - ], - "summary": "Delete a Custom Field Set resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomFieldSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field_set", - "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": [ - "Custom Field Set" - ], - "summary": "Partially update information about a Custom Field Set resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomFieldSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field_set", - "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 Custom Field Set resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomFieldSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-field-set-relation": { - "get": { - "tags": [ - "Custom Field Set Relation" - ], - "summary": "List with basic information of Custom Field Set Relation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetRelationList", - "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 Custom Field Set Relation 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/CustomFieldSetRelation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/custom-field-set-relation?limit=25" - }, - "last": { - "example": "/custom-field-set-relation?limit=25&page=11" - }, - "next": { - "example": "/custom-field-set-relation?limit=25&page=4" - }, - "prev": { - "example": "/custom-field-set-relation?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Custom Field Set Relation" - ], - "summary": "Create a new Custom Field Set Relation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomFieldSetRelation", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomFieldSetRelation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-field-set-relation/{id}": { - "get": { - "tags": [ - "Custom Field Set Relation" - ], - "summary": "Detailed information about a Custom Field Set Relation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetRelation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field_set_relation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomFieldSetRelation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Custom Field Set Relation" - ], - "summary": "Delete a Custom Field Set Relation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomFieldSetRelation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field_set_relation", - "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": [ - "Custom Field Set Relation" - ], - "summary": "Partially update information about a Custom Field Set Relation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomFieldSetRelation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_field_set_relation", - "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 Custom Field Set Relation resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomFieldSetRelation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer": { - "get": { - "tags": [ - "Customer" - ], - "summary": "List with basic information of Customer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerList", - "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 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/Customer" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer?limit=25" - }, - "last": { - "example": "/customer?limit=25&page=11" - }, - "next": { - "example": "/customer?limit=25&page=4" - }, - "prev": { - "example": "/customer?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer" - ], - "summary": "Create a new Customer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomer", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Customer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer/{id}": { - "get": { - "tags": [ - "Customer" - ], - "summary": "Detailed information about a Customer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Customer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer" - ], - "summary": "Delete a Customer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Customer" - ], - "summary": "Partially update information about a Customer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Customer resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Customer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Customer" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-address": { - "get": { - "tags": [ - "Customer Address" - ], - "summary": "List with basic information of Customer Address resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerAddressList", - "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 Customer Address 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/CustomerAddress" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer-address?limit=25" - }, - "last": { - "example": "/customer-address?limit=25&page=11" - }, - "next": { - "example": "/customer-address?limit=25&page=4" - }, - "prev": { - "example": "/customer-address?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer Address" - ], - "summary": "Create a new Customer Address resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomerAddress", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-address/{id}": { - "get": { - "tags": [ - "Customer Address" - ], - "summary": "Detailed information about a Customer Address resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_address", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomerAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer Address" - ], - "summary": "Delete a Customer Address resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomerAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_address", - "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": [ - "Customer Address" - ], - "summary": "Partially update information about a Customer Address resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomerAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_address", - "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 Customer Address resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-group": { - "get": { - "tags": [ - "Customer Group" - ], - "summary": "List with basic information of Customer Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerGroupList", - "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 Customer 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/CustomerGroup" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer-group?limit=25" - }, - "last": { - "example": "/customer-group?limit=25&page=11" - }, - "next": { - "example": "/customer-group?limit=25&page=4" - }, - "prev": { - "example": "/customer-group?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer Group" - ], - "summary": "Create a new Customer Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomerGroup", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-group/{id}": { - "get": { - "tags": [ - "Customer Group" - ], - "summary": "Detailed information about a Customer Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomerGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_group", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomerGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer Group" - ], - "summary": "Delete a Customer Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomerGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_group", - "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": [ - "Customer Group" - ], - "summary": "Partially update information about a Customer Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomerGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_group", - "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 Customer Group resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-recovery": { - "get": { - "tags": [ - "Customer Recovery" - ], - "summary": "List with basic information of Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getCustomerRecoveryList", - "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 Customer Recovery 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/CustomerRecovery" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer-recovery?limit=25" - }, - "last": { - "example": "/customer-recovery?limit=25&page=11" - }, - "next": { - "example": "/customer-recovery?limit=25&page=4" - }, - "prev": { - "example": "/customer-recovery?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer Recovery" - ], - "summary": "Create a new Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createCustomerRecovery", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-recovery/{id}": { - "get": { - "tags": [ - "Customer Recovery" - ], - "summary": "Detailed information about a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getCustomerRecovery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_recovery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomerRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer Recovery" - ], - "summary": "Delete a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteCustomerRecovery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_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": [ - "Customer Recovery" - ], - "summary": "Partially update information about a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateCustomerRecovery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_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 Customer Recovery resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-wishlist": { - "get": { - "tags": [ - "Customer Wishlist" - ], - "summary": "List with basic information of Customer Wishlist resources.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistList", - "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 Customer Wishlist 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/CustomerWishlist" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer-wishlist?limit=25" - }, - "last": { - "example": "/customer-wishlist?limit=25&page=11" - }, - "next": { - "example": "/customer-wishlist?limit=25&page=4" - }, - "prev": { - "example": "/customer-wishlist?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer Wishlist" - ], - "summary": "Create a new Customer Wishlist resources.", - "description": "Available since: 6.3.4.0", - "operationId": "createCustomerWishlist", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerWishlist", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-wishlist/{id}": { - "get": { - "tags": [ - "Customer Wishlist" - ], - "summary": "Detailed information about a Customer Wishlist resource.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlist", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_wishlist", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomerWishlist", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer Wishlist" - ], - "summary": "Delete a Customer Wishlist resource.", - "description": "Available since: 6.3.4.0", - "operationId": "deleteCustomerWishlist", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_wishlist", - "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": [ - "Customer Wishlist" - ], - "summary": "Partially update information about a Customer Wishlist resource.", - "description": "Available since: 6.3.4.0", - "operationId": "updateCustomerWishlist", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_wishlist", - "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 Customer Wishlist resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerWishlist", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-wishlist-product": { - "get": { - "tags": [ - "Customer Wishlist Product" - ], - "summary": "List with basic information of Customer Wishlist Product resources.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistProductList", - "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 Customer Wishlist Product 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/CustomerWishlistProduct" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer-wishlist-product?limit=25" - }, - "last": { - "example": "/customer-wishlist-product?limit=25&page=11" - }, - "next": { - "example": "/customer-wishlist-product?limit=25&page=4" - }, - "prev": { - "example": "/customer-wishlist-product?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer Wishlist Product" - ], - "summary": "Create a new Customer Wishlist Product resources.", - "description": "Available since: 6.3.4.0", - "operationId": "createCustomerWishlistProduct", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerWishlistProduct", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-wishlist-product/{id}": { - "get": { - "tags": [ - "Customer Wishlist Product" - ], - "summary": "Detailed information about a Customer Wishlist Product resource.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistProduct", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_wishlist_product", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomerWishlistProduct", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer Wishlist Product" - ], - "summary": "Delete a Customer Wishlist Product resource.", - "description": "Available since: 6.3.4.0", - "operationId": "deleteCustomerWishlistProduct", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_wishlist_product", - "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": [ - "Customer Wishlist Product" - ], - "summary": "Partially update information about a Customer Wishlist Product resource.", - "description": "Available since: 6.3.4.0", - "operationId": "updateCustomerWishlistProduct", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_wishlist_product", - "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 Customer Wishlist Product resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerWishlistProduct", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/delivery-time": { - "get": { - "tags": [ - "Delivery Time" - ], - "summary": "List with basic information of Delivery Time resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDeliveryTimeList", - "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 Delivery Time 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/DeliveryTime" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/delivery-time?limit=25" - }, - "last": { - "example": "/delivery-time?limit=25&page=11" - }, - "next": { - "example": "/delivery-time?limit=25&page=4" - }, - "prev": { - "example": "/delivery-time?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Delivery Time" - ], - "summary": "Create a new Delivery Time resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDeliveryTime", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DeliveryTime", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/delivery-time/{id}": { - "get": { - "tags": [ - "Delivery Time" - ], - "summary": "Detailed information about a Delivery Time resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDeliveryTime", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the delivery_time", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of DeliveryTime", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Delivery Time" - ], - "summary": "Delete a Delivery Time resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDeliveryTime", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the delivery_time", - "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": [ - "Delivery Time" - ], - "summary": "Partially update information about a Delivery Time resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDeliveryTime", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the delivery_time", - "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 Delivery Time resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DeliveryTime", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document": { - "get": { - "tags": [ - "Document" - ], - "summary": "List with basic information of Document resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentList", - "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 Document 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/Document" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/document?limit=25" - }, - "last": { - "example": "/document?limit=25&page=11" - }, - "next": { - "example": "/document?limit=25&page=4" - }, - "prev": { - "example": "/document?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Document" - ], - "summary": "Create a new Document resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDocument", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Document" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Document", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Document" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document/{id}": { - "get": { - "tags": [ - "Document" - ], - "summary": "Detailed information about a Document resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocument", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Document", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Document" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Document" - ], - "summary": "Delete a Document resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDocument", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document", - "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": [ - "Document" - ], - "summary": "Partially update information about a Document resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDocument", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document", - "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 Document resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Document" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Document", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Document" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-base-config": { - "get": { - "tags": [ - "Document Base Config" - ], - "summary": "List with basic information of Document Base Config resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigList", - "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 Document Base Config 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/DocumentBaseConfig" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/document-base-config?limit=25" - }, - "last": { - "example": "/document-base-config?limit=25&page=11" - }, - "next": { - "example": "/document-base-config?limit=25&page=4" - }, - "prev": { - "example": "/document-base-config?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Document Base Config" - ], - "summary": "Create a new Document Base Config resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDocumentBaseConfig", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DocumentBaseConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-base-config/{id}": { - "get": { - "tags": [ - "Document Base Config" - ], - "summary": "Detailed information about a Document Base Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of DocumentBaseConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Document Base Config" - ], - "summary": "Delete a Document Base Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentBaseConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config", - "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": [ - "Document Base Config" - ], - "summary": "Partially update information about a Document Base Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentBaseConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config", - "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 Document Base Config resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DocumentBaseConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-base-config-sales-channel": { - "get": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "List with basic information of Document Base Config Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannelList", - "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 Document Base Config Sales Channel 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/DocumentBaseConfigSalesChannel" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/document-base-config-sales-channel?limit=25" - }, - "last": { - "example": "/document-base-config-sales-channel?limit=25&page=11" - }, - "next": { - "example": "/document-base-config-sales-channel?limit=25&page=4" - }, - "prev": { - "example": "/document-base-config-sales-channel?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Create a new Document Base Config Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDocumentBaseConfigSalesChannel", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-base-config-sales-channel/{id}": { - "get": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Detailed information about a Document Base Config Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config_sales_channel", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Delete a Document Base Config Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentBaseConfigSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config_sales_channel", - "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": [ - "Document Base Config Sales Channel" - ], - "summary": "Partially update information about a Document Base Config Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentBaseConfigSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config_sales_channel", - "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 Document Base Config Sales Channel resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-type": { - "get": { - "tags": [ - "Document Type" - ], - "summary": "List with basic information of Document Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentTypeList", - "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 Document Type 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/DocumentType" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/document-type?limit=25" - }, - "last": { - "example": "/document-type?limit=25&page=11" - }, - "next": { - "example": "/document-type?limit=25&page=4" - }, - "prev": { - "example": "/document-type?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Document Type" - ], - "summary": "Create a new Document Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDocumentType", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DocumentType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-type/{id}": { - "get": { - "tags": [ - "Document Type" - ], - "summary": "Detailed information about a Document Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_type", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of DocumentType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Document Type" - ], - "summary": "Delete a Document Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_type", - "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": [ - "Document Type" - ], - "summary": "Partially update information about a Document Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_type", - "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 Document Type resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DocumentType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/flow": { - "get": { - "tags": [ - "Flow" - ], - "summary": "List with basic information of Flow resources.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlowList", - "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 Flow 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/Flow" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/flow?limit=25" - }, - "last": { - "example": "/flow?limit=25&page=11" - }, - "next": { - "example": "/flow?limit=25&page=4" - }, - "prev": { - "example": "/flow?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Flow" - ], - "summary": "Create a new Flow resources.", - "description": "Available since: 6.4.6.0", - "operationId": "createFlow", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Flow" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Flow", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Flow" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/flow/{id}": { - "get": { - "tags": [ - "Flow" - ], - "summary": "Detailed information about a Flow resource.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlow", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Flow", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Flow" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Flow" - ], - "summary": "Delete a Flow resource.", - "description": "Available since: 6.4.6.0", - "operationId": "deleteFlow", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow", - "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": [ - "Flow" - ], - "summary": "Partially update information about a Flow resource.", - "description": "Available since: 6.4.6.0", - "operationId": "updateFlow", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow", - "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 Flow resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Flow" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Flow", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Flow" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/flow-sequence": { - "get": { - "tags": [ - "Flow Sequence" - ], - "summary": "List with basic information of Flow Sequence resources.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlowSequenceList", - "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 Flow Sequence 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/FlowSequence" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/flow-sequence?limit=25" - }, - "last": { - "example": "/flow-sequence?limit=25&page=11" - }, - "next": { - "example": "/flow-sequence?limit=25&page=4" - }, - "prev": { - "example": "/flow-sequence?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Flow Sequence" - ], - "summary": "Create a new Flow Sequence resources.", - "description": "Available since: 6.4.6.0", - "operationId": "createFlowSequence", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of FlowSequence", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/flow-sequence/{id}": { - "get": { - "tags": [ - "Flow Sequence" - ], - "summary": "Detailed information about a Flow Sequence resource.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlowSequence", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow_sequence", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of FlowSequence", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Flow Sequence" - ], - "summary": "Delete a Flow Sequence resource.", - "description": "Available since: 6.4.6.0", - "operationId": "deleteFlowSequence", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow_sequence", - "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": [ - "Flow Sequence" - ], - "summary": "Partially update information about a Flow Sequence resource.", - "description": "Available since: 6.4.6.0", - "operationId": "updateFlowSequence", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow_sequence", - "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 Flow Sequence resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of FlowSequence", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/flow-template": { - "get": { - "tags": [ - "Flow Template" - ], - "summary": "List with basic information of Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "getFlowTemplateList", - "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 Flow Template 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/FlowTemplate" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/flow-template?limit=25" - }, - "last": { - "example": "/flow-template?limit=25&page=11" - }, - "next": { - "example": "/flow-template?limit=25&page=4" - }, - "prev": { - "example": "/flow-template?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Flow Template" - ], - "summary": "Create a new Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "createFlowTemplate", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of FlowTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/flow-template/{id}": { - "get": { - "tags": [ - "Flow Template" - ], - "summary": "Detailed information about a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "getFlowTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of FlowTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Flow Template" - ], - "summary": "Delete a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "deleteFlowTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow_template", - "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": [ - "Flow Template" - ], - "summary": "Partially update information about a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "updateFlowTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the flow_template", - "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 Flow Template resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of FlowTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-appointment": { - "get": { - "tags": [ - "Guided Shopping Appointment" - ], - "summary": "List with basic information of Guided Shopping Appointment resources.", - "description": "", - "operationId": "getGuidedShoppingAppointmentList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Appointment 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/GuidedShoppingAppointment" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-appointment?limit=25" - }, - "last": { - "example": "/guided-shopping-appointment?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-appointment?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-appointment?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Appointment" - ], - "summary": "Create a new appointment", - "description": "", - "operationId": "createAppointment", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Appointment" - } - } - }, - "required": false - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointment", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "204": { - "description": "" - } - } - } - }, - "/guided-shopping-appointment/{id}": { - "get": { - "tags": [ - "Guided Shopping Appointment" - ], - "summary": "Detailed information about a Guided Shopping Appointment resource.", - "description": "", - "operationId": "getGuidedShoppingAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointment", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Appointment" - ], - "summary": "Delete a Guided Shopping Appointment resource.", - "description": "", - "operationId": "deleteGuidedShoppingAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Appointment" - ], - "summary": "Partially update information about a Guided Shopping Appointment resource.", - "description": "", - "operationId": "updateGuidedShoppingAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Appointment resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointment", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-appointment-attendee": { - "get": { - "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "List with basic information of Guided Shopping Appointment Attendee resources.", - "description": "", - "operationId": "getGuidedShoppingAppointmentAttendeeList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Appointment Attendee 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/GuidedShoppingAppointmentAttendee" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-appointment-attendee?limit=25" - }, - "last": { - "example": "/guided-shopping-appointment-attendee?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-appointment-attendee?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-appointment-attendee?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Create a new Guided Shopping Appointment Attendee resources.", - "description": "", - "operationId": "createGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointmentAttendee", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-appointment-attendee/{id}": { - "get": { - "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Detailed information about a Guided Shopping Appointment Attendee resource.", - "description": "", - "operationId": "getGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointmentAttendee", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Delete a Guided Shopping Appointment Attendee resource.", - "description": "", - "operationId": "deleteGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Appointment Attendee" - ], - "summary": "Partially update information about a Guided Shopping Appointment Attendee resource.", - "description": "", - "operationId": "updateGuidedShoppingAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Appointment Attendee resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointmentAttendee", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-appointment-video-chat": { - "get": { - "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "List with basic information of Guided Shopping Appointment Video Chat resources.", - "description": "", - "operationId": "getGuidedShoppingAppointmentVideoChatList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Appointment Video Chat 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/GuidedShoppingAppointmentVideoChat" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-appointment-video-chat?limit=25" - }, - "last": { - "example": "/guided-shopping-appointment-video-chat?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-appointment-video-chat?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-appointment-video-chat?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Create a new Guided Shopping Appointment Video Chat resources.", - "description": "", - "operationId": "createGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointmentVideoChat", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-appointment-video-chat/{id}": { - "get": { - "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Detailed information about a Guided Shopping Appointment Video Chat resource.", - "description": "", - "operationId": "getGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointmentVideoChat", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Delete a Guided Shopping Appointment Video Chat resource.", - "description": "", - "operationId": "deleteGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Appointment Video Chat" - ], - "summary": "Partially update information about a Guided Shopping Appointment Video Chat resource.", - "description": "", - "operationId": "updateGuidedShoppingAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Appointment Video Chat resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAppointmentVideoChat", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-attendee-product-collection": { - "get": { - "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "List with basic information of Guided Shopping Attendee Product Collection resources.", - "description": "", - "operationId": "getGuidedShoppingAttendeeProductCollectionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Attendee Product Collection 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/GuidedShoppingAttendeeProductCollection" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-attendee-product-collection?limit=25" - }, - "last": { - "example": "/guided-shopping-attendee-product-collection?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-attendee-product-collection?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-attendee-product-collection?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Create a new Guided Shopping Attendee Product Collection resources.", - "description": "", - "operationId": "createGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAttendeeProductCollection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-attendee-product-collection/{id}": { - "get": { - "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Detailed information about a Guided Shopping Attendee Product Collection resource.", - "description": "", - "operationId": "getGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingAttendeeProductCollection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Delete a Guided Shopping Attendee Product Collection resource.", - "description": "", - "operationId": "deleteGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Attendee Product Collection" - ], - "summary": "Partially update information about a Guided Shopping Attendee Product Collection resource.", - "description": "", - "operationId": "updateGuidedShoppingAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Attendee Product Collection resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingAttendeeProductCollection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-interaction": { - "get": { - "tags": [ - "Guided Shopping Interaction" - ], - "summary": "List with basic information of Guided Shopping Interaction resources.", - "description": "", - "operationId": "getGuidedShoppingInteractionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Interaction 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/GuidedShoppingInteraction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-interaction?limit=25" - }, - "last": { - "example": "/guided-shopping-interaction?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-interaction?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-interaction?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Create a new Guided Shopping Interaction resources.", - "description": "", - "operationId": "createGuidedShoppingInteraction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-interaction/{id}": { - "get": { - "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Detailed information about a Guided Shopping Interaction resource.", - "description": "", - "operationId": "getGuidedShoppingInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Delete a Guided Shopping Interaction resource.", - "description": "", - "operationId": "deleteGuidedShoppingInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Interaction" - ], - "summary": "Partially update information about a Guided Shopping Interaction resource.", - "description": "", - "operationId": "updateGuidedShoppingInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Interaction resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-presentation": { - "get": { - "tags": [ - "Guided Shopping Presentation" - ], - "summary": "List with basic information of Guided Shopping Presentation resources.", - "description": "", - "operationId": "getGuidedShoppingPresentationList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Presentation 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/GuidedShoppingPresentation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-presentation?limit=25" - }, - "last": { - "example": "/guided-shopping-presentation?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-presentation?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-presentation?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Presentation" - ], - "summary": "Create a new presentation", - "description": "", - "operationId": "createPresentation", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Presentation" - } - } - }, - "required": false - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "204": { - "description": "" - } - } - } - }, - "/guided-shopping-presentation/{id}": { - "get": { - "tags": [ - "Guided Shopping Presentation" - ], - "summary": "Detailed information about a Guided Shopping Presentation resource.", - "description": "", - "operationId": "getGuidedShoppingPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Presentation" - ], - "summary": "Delete a Guided Shopping Presentation resource.", - "description": "", - "operationId": "deleteGuidedShoppingPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Presentation" - ], - "summary": "Partially update information about a Guided Shopping Presentation resource.", - "description": "", - "operationId": "updateGuidedShoppingPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Presentation resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-presentation-cms-page": { - "get": { - "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "List with basic information of Guided Shopping Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getGuidedShoppingPresentationCmsPageList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Guided Shopping Presentation Cms Page 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/GuidedShoppingPresentationCmsPage" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/guided-shopping-presentation-cms-page?limit=25" - }, - "last": { - "example": "/guided-shopping-presentation-cms-page?limit=25&page=11" - }, - "next": { - "example": "/guided-shopping-presentation-cms-page?limit=25&page=4" - }, - "prev": { - "example": "/guided-shopping-presentation-cms-page?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Create a new Guided Shopping Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/guided-shopping-presentation-cms-page/{id}": { - "get": { - "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Detailed information about a Guided Shopping Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of GuidedShoppingPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Delete a Guided Shopping Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Guided Shopping Presentation Cms Page" - ], - "summary": "Partially update information about a Guided Shopping Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateGuidedShoppingPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the guided_shopping_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Guided Shopping Presentation Cms Page resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of GuidedShoppingPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/import-export-file": { - "get": { - "tags": [ - "Import Export File" - ], - "summary": "List with basic information of Import Export File resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportFileList", - "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 Import Export File 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/ImportExportFile" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/import-export-file?limit=25" - }, - "last": { - "example": "/import-export-file?limit=25&page=11" - }, - "next": { - "example": "/import-export-file?limit=25&page=4" - }, - "prev": { - "example": "/import-export-file?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Import Export File" - ], - "summary": "Create a new Import Export File resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createImportExportFile", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ImportExportFile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/import-export-file/{id}": { - "get": { - "tags": [ - "Import Export File" - ], - "summary": "Detailed information about a Import Export File resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportFile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_file", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ImportExportFile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Import Export File" - ], - "summary": "Delete a Import Export File resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportFile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_file", - "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": [ - "Import Export File" - ], - "summary": "Partially update information about a Import Export File resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportFile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_file", - "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 Import Export File resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ImportExportFile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/import-export-log": { - "get": { - "tags": [ - "Import Export Log" - ], - "summary": "List with basic information of Import Export Log resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportLogList", - "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 Import Export 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/ImportExportLog" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/import-export-log?limit=25" - }, - "last": { - "example": "/import-export-log?limit=25&page=11" - }, - "next": { - "example": "/import-export-log?limit=25&page=4" - }, - "prev": { - "example": "/import-export-log?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Import Export Log" - ], - "summary": "Create a new Import Export Log resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createImportExportLog", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ImportExportLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/import-export-log/{id}": { - "get": { - "tags": [ - "Import Export Log" - ], - "summary": "Detailed information about a Import Export Log resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportLog", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_log", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ImportExportLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Import Export Log" - ], - "summary": "Delete a Import Export Log resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportLog", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_log", - "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": [ - "Import Export Log" - ], - "summary": "Partially update information about a Import Export Log resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportLog", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_log", - "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 Import Export Log resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ImportExportLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/import-export-profile": { - "get": { - "tags": [ - "Import Export Profile" - ], - "summary": "List with basic information of Import Export Profile resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportProfileList", - "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 Import Export Profile 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/ImportExportProfile" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/import-export-profile?limit=25" - }, - "last": { - "example": "/import-export-profile?limit=25&page=11" - }, - "next": { - "example": "/import-export-profile?limit=25&page=4" - }, - "prev": { - "example": "/import-export-profile?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Import Export Profile" - ], - "summary": "Create a new Import Export Profile resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createImportExportProfile", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ImportExportProfile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/import-export-profile/{id}": { - "get": { - "tags": [ - "Import Export Profile" - ], - "summary": "Detailed information about a Import Export Profile resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportProfile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_profile", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ImportExportProfile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Import Export Profile" - ], - "summary": "Delete a Import Export Profile resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportProfile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_profile", - "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": [ - "Import Export Profile" - ], - "summary": "Partially update information about a Import Export Profile resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportProfile", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the import_export_profile", - "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 Import Export Profile resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ImportExportProfile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/integration": { - "get": { - "tags": [ - "Integration" - ], - "summary": "List with basic information of Integration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getIntegrationList", - "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 Integration 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/Integration" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/integration?limit=25" - }, - "last": { - "example": "/integration?limit=25&page=11" - }, - "next": { - "example": "/integration?limit=25&page=4" - }, - "prev": { - "example": "/integration?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Integration" - ], - "summary": "Create a new Integration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createIntegration", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Integration" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Integration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Integration" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/integration/{id}": { - "get": { - "tags": [ - "Integration" - ], - "summary": "Detailed information about a Integration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getIntegration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the integration", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Integration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Integration" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Integration" - ], - "summary": "Delete a Integration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteIntegration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the integration", - "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": [ - "Integration" - ], - "summary": "Partially update information about a Integration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateIntegration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the integration", - "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 Integration resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Integration" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Integration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Integration" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/landing-page": { - "get": { - "tags": [ - "Landing Page" - ], - "summary": "List with basic information of Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "getLandingPageList", - "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 Landing Page 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/LandingPage" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/landing-page?limit=25" - }, - "last": { - "example": "/landing-page?limit=25&page=11" - }, - "next": { - "example": "/landing-page?limit=25&page=4" - }, - "prev": { - "example": "/landing-page?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Landing Page" - ], - "summary": "Create a new Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "createLandingPage", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of LandingPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/landing-page/{id}": { - "get": { - "tags": [ - "Landing Page" - ], - "summary": "Detailed information about a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "getLandingPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the landing_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of LandingPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Landing Page" - ], - "summary": "Delete a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "deleteLandingPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the landing_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Landing Page" - ], - "summary": "Partially update information about a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "updateLandingPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the landing_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Landing Page resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of LandingPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/language": { - "get": { - "tags": [ - "Language" - ], - "summary": "List with basic information of Language resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getLanguageList", - "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 Language 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/Language" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/language?limit=25" - }, - "last": { - "example": "/language?limit=25&page=11" - }, - "next": { - "example": "/language?limit=25&page=4" - }, - "prev": { - "example": "/language?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Language" - ], - "summary": "Create a new Language resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createLanguage", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Language" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Language", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Language" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/language/{id}": { - "get": { - "tags": [ - "Language" - ], - "summary": "Detailed information about a Language resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getLanguage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the language", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Language", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Language" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Language" - ], - "summary": "Delete a Language resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteLanguage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the language", - "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": [ - "Language" - ], - "summary": "Partially update information about a Language resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateLanguage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the language", - "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 Language resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Language" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Language", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Language" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/locale": { - "get": { - "tags": [ - "Locale" - ], - "summary": "List with basic information of Locale resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getLocaleList", - "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 Locale 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/Locale" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/locale?limit=25" - }, - "last": { - "example": "/locale?limit=25&page=11" - }, - "next": { - "example": "/locale?limit=25&page=4" - }, - "prev": { - "example": "/locale?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Locale" - ], - "summary": "Create a new Locale resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createLocale", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Locale" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Locale", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Locale" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/locale/{id}": { - "get": { - "tags": [ - "Locale" - ], - "summary": "Detailed information about a Locale resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getLocale", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the locale", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Locale", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Locale" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Locale" - ], - "summary": "Delete a Locale resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteLocale", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the locale", - "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": [ - "Locale" - ], - "summary": "Partially update information about a Locale resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateLocale", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the locale", - "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 Locale resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Locale" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Locale", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Locale" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/log-entry": { - "get": { - "tags": [ - "Log Entry" - ], - "summary": "List with basic information of Log Entry resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getLogEntryList", - "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 Log Entry 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/LogEntry" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/log-entry?limit=25" - }, - "last": { - "example": "/log-entry?limit=25&page=11" - }, - "next": { - "example": "/log-entry?limit=25&page=4" - }, - "prev": { - "example": "/log-entry?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Log Entry" - ], - "summary": "Create a new Log Entry resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createLogEntry", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of LogEntry", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/log-entry/{id}": { - "get": { - "tags": [ - "Log Entry" - ], - "summary": "Detailed information about a Log Entry resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getLogEntry", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the log_entry", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of LogEntry", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Log Entry" - ], - "summary": "Delete a Log Entry resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteLogEntry", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the log_entry", - "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": [ - "Log Entry" - ], - "summary": "Partially update information about a Log Entry resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateLogEntry", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the log_entry", - "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 Log Entry resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of LogEntry", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/mail-header-footer": { - "get": { - "tags": [ - "Mail Header Footer" - ], - "summary": "List with basic information of Mail Header Footer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailHeaderFooterList", - "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 Mail Header Footer 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/MailHeaderFooter" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/mail-header-footer?limit=25" - }, - "last": { - "example": "/mail-header-footer?limit=25&page=11" - }, - "next": { - "example": "/mail-header-footer?limit=25&page=4" - }, - "prev": { - "example": "/mail-header-footer?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Mail Header Footer" - ], - "summary": "Create a new Mail Header Footer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMailHeaderFooter", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MailHeaderFooter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/mail-header-footer/{id}": { - "get": { - "tags": [ - "Mail Header Footer" - ], - "summary": "Detailed information about a Mail Header Footer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailHeaderFooter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_header_footer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MailHeaderFooter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Mail Header Footer" - ], - "summary": "Delete a Mail Header Footer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMailHeaderFooter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_header_footer", - "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": [ - "Mail Header Footer" - ], - "summary": "Partially update information about a Mail Header Footer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMailHeaderFooter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_header_footer", - "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 Mail Header Footer resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MailHeaderFooter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/mail-template": { - "get": { - "tags": [ - "Mail Template" - ], - "summary": "List with basic information of Mail Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateList", - "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 Mail Template 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/MailTemplate" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/mail-template?limit=25" - }, - "last": { - "example": "/mail-template?limit=25&page=11" - }, - "next": { - "example": "/mail-template?limit=25&page=4" - }, - "prev": { - "example": "/mail-template?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Mail Template" - ], - "summary": "Create a new Mail Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMailTemplate", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MailTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/mail-template/{id}": { - "get": { - "tags": [ - "Mail Template" - ], - "summary": "Detailed information about a Mail Template resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MailTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Mail Template" - ], - "summary": "Delete a Mail Template resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMailTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_template", - "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": [ - "Mail Template" - ], - "summary": "Partially update information about a Mail Template resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMailTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_template", - "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 Mail Template resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MailTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/mail-template-type": { - "get": { - "tags": [ - "Mail Template Type" - ], - "summary": "List with basic information of Mail Template Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateTypeList", - "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 Mail Template Type 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/MailTemplateType" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/mail-template-type?limit=25" - }, - "last": { - "example": "/mail-template-type?limit=25&page=11" - }, - "next": { - "example": "/mail-template-type?limit=25&page=4" - }, - "prev": { - "example": "/mail-template-type?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Mail Template Type" - ], - "summary": "Create a new Mail Template Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMailTemplateType", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MailTemplateType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/mail-template-type/{id}": { - "get": { - "tags": [ - "Mail Template Type" - ], - "summary": "Detailed information about a Mail Template Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_template_type", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MailTemplateType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Mail Template Type" - ], - "summary": "Delete a Mail Template Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMailTemplateType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_template_type", - "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": [ - "Mail Template Type" - ], - "summary": "Partially update information about a Mail Template Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMailTemplateType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the mail_template_type", - "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 Mail Template Type resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MailTemplateType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/main-category": { - "get": { - "tags": [ - "Main Category" - ], - "summary": "List with basic information of Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getMainCategoryList", - "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 Main Category 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/MainCategory" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/main-category?limit=25" - }, - "last": { - "example": "/main-category?limit=25&page=11" - }, - "next": { - "example": "/main-category?limit=25&page=4" - }, - "prev": { - "example": "/main-category?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Main Category" - ], - "summary": "Create a new Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createMainCategory", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MainCategory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/main-category/{id}": { - "get": { - "tags": [ - "Main Category" - ], - "summary": "Detailed information about a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getMainCategory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the main_category", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MainCategory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Main Category" - ], - "summary": "Delete a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteMainCategory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the main_category", - "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": [ - "Main Category" - ], - "summary": "Partially update information about a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateMainCategory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the main_category", - "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 Main Category resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MainCategory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media": { - "get": { - "tags": [ - "Media" - ], - "summary": "List with basic information of Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaList", - "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 Media 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/Media" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media?limit=25" - }, - "last": { - "example": "/media?limit=25&page=11" - }, - "next": { - "example": "/media?limit=25&page=4" - }, - "prev": { - "example": "/media?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media" - ], - "summary": "Create a new Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMedia", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Media" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Media", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Media" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media/{id}": { - "get": { - "tags": [ - "Media" - ], - "summary": "Detailed information about a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMedia", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Media", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Media" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media" - ], - "summary": "Delete a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMedia", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media", - "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": [ - "Media" - ], - "summary": "Partially update information about a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMedia", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media", - "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 Media resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Media" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Media", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Media" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-default-folder": { - "get": { - "tags": [ - "Media Default Folder" - ], - "summary": "List with basic information of Media Default Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolderList", - "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 Media Default Folder 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/MediaDefaultFolder" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media-default-folder?limit=25" - }, - "last": { - "example": "/media-default-folder?limit=25&page=11" - }, - "next": { - "example": "/media-default-folder?limit=25&page=4" - }, - "prev": { - "example": "/media-default-folder?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media Default Folder" - ], - "summary": "Create a new Media Default Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMediaDefaultFolder", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaDefaultFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-default-folder/{id}": { - "get": { - "tags": [ - "Media Default Folder" - ], - "summary": "Detailed information about a Media Default Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_default_folder", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MediaDefaultFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media Default Folder" - ], - "summary": "Delete a Media Default Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaDefaultFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_default_folder", - "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": [ - "Media Default Folder" - ], - "summary": "Partially update information about a Media Default Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMediaDefaultFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_default_folder", - "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 Media Default Folder resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaDefaultFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-folder": { - "get": { - "tags": [ - "Media Folder" - ], - "summary": "List with basic information of Media Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderList", - "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 Media Folder 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/MediaFolder" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media-folder?limit=25" - }, - "last": { - "example": "/media-folder?limit=25&page=11" - }, - "next": { - "example": "/media-folder?limit=25&page=4" - }, - "prev": { - "example": "/media-folder?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media Folder" - ], - "summary": "Create a new Media Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolder", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-folder/{id}": { - "get": { - "tags": [ - "Media Folder" - ], - "summary": "Detailed information about a Media Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media Folder" - ], - "summary": "Delete a Media Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder", - "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": [ - "Media Folder" - ], - "summary": "Partially update information about a Media Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder", - "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 Media Folder resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-folder-configuration": { - "get": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "List with basic information of Media Folder Configuration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfigurationList", - "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 Media Folder Configuration 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/MediaFolderConfiguration" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media-folder-configuration?limit=25" - }, - "last": { - "example": "/media-folder-configuration?limit=25&page=11" - }, - "next": { - "example": "/media-folder-configuration?limit=25&page=4" - }, - "prev": { - "example": "/media-folder-configuration?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "Create a new Media Folder Configuration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolderConfiguration", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaFolderConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-folder-configuration/{id}": { - "get": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "Detailed information about a Media Folder Configuration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder_configuration", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MediaFolderConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "Delete a Media Folder Configuration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolderConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder_configuration", - "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": [ - "Media Folder Configuration" - ], - "summary": "Partially update information about a Media Folder Configuration resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolderConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder_configuration", - "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 Media Folder Configuration resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaFolderConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-thumbnail": { - "get": { - "tags": [ - "Media Thumbnail" - ], - "summary": "List with basic information of Media Thumbnail resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailList", - "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 Media Thumbnail 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/MediaThumbnail" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media-thumbnail?limit=25" - }, - "last": { - "example": "/media-thumbnail?limit=25&page=11" - }, - "next": { - "example": "/media-thumbnail?limit=25&page=4" - }, - "prev": { - "example": "/media-thumbnail?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media Thumbnail" - ], - "summary": "Create a new Media Thumbnail resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnail", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaThumbnail", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-thumbnail/{id}": { - "get": { - "tags": [ - "Media Thumbnail" - ], - "summary": "Detailed information about a Media Thumbnail resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnail", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_thumbnail", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MediaThumbnail", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media Thumbnail" - ], - "summary": "Delete a Media Thumbnail resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnail", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_thumbnail", - "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": [ - "Media Thumbnail" - ], - "summary": "Partially update information about a Media Thumbnail resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnail", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_thumbnail", - "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 Media Thumbnail resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaThumbnail", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-thumbnail-size": { - "get": { - "tags": [ - "Media Thumbnail Size" - ], - "summary": "List with basic information of Media Thumbnail Size resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSizeList", - "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 Media Thumbnail Size 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/MediaThumbnailSize" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media-thumbnail-size?limit=25" - }, - "last": { - "example": "/media-thumbnail-size?limit=25&page=11" - }, - "next": { - "example": "/media-thumbnail-size?limit=25&page=4" - }, - "prev": { - "example": "/media-thumbnail-size?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media Thumbnail Size" - ], - "summary": "Create a new Media Thumbnail Size resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnailSize", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaThumbnailSize", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-thumbnail-size/{id}": { - "get": { - "tags": [ - "Media Thumbnail Size" - ], - "summary": "Detailed information about a Media Thumbnail Size resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_thumbnail_size", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MediaThumbnailSize", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media Thumbnail Size" - ], - "summary": "Delete a Media Thumbnail Size resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnailSize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_thumbnail_size", - "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": [ - "Media Thumbnail Size" - ], - "summary": "Partially update information about a Media Thumbnail Size resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnailSize", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_thumbnail_size", - "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 Media Thumbnail Size resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaThumbnailSize", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/newsletter-recipient": { - "get": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "List with basic information of Newsletter Recipient resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipientList", - "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 Newsletter Recipient 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/NewsletterRecipient" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/newsletter-recipient?limit=25" - }, - "last": { - "example": "/newsletter-recipient?limit=25&page=11" - }, - "next": { - "example": "/newsletter-recipient?limit=25&page=4" - }, - "prev": { - "example": "/newsletter-recipient?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "Create a new Newsletter Recipient resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNewsletterRecipient", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NewsletterRecipient", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/newsletter-recipient/{id}": { - "get": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "Detailed information about a Newsletter Recipient resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipient", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the newsletter_recipient", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of NewsletterRecipient", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "Delete a Newsletter Recipient resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNewsletterRecipient", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the newsletter_recipient", - "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": [ - "Newsletter Recipient" - ], - "summary": "Partially update information about a Newsletter Recipient resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNewsletterRecipient", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the newsletter_recipient", - "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 Newsletter Recipient resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NewsletterRecipient", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/notification": { - "get": { - "tags": [ - "Notification" - ], - "summary": "List with basic information of Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotificationList", - "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 Notification 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/Notification" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/notification?limit=25" - }, - "last": { - "example": "/notification?limit=25&page=11" - }, - "next": { - "example": "/notification?limit=25&page=4" - }, - "prev": { - "example": "/notification?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Notification" - ], - "summary": "Create a new Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createNotification", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Notification" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Notification", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Notification" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/notification/{id}": { - "get": { - "tags": [ - "Notification" - ], - "summary": "Detailed information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotification", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the notification", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Notification", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Notification" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Notification" - ], - "summary": "Delete a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteNotification", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the notification", - "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": [ - "Notification" - ], - "summary": "Partially update information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateNotification", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the notification", - "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 Notification resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Notification" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Notification", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Notification" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range": { - "get": { - "tags": [ - "Number Range" - ], - "summary": "List with basic information of Number Range resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeList", - "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 Number Range 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/NumberRange" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/number-range?limit=25" - }, - "last": { - "example": "/number-range?limit=25&page=11" - }, - "next": { - "example": "/number-range?limit=25&page=4" - }, - "prev": { - "example": "/number-range?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Number Range" - ], - "summary": "Create a new Number Range resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNumberRange", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRange", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range/{id}": { - "get": { - "tags": [ - "Number Range" - ], - "summary": "Detailed information about a Number Range resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRange", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of NumberRange", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Number Range" - ], - "summary": "Delete a Number Range resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRange", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range", - "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": [ - "Number Range" - ], - "summary": "Partially update information about a Number Range resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRange", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range", - "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 Number Range resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRange", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range-sales-channel": { - "get": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "List with basic information of Number Range Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannelList", - "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 Number Range Sales Channel 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/NumberRangeSalesChannel" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/number-range-sales-channel?limit=25" - }, - "last": { - "example": "/number-range-sales-channel?limit=25&page=11" - }, - "next": { - "example": "/number-range-sales-channel?limit=25&page=4" - }, - "prev": { - "example": "/number-range-sales-channel?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "Create a new Number Range Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeSalesChannel", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRangeSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range-sales-channel/{id}": { - "get": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "Detailed information about a Number Range Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_sales_channel", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of NumberRangeSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "Delete a Number Range Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_sales_channel", - "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": [ - "Number Range Sales Channel" - ], - "summary": "Partially update information about a Number Range Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_sales_channel", - "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 Number Range Sales Channel resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRangeSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range-state": { - "get": { - "tags": [ - "Number Range State" - ], - "summary": "List with basic information of Number Range State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeStateList", - "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 Number Range State 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/NumberRangeState" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/number-range-state?limit=25" - }, - "last": { - "example": "/number-range-state?limit=25&page=11" - }, - "next": { - "example": "/number-range-state?limit=25&page=4" - }, - "prev": { - "example": "/number-range-state?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Number Range State" - ], - "summary": "Create a new Number Range State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeState", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRangeState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range-state/{id}": { - "get": { - "tags": [ - "Number Range State" - ], - "summary": "Detailed information about a Number Range State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_state", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of NumberRangeState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Number Range State" - ], - "summary": "Delete a Number Range State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_state", - "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": [ - "Number Range State" - ], - "summary": "Partially update information about a Number Range State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_state", - "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 Number Range State resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRangeState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range-type": { - "get": { - "tags": [ - "Number Range Type" - ], - "summary": "List with basic information of Number Range Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeTypeList", - "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 Number Range Type 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/NumberRangeType" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/number-range-type?limit=25" - }, - "last": { - "example": "/number-range-type?limit=25&page=11" - }, - "next": { - "example": "/number-range-type?limit=25&page=4" - }, - "prev": { - "example": "/number-range-type?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Number Range Type" - ], - "summary": "Create a new Number Range Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeType", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRangeType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/number-range-type/{id}": { - "get": { - "tags": [ - "Number Range Type" - ], - "summary": "Detailed information about a Number Range Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_type", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of NumberRangeType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Number Range Type" - ], - "summary": "Delete a Number Range Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_type", - "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": [ - "Number Range Type" - ], - "summary": "Partially update information about a Number Range Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeType", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the number_range_type", - "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 Number Range Type resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of NumberRangeType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order": { - "get": { - "tags": [ - "Order" - ], - "summary": "List with basic information of Order resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderList", - "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 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/Order" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order?limit=25" - }, - "last": { - "example": "/order?limit=25&page=11" - }, - "next": { - "example": "/order?limit=25&page=4" - }, - "prev": { - "example": "/order?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order" - ], - "summary": "Create a new Order resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrder", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Order", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order/{id}": { - "get": { - "tags": [ - "Order" - ], - "summary": "Detailed information about a Order resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Order", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order" - ], - "summary": "Delete a Order resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the 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" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Order" - ], - "summary": "Partially update information about a Order resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the 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 Order resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Order", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Order" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-address": { - "get": { - "tags": [ - "Order Address" - ], - "summary": "List with basic information of Order Address resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddressList", - "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 Order Address 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/OrderAddress" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-address?limit=25" - }, - "last": { - "example": "/order-address?limit=25&page=11" - }, - "next": { - "example": "/order-address?limit=25&page=4" - }, - "prev": { - "example": "/order-address?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Address" - ], - "summary": "Create a new Order Address resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderAddress", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-address/{id}": { - "get": { - "tags": [ - "Order Address" - ], - "summary": "Detailed information about a Order Address resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_address", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Address" - ], - "summary": "Delete a Order Address resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_address", - "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": [ - "Order Address" - ], - "summary": "Partially update information about a Order Address resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_address", - "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 Order Address resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-customer": { - "get": { - "tags": [ - "Order Customer" - ], - "summary": "List with basic information of Order Customer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomerList", - "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 Order 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/OrderCustomer" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-customer?limit=25" - }, - "last": { - "example": "/order-customer?limit=25&page=11" - }, - "next": { - "example": "/order-customer?limit=25&page=4" - }, - "prev": { - "example": "/order-customer?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Customer" - ], - "summary": "Create a new Order Customer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderCustomer", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-customer/{id}": { - "get": { - "tags": [ - "Order Customer" - ], - "summary": "Detailed information about a Order Customer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Customer" - ], - "summary": "Delete a Order Customer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Order Customer" - ], - "summary": "Partially update information about a Order Customer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Order Customer resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-delivery": { - "get": { - "tags": [ - "Order Delivery" - ], - "summary": "List with basic information of Order Delivery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryList", - "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 Order Delivery 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/OrderDelivery" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-delivery?limit=25" - }, - "last": { - "example": "/order-delivery?limit=25&page=11" - }, - "next": { - "example": "/order-delivery?limit=25&page=4" - }, - "prev": { - "example": "/order-delivery?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Delivery" - ], - "summary": "Create a new Order Delivery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderDelivery", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderDelivery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-delivery/{id}": { - "get": { - "tags": [ - "Order Delivery" - ], - "summary": "Detailed information about a Order Delivery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderDelivery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_delivery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderDelivery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Delivery" - ], - "summary": "Delete a Order Delivery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDelivery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_delivery", - "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": [ - "Order Delivery" - ], - "summary": "Partially update information about a Order Delivery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDelivery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_delivery", - "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 Order Delivery resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderDelivery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-delivery-position": { - "get": { - "tags": [ - "Order Delivery Position" - ], - "summary": "List with basic information of Order Delivery Position resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPositionList", - "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 Order Delivery Position 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/OrderDeliveryPosition" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-delivery-position?limit=25" - }, - "last": { - "example": "/order-delivery-position?limit=25&page=11" - }, - "next": { - "example": "/order-delivery-position?limit=25&page=4" - }, - "prev": { - "example": "/order-delivery-position?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Delivery Position" - ], - "summary": "Create a new Order Delivery Position resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderDeliveryPosition", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderDeliveryPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-delivery-position/{id}": { - "get": { - "tags": [ - "Order Delivery Position" - ], - "summary": "Detailed information about a Order Delivery Position resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_delivery_position", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderDeliveryPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Delivery Position" - ], - "summary": "Delete a Order Delivery Position resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDeliveryPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_delivery_position", - "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": [ - "Order Delivery Position" - ], - "summary": "Partially update information about a Order Delivery Position resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDeliveryPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_delivery_position", - "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 Order Delivery Position resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderDeliveryPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-line-item": { - "get": { - "tags": [ - "Order Line Item" - ], - "summary": "List with basic information of Order Line Item resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItemList", - "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 Order Line Item 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/OrderLineItem" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-line-item?limit=25" - }, - "last": { - "example": "/order-line-item?limit=25&page=11" - }, - "next": { - "example": "/order-line-item?limit=25&page=4" - }, - "prev": { - "example": "/order-line-item?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Line Item" - ], - "summary": "Create a new Order Line Item resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderLineItem", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-line-item/{id}": { - "get": { - "tags": [ - "Order Line Item" - ], - "summary": "Detailed information about a Order Line Item resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_line_item", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Line Item" - ], - "summary": "Delete a Order Line Item resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_line_item", - "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": [ - "Order Line Item" - ], - "summary": "Partially update information about a Order Line Item resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_line_item", - "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 Order Line Item resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-line-item-download": { - "get": { - "tags": [ - "Order Line Item Download" - ], - "summary": "List with basic information of Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownloadList", - "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 Order Line Item Download 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/OrderLineItemDownload" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-line-item-download?limit=25" - }, - "last": { - "example": "/order-line-item-download?limit=25&page=11" - }, - "next": { - "example": "/order-line-item-download?limit=25&page=4" - }, - "prev": { - "example": "/order-line-item-download?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Line Item Download" - ], - "summary": "Create a new Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createOrderLineItemDownload", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderLineItemDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-line-item-download/{id}": { - "get": { - "tags": [ - "Order Line Item Download" - ], - "summary": "Detailed information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownload", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_line_item_download", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderLineItemDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Line Item Download" - ], - "summary": "Delete a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteOrderLineItemDownload", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_line_item_download", - "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": [ - "Order Line Item Download" - ], - "summary": "Partially update information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateOrderLineItemDownload", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_line_item_download", - "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 Order Line Item Download resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderLineItemDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction": { - "get": { - "tags": [ - "Order Transaction" - ], - "summary": "List with basic information of Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransactionList", - "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 Order Transaction 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/OrderTransaction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-transaction?limit=25" - }, - "last": { - "example": "/order-transaction?limit=25&page=11" - }, - "next": { - "example": "/order-transaction?limit=25&page=4" - }, - "prev": { - "example": "/order-transaction?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Transaction" - ], - "summary": "Create a new Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderTransaction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransaction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction/{id}": { - "get": { - "tags": [ - "Order Transaction" - ], - "summary": "Detailed information about a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransaction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderTransaction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Transaction" - ], - "summary": "Delete a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderTransaction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction", - "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": [ - "Order Transaction" - ], - "summary": "Partially update information about a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderTransaction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction", - "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 Order Transaction resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransaction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture": { - "get": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "List with basic information of Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureList", - "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 Order Transaction Capture 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/OrderTransactionCapture" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-transaction-capture?limit=25" - }, - "last": { - "example": "/order-transaction-capture?limit=25&page=11" - }, - "next": { - "example": "/order-transaction-capture?limit=25&page=4" - }, - "prev": { - "example": "/order-transaction-capture?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "Create a new Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCapture", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCapture", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture/{id}": { - "get": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "Detailed information about a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCapture", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderTransactionCapture", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "Delete a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCapture", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture", - "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": [ - "Order Transaction Capture" - ], - "summary": "Partially update information about a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCapture", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture", - "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 Order Transaction Capture resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCapture", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture-refund": { - "get": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "List with basic information of Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundList", - "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 Order Transaction Capture Refund 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/OrderTransactionCaptureRefund" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-transaction-capture-refund?limit=25" - }, - "last": { - "example": "/order-transaction-capture-refund?limit=25&page=11" - }, - "next": { - "example": "/order-transaction-capture-refund?limit=25&page=4" - }, - "prev": { - "example": "/order-transaction-capture-refund?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Create a new Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefund", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture-refund/{id}": { - "get": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Detailed information about a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefund", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Delete a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefund", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund", - "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": [ - "Order Transaction Capture Refund" - ], - "summary": "Partially update information about a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefund", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund", - "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 Order Transaction Capture Refund resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture-refund-position": { - "get": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "List with basic information of Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPositionList", - "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 Order Transaction Capture Refund Position 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/OrderTransactionCaptureRefundPosition" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-transaction-capture-refund-position?limit=25" - }, - "last": { - "example": "/order-transaction-capture-refund-position?limit=25&page=11" - }, - "next": { - "example": "/order-transaction-capture-refund-position?limit=25&page=4" - }, - "prev": { - "example": "/order-transaction-capture-refund-position?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Create a new Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefundPosition", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture-refund-position/{id}": { - "get": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Delete a Order Transaction Capture Refund Position resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefundPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", - "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": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefundPosition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", - "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 Order Transaction Capture Refund Position resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/payment-method": { - "get": { - "tags": [ - "Payment Method" - ], - "summary": "List with basic information of Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethodList", - "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 Payment Method 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/PaymentMethod" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/payment-method?limit=25" - }, - "last": { - "example": "/payment-method?limit=25&page=11" - }, - "next": { - "example": "/payment-method?limit=25&page=4" - }, - "prev": { - "example": "/payment-method?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Payment Method" - ], - "summary": "Create a new Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPaymentMethod", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/payment-method/{id}": { - "get": { - "tags": [ - "Payment Method" - ], - "summary": "Detailed information about a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the payment_method", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Payment Method" - ], - "summary": "Delete a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePaymentMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the payment_method", - "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": [ - "Payment Method" - ], - "summary": "Partially update information about a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePaymentMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the payment_method", - "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 Payment Method resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/plugin": { - "get": { - "tags": [ - "Plugin" - ], - "summary": "List with basic information of Plugin resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPluginList", - "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 Plugin 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/Plugin" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/plugin?limit=25" - }, - "last": { - "example": "/plugin?limit=25&page=11" - }, - "next": { - "example": "/plugin?limit=25&page=4" - }, - "prev": { - "example": "/plugin?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Plugin" - ], - "summary": "Create a new Plugin resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPlugin", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Plugin", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/plugin/{id}": { - "get": { - "tags": [ - "Plugin" - ], - "summary": "Detailed information about a Plugin resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPlugin", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the plugin", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Plugin", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Plugin" - ], - "summary": "Delete a Plugin resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePlugin", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the plugin", - "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": [ - "Plugin" - ], - "summary": "Partially update information about a Plugin resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePlugin", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the plugin", - "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 Plugin resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Plugin", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plugin" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product": { - "get": { - "tags": [ - "Product" - ], - "summary": "List with basic information of Product resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductList", - "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 Product 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/Product" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product?limit=25" - }, - "last": { - "example": "/product?limit=25&page=11" - }, - "next": { - "example": "/product?limit=25&page=4" - }, - "prev": { - "example": "/product?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product" - ], - "summary": "Create a new Product resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProduct", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Product" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Product", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Product" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product/{id}": { - "get": { - "tags": [ - "Product" - ], - "summary": "Detailed information about a Product resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProduct", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Product", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Product" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product" - ], - "summary": "Delete a Product resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProduct", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product", - "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": [ - "Product" - ], - "summary": "Partially update information about a Product resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProduct", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product", - "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 Product resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Product" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Product", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Product" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-configurator-setting": { - "get": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "List with basic information of Product Configurator Setting resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSettingList", - "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 Product Configurator Setting 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/ProductConfiguratorSetting" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-configurator-setting?limit=25" - }, - "last": { - "example": "/product-configurator-setting?limit=25&page=11" - }, - "next": { - "example": "/product-configurator-setting?limit=25&page=4" - }, - "prev": { - "example": "/product-configurator-setting?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "Create a new Product Configurator Setting resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductConfiguratorSetting", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductConfiguratorSetting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-configurator-setting/{id}": { - "get": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "Detailed information about a Product Configurator Setting resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSetting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_configurator_setting", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductConfiguratorSetting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "Delete a Product Configurator Setting resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductConfiguratorSetting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_configurator_setting", - "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": [ - "Product Configurator Setting" - ], - "summary": "Partially update information about a Product Configurator Setting resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductConfiguratorSetting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_configurator_setting", - "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 Product Configurator Setting resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductConfiguratorSetting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-cross-selling": { - "get": { - "tags": [ - "Product Cross Selling" - ], - "summary": "List with basic information of Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSellingList", - "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 Product Cross Selling 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/ProductCrossSelling" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-cross-selling?limit=25" - }, - "last": { - "example": "/product-cross-selling?limit=25&page=11" - }, - "next": { - "example": "/product-cross-selling?limit=25&page=4" - }, - "prev": { - "example": "/product-cross-selling?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Cross Selling" - ], - "summary": "Create a new Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductCrossSelling", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductCrossSelling", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-cross-selling/{id}": { - "get": { - "tags": [ - "Product Cross Selling" - ], - "summary": "Detailed information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSelling", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_cross_selling", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductCrossSelling", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Cross Selling" - ], - "summary": "Delete a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductCrossSelling", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_cross_selling", - "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": [ - "Product Cross Selling" - ], - "summary": "Partially update information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductCrossSelling", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_cross_selling", - "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 Product Cross Selling resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductCrossSelling", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-cross-selling-assigned-products": { - "get": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "List with basic information of Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProductsList", - "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 Product Cross Selling Assigned Products 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/ProductCrossSellingAssignedProducts" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-cross-selling-assigned-products?limit=25" - }, - "last": { - "example": "/product-cross-selling-assigned-products?limit=25&page=11" - }, - "next": { - "example": "/product-cross-selling-assigned-products?limit=25&page=4" - }, - "prev": { - "example": "/product-cross-selling-assigned-products?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Create a new Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createProductCrossSellingAssignedProducts", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-cross-selling-assigned-products/{id}": { - "get": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProducts", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Delete a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteProductCrossSellingAssignedProducts", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", - "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": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateProductCrossSellingAssignedProducts", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", - "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 Product Cross Selling Assigned Products resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-download": { - "get": { - "tags": [ - "Product Download" - ], - "summary": "List with basic information of Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownloadList", - "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 Product Download 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/ProductDownload" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-download?limit=25" - }, - "last": { - "example": "/product-download?limit=25&page=11" - }, - "next": { - "example": "/product-download?limit=25&page=4" - }, - "prev": { - "example": "/product-download?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Download" - ], - "summary": "Create a new Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createProductDownload", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-download/{id}": { - "get": { - "tags": [ - "Product Download" - ], - "summary": "Detailed information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownload", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_download", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Download" - ], - "summary": "Delete a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteProductDownload", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_download", - "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": [ - "Product Download" - ], - "summary": "Partially update information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateProductDownload", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_download", - "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 Product Download resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-export": { - "get": { - "tags": [ - "Product Export" - ], - "summary": "List with basic information of Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExportList", - "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 Product Export 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/ProductExport" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-export?limit=25" - }, - "last": { - "example": "/product-export?limit=25&page=11" - }, - "next": { - "example": "/product-export?limit=25&page=4" - }, - "prev": { - "example": "/product-export?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Export" - ], - "summary": "Create a new Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductExport", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductExport", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-export/{id}": { - "get": { - "tags": [ - "Product Export" - ], - "summary": "Detailed information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExport", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_export", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductExport", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Export" - ], - "summary": "Delete a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductExport", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_export", - "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": [ - "Product Export" - ], - "summary": "Partially update information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductExport", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_export", - "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 Product Export resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductExport", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-feature-set": { - "get": { - "tags": [ - "Product Feature Set" - ], - "summary": "List with basic information of Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSetList", - "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 Product Feature Set 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/ProductFeatureSet" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-feature-set?limit=25" - }, - "last": { - "example": "/product-feature-set?limit=25&page=11" - }, - "next": { - "example": "/product-feature-set?limit=25&page=4" - }, - "prev": { - "example": "/product-feature-set?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Feature Set" - ], - "summary": "Create a new Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "createProductFeatureSet", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductFeatureSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-feature-set/{id}": { - "get": { - "tags": [ - "Product Feature Set" - ], - "summary": "Detailed information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_feature_set", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductFeatureSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Feature Set" - ], - "summary": "Delete a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "deleteProductFeatureSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_feature_set", - "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": [ - "Product Feature Set" - ], - "summary": "Partially update information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "updateProductFeatureSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_feature_set", - "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 Product Feature Set resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductFeatureSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-keyword-dictionary": { - "get": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "List with basic information of Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionaryList", - "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 Product Keyword Dictionary 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/ProductKeywordDictionary" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-keyword-dictionary?limit=25" - }, - "last": { - "example": "/product-keyword-dictionary?limit=25&page=11" - }, - "next": { - "example": "/product-keyword-dictionary?limit=25&page=4" - }, - "prev": { - "example": "/product-keyword-dictionary?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "Create a new Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductKeywordDictionary", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductKeywordDictionary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-keyword-dictionary/{id}": { - "get": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "Detailed information about a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_keyword_dictionary", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductKeywordDictionary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "Delete a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductKeywordDictionary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_keyword_dictionary", - "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": [ - "Product Keyword Dictionary" - ], - "summary": "Partially update information about a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductKeywordDictionary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_keyword_dictionary", - "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 Product Keyword Dictionary resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductKeywordDictionary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-manufacturer": { - "get": { - "tags": [ - "Product Manufacturer" - ], - "summary": "List with basic information of Product Manufacturer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturerList", - "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 Product Manufacturer 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/ProductManufacturer" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-manufacturer?limit=25" - }, - "last": { - "example": "/product-manufacturer?limit=25&page=11" - }, - "next": { - "example": "/product-manufacturer?limit=25&page=4" - }, - "prev": { - "example": "/product-manufacturer?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Manufacturer" - ], - "summary": "Create a new Product Manufacturer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductManufacturer", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductManufacturer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-manufacturer/{id}": { - "get": { - "tags": [ - "Product Manufacturer" - ], - "summary": "Detailed information about a Product Manufacturer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_manufacturer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductManufacturer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Manufacturer" - ], - "summary": "Delete a Product Manufacturer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductManufacturer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_manufacturer", - "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": [ - "Product Manufacturer" - ], - "summary": "Partially update information about a Product Manufacturer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductManufacturer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_manufacturer", - "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 Product Manufacturer resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductManufacturer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-media": { - "get": { - "tags": [ - "Product Media" - ], - "summary": "List with basic information of Product Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductMediaList", - "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 Product Media 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/ProductMedia" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-media?limit=25" - }, - "last": { - "example": "/product-media?limit=25&page=11" - }, - "next": { - "example": "/product-media?limit=25&page=4" - }, - "prev": { - "example": "/product-media?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Media" - ], - "summary": "Create a new Product Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductMedia", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductMedia", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-media/{id}": { - "get": { - "tags": [ - "Product Media" - ], - "summary": "Detailed information about a Product Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductMedia", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_media", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductMedia", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Media" - ], - "summary": "Delete a Product Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductMedia", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_media", - "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": [ - "Product Media" - ], - "summary": "Partially update information about a Product Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductMedia", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_media", - "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 Product Media resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductMedia", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-price": { - "get": { - "tags": [ - "Product Price" - ], - "summary": "List with basic information of Product Price resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductPriceList", - "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 Product 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/ProductPrice" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-price?limit=25" - }, - "last": { - "example": "/product-price?limit=25&page=11" - }, - "next": { - "example": "/product-price?limit=25&page=4" - }, - "prev": { - "example": "/product-price?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Price" - ], - "summary": "Create a new Product Price resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductPrice", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-price/{id}": { - "get": { - "tags": [ - "Product Price" - ], - "summary": "Detailed information about a Product Price resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_price", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Price" - ], - "summary": "Delete a Product Price resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_price", - "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": [ - "Product Price" - ], - "summary": "Partially update information about a Product Price resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_price", - "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 Product Price resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-review": { - "get": { - "tags": [ - "Product Review" - ], - "summary": "List with basic information of Product Review resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductReviewList", - "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 Product Review 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/ProductReview" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-review?limit=25" - }, - "last": { - "example": "/product-review?limit=25&page=11" - }, - "next": { - "example": "/product-review?limit=25&page=4" - }, - "prev": { - "example": "/product-review?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Review" - ], - "summary": "Create a new Product Review resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductReview", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductReview", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-review/{id}": { - "get": { - "tags": [ - "Product Review" - ], - "summary": "Detailed information about a Product Review resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductReview", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductReview", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Review" - ], - "summary": "Delete a Product Review resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductReview", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review", - "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": [ - "Product Review" - ], - "summary": "Partially update information about a Product Review resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductReview", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review", - "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 Product Review resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductReview", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-search-config": { - "get": { - "tags": [ - "Product Search Config" - ], - "summary": "List with basic information of Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigList", - "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 Product Search Config 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/ProductSearchConfig" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-search-config?limit=25" - }, - "last": { - "example": "/product-search-config?limit=25&page=11" - }, - "next": { - "example": "/product-search-config?limit=25&page=4" - }, - "prev": { - "example": "/product-search-config?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Search Config" - ], - "summary": "Create a new Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfig", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSearchConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-search-config/{id}": { - "get": { - "tags": [ - "Product Search Config" - ], - "summary": "Detailed information about a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_config", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductSearchConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Search Config" - ], - "summary": "Delete a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_config", - "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": [ - "Product Search Config" - ], - "summary": "Partially update information about a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_config", - "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 Product Search Config resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSearchConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-search-config-field": { - "get": { - "tags": [ - "Product Search Config Field" - ], - "summary": "List with basic information of Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigFieldList", - "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 Product Search Config Field 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/ProductSearchConfigField" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-search-config-field?limit=25" - }, - "last": { - "example": "/product-search-config-field?limit=25&page=11" - }, - "next": { - "example": "/product-search-config-field?limit=25&page=4" - }, - "prev": { - "example": "/product-search-config-field?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Search Config Field" - ], - "summary": "Create a new Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfigField", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-search-config-field/{id}": { - "get": { - "tags": [ - "Product Search Config Field" - ], - "summary": "Detailed information about a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_config_field", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Search Config Field" - ], - "summary": "Delete a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfigField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_config_field", - "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": [ - "Product Search Config Field" - ], - "summary": "Partially update information about a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfigField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_config_field", - "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 Product Search Config Field resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-search-keyword": { - "get": { - "tags": [ - "Product Search Keyword" - ], - "summary": "List with basic information of Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeywordList", - "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 Product Search Keyword 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/ProductSearchKeyword" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-search-keyword?limit=25" - }, - "last": { - "example": "/product-search-keyword?limit=25&page=11" - }, - "next": { - "example": "/product-search-keyword?limit=25&page=4" - }, - "prev": { - "example": "/product-search-keyword?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Search Keyword" - ], - "summary": "Create a new Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductSearchKeyword", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSearchKeyword", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-search-keyword/{id}": { - "get": { - "tags": [ - "Product Search Keyword" - ], - "summary": "Detailed information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeyword", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_keyword", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductSearchKeyword", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Search Keyword" - ], - "summary": "Delete a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductSearchKeyword", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_keyword", - "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": [ - "Product Search Keyword" - ], - "summary": "Partially update information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductSearchKeyword", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_search_keyword", - "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 Product Search Keyword resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSearchKeyword", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-sorting": { - "get": { - "tags": [ - "Product Sorting" - ], - "summary": "List with basic information of Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSortingList", - "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 Product Sorting 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/ProductSorting" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-sorting?limit=25" - }, - "last": { - "example": "/product-sorting?limit=25&page=11" - }, - "next": { - "example": "/product-sorting?limit=25&page=4" - }, - "prev": { - "example": "/product-sorting?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Sorting" - ], - "summary": "Create a new Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "createProductSorting", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-sorting/{id}": { - "get": { - "tags": [ - "Product Sorting" - ], - "summary": "Detailed information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSorting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_sorting", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Sorting" - ], - "summary": "Delete a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "deleteProductSorting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_sorting", - "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": [ - "Product Sorting" - ], - "summary": "Partially update information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "updateProductSorting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_sorting", - "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 Product Sorting resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-stream": { - "get": { - "tags": [ - "Product Stream" - ], - "summary": "List with basic information of Product Stream resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamList", - "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 Product Stream 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/ProductStream" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-stream?limit=25" - }, - "last": { - "example": "/product-stream?limit=25&page=11" - }, - "next": { - "example": "/product-stream?limit=25&page=4" - }, - "prev": { - "example": "/product-stream?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Stream" - ], - "summary": "Create a new Product Stream resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductStream", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductStream", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-stream/{id}": { - "get": { - "tags": [ - "Product Stream" - ], - "summary": "Detailed information about a Product Stream resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStream", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_stream", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductStream", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Stream" - ], - "summary": "Delete a Product Stream resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStream", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_stream", - "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": [ - "Product Stream" - ], - "summary": "Partially update information about a Product Stream resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductStream", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_stream", - "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 Product Stream resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductStream", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-stream-filter": { - "get": { - "tags": [ - "Product Stream Filter" - ], - "summary": "List with basic information of Product Stream Filter resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilterList", - "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 Product Stream Filter 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/ProductStreamFilter" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-stream-filter?limit=25" - }, - "last": { - "example": "/product-stream-filter?limit=25&page=11" - }, - "next": { - "example": "/product-stream-filter?limit=25&page=4" - }, - "prev": { - "example": "/product-stream-filter?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Stream Filter" - ], - "summary": "Create a new Product Stream Filter resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductStreamFilter", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-stream-filter/{id}": { - "get": { - "tags": [ - "Product Stream Filter" - ], - "summary": "Detailed information about a Product Stream Filter resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_stream_filter", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Stream Filter" - ], - "summary": "Delete a Product Stream Filter resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStreamFilter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_stream_filter", - "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": [ - "Product Stream Filter" - ], - "summary": "Partially update information about a Product Stream Filter resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductStreamFilter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_stream_filter", - "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 Product Stream Filter resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-visibility": { - "get": { - "tags": [ - "Product Visibility" - ], - "summary": "List with basic information of Product Visibility resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibilityList", - "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 Product Visibility 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/ProductVisibility" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-visibility?limit=25" - }, - "last": { - "example": "/product-visibility?limit=25&page=11" - }, - "next": { - "example": "/product-visibility?limit=25&page=4" - }, - "prev": { - "example": "/product-visibility?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Visibility" - ], - "summary": "Create a new Product Visibility resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductVisibility", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductVisibility", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-visibility/{id}": { - "get": { - "tags": [ - "Product Visibility" - ], - "summary": "Detailed information about a Product Visibility resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibility", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_visibility", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductVisibility", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Visibility" - ], - "summary": "Delete a Product Visibility resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductVisibility", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_visibility", - "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": [ - "Product Visibility" - ], - "summary": "Partially update information about a Product Visibility resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductVisibility", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_visibility", - "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 Product Visibility resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductVisibility", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion": { - "get": { - "tags": [ - "Promotion" - ], - "summary": "List with basic information of Promotion resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionList", - "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 Promotion 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/Promotion" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/promotion?limit=25" - }, - "last": { - "example": "/promotion?limit=25&page=11" - }, - "next": { - "example": "/promotion?limit=25&page=4" - }, - "prev": { - "example": "/promotion?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Promotion" - ], - "summary": "Create a new Promotion resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPromotion", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Promotion" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Promotion", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Promotion" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion/{id}": { - "get": { - "tags": [ - "Promotion" - ], - "summary": "Detailed information about a Promotion resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotion", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Promotion", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Promotion" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Promotion" - ], - "summary": "Delete a Promotion resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePromotion", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion", - "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": [ - "Promotion" - ], - "summary": "Partially update information about a Promotion resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePromotion", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion", - "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 Promotion resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Promotion" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Promotion", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Promotion" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-discount": { - "get": { - "tags": [ - "Promotion Discount" - ], - "summary": "List with basic information of Promotion Discount resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountList", - "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 Promotion Discount 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/PromotionDiscount" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/promotion-discount?limit=25" - }, - "last": { - "example": "/promotion-discount?limit=25&page=11" - }, - "next": { - "example": "/promotion-discount?limit=25&page=4" - }, - "prev": { - "example": "/promotion-discount?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Promotion Discount" - ], - "summary": "Create a new Promotion Discount resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscount", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionDiscount", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-discount/{id}": { - "get": { - "tags": [ - "Promotion Discount" - ], - "summary": "Detailed information about a Promotion Discount resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscount", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_discount", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PromotionDiscount", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Promotion Discount" - ], - "summary": "Delete a Promotion Discount resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscount", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_discount", - "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": [ - "Promotion Discount" - ], - "summary": "Partially update information about a Promotion Discount resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscount", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_discount", - "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 Promotion Discount resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionDiscount", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-discount-prices": { - "get": { - "tags": [ - "Promotion Discount Prices" - ], - "summary": "List with basic information of Promotion Discount Prices resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPricesList", - "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 Promotion Discount Prices 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/PromotionDiscountPrices" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/promotion-discount-prices?limit=25" - }, - "last": { - "example": "/promotion-discount-prices?limit=25&page=11" - }, - "next": { - "example": "/promotion-discount-prices?limit=25&page=4" - }, - "prev": { - "example": "/promotion-discount-prices?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Promotion Discount Prices" - ], - "summary": "Create a new Promotion Discount Prices resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscountPrices", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionDiscountPrices", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-discount-prices/{id}": { - "get": { - "tags": [ - "Promotion Discount Prices" - ], - "summary": "Detailed information about a Promotion Discount Prices resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPrices", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_discount_prices", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PromotionDiscountPrices", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Promotion Discount Prices" - ], - "summary": "Delete a Promotion Discount Prices resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscountPrices", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_discount_prices", - "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": [ - "Promotion Discount Prices" - ], - "summary": "Partially update information about a Promotion Discount Prices resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscountPrices", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_discount_prices", - "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 Promotion Discount Prices resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionDiscountPrices", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-individual-code": { - "get": { - "tags": [ - "Promotion Individual Code" - ], - "summary": "List with basic information of Promotion Individual Code resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCodeList", - "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 Promotion Individual Code 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/PromotionIndividualCode" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/promotion-individual-code?limit=25" - }, - "last": { - "example": "/promotion-individual-code?limit=25&page=11" - }, - "next": { - "example": "/promotion-individual-code?limit=25&page=4" - }, - "prev": { - "example": "/promotion-individual-code?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Promotion Individual Code" - ], - "summary": "Create a new Promotion Individual Code resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPromotionIndividualCode", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionIndividualCode", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-individual-code/{id}": { - "get": { - "tags": [ - "Promotion Individual Code" - ], - "summary": "Detailed information about a Promotion Individual Code resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCode", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_individual_code", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PromotionIndividualCode", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Promotion Individual Code" - ], - "summary": "Delete a Promotion Individual Code resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionIndividualCode", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_individual_code", - "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": [ - "Promotion Individual Code" - ], - "summary": "Partially update information about a Promotion Individual Code resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionIndividualCode", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_individual_code", - "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 Promotion Individual Code resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionIndividualCode", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-sales-channel": { - "get": { - "tags": [ - "Promotion Sales Channel" - ], - "summary": "List with basic information of Promotion Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannelList", - "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 Promotion Sales Channel 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/PromotionSalesChannel" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/promotion-sales-channel?limit=25" - }, - "last": { - "example": "/promotion-sales-channel?limit=25&page=11" - }, - "next": { - "example": "/promotion-sales-channel?limit=25&page=4" - }, - "prev": { - "example": "/promotion-sales-channel?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Promotion Sales Channel" - ], - "summary": "Create a new Promotion Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSalesChannel", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-sales-channel/{id}": { - "get": { - "tags": [ - "Promotion Sales Channel" - ], - "summary": "Detailed information about a Promotion Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_sales_channel", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PromotionSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Promotion Sales Channel" - ], - "summary": "Delete a Promotion Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_sales_channel", - "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": [ - "Promotion Sales Channel" - ], - "summary": "Partially update information about a Promotion Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_sales_channel", - "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 Promotion Sales Channel resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-setgroup": { - "get": { - "tags": [ - "Promotion Setgroup" - ], - "summary": "List with basic information of Promotion Setgroup resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroupList", - "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 Promotion Setgroup 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/PromotionSetgroup" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/promotion-setgroup?limit=25" - }, - "last": { - "example": "/promotion-setgroup?limit=25&page=11" - }, - "next": { - "example": "/promotion-setgroup?limit=25&page=4" - }, - "prev": { - "example": "/promotion-setgroup?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Promotion Setgroup" - ], - "summary": "Create a new Promotion Setgroup resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSetgroup", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionSetgroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/promotion-setgroup/{id}": { - "get": { - "tags": [ - "Promotion Setgroup" - ], - "summary": "Detailed information about a Promotion Setgroup resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_setgroup", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PromotionSetgroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Promotion Setgroup" - ], - "summary": "Delete a Promotion Setgroup resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSetgroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_setgroup", - "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": [ - "Promotion Setgroup" - ], - "summary": "Partially update information about a Promotion Setgroup resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSetgroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the promotion_setgroup", - "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 Promotion Setgroup resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PromotionSetgroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/property-group": { - "get": { - "tags": [ - "Property Group" - ], - "summary": "List with basic information of Property Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupList", - "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 Property 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/PropertyGroup" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/property-group?limit=25" - }, - "last": { - "example": "/property-group?limit=25&page=11" - }, - "next": { - "example": "/property-group?limit=25&page=4" - }, - "prev": { - "example": "/property-group?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Property Group" - ], - "summary": "Create a new Property Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroup", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PropertyGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/property-group/{id}": { - "get": { - "tags": [ - "Property Group" - ], - "summary": "Detailed information about a Property Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the property_group", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PropertyGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Property Group" - ], - "summary": "Delete a Property Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the property_group", - "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": [ - "Property Group" - ], - "summary": "Partially update information about a Property Group resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the property_group", - "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 Property Group resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PropertyGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/property-group-option": { - "get": { - "tags": [ - "Property Group Option" - ], - "summary": "List with basic information of Property Group Option resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOptionList", - "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 Property Group Option 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/PropertyGroupOption" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/property-group-option?limit=25" - }, - "last": { - "example": "/property-group-option?limit=25&page=11" - }, - "next": { - "example": "/property-group-option?limit=25&page=4" - }, - "prev": { - "example": "/property-group-option?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Property Group Option" - ], - "summary": "Create a new Property Group Option resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroupOption", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PropertyGroupOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/property-group-option/{id}": { - "get": { - "tags": [ - "Property Group Option" - ], - "summary": "Detailed information about a Property Group Option resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the property_group_option", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of PropertyGroupOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Property Group Option" - ], - "summary": "Delete a Property Group Option resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroupOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the property_group_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": [ - "Property Group Option" - ], - "summary": "Partially update information about a Property Group Option resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroupOption", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the property_group_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 Property Group Option resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of PropertyGroupOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/rule": { - "get": { - "tags": [ - "Rule" - ], - "summary": "List with basic information of Rule resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getRuleList", - "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 Rule 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/Rule" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/rule?limit=25" - }, - "last": { - "example": "/rule?limit=25&page=11" - }, - "next": { - "example": "/rule?limit=25&page=4" - }, - "prev": { - "example": "/rule?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Rule" - ], - "summary": "Create a new Rule resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createRule", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rule" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Rule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rule" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/rule/{id}": { - "get": { - "tags": [ - "Rule" - ], - "summary": "Detailed information about a Rule resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getRule", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the rule", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Rule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rule" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Rule" - ], - "summary": "Delete a Rule resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteRule", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the rule", - "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": [ - "Rule" - ], - "summary": "Partially update information about a Rule resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateRule", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the rule", - "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 Rule resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rule" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Rule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Rule" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/rule-condition": { - "get": { - "tags": [ - "Rule Condition" - ], - "summary": "List with basic information of Rule Condition resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getRuleConditionList", - "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 Rule Condition 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/RuleCondition" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/rule-condition?limit=25" - }, - "last": { - "example": "/rule-condition?limit=25&page=11" - }, - "next": { - "example": "/rule-condition?limit=25&page=4" - }, - "prev": { - "example": "/rule-condition?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Rule Condition" - ], - "summary": "Create a new Rule Condition resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createRuleCondition", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of RuleCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/rule-condition/{id}": { - "get": { - "tags": [ - "Rule Condition" - ], - "summary": "Detailed information about a Rule Condition resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getRuleCondition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the rule_condition", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of RuleCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Rule Condition" - ], - "summary": "Delete a Rule Condition resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteRuleCondition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the rule_condition", - "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": [ - "Rule Condition" - ], - "summary": "Partially update information about a Rule Condition resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateRuleCondition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the rule_condition", - "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 Rule Condition resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of RuleCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel": { - "get": { - "tags": [ - "Sales Channel" - ], - "summary": "List with basic information of Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelList", - "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 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/SalesChannel" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel?limit=25" - }, - "last": { - "example": "/sales-channel?limit=25&page=11" - }, - "next": { - "example": "/sales-channel?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Sales Channel" - ], - "summary": "Create a new Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannel", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel/{id}": { - "get": { - "tags": [ - "Sales Channel" - ], - "summary": "Detailed information about a Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Sales Channel" - ], - "summary": "Delete a Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel", - "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": [ - "Sales Channel" - ], - "summary": "Partially update information about a Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel", - "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 resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-analytics": { - "get": { - "tags": [ - "Sales Channel Analytics" - ], - "summary": "List with basic information of Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalyticsList", - "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 Analytics 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/SalesChannelAnalytics" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel-analytics?limit=25" - }, - "last": { - "example": "/sales-channel-analytics?limit=25&page=11" - }, - "next": { - "example": "/sales-channel-analytics?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel-analytics?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Sales Channel Analytics" - ], - "summary": "Create a new Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createSalesChannelAnalytics", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelAnalytics", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-analytics/{id}": { - "get": { - "tags": [ - "Sales Channel Analytics" - ], - "summary": "Detailed information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalytics", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_analytics", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SalesChannelAnalytics", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Sales Channel Analytics" - ], - "summary": "Delete a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteSalesChannelAnalytics", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_analytics", - "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": [ - "Sales Channel Analytics" - ], - "summary": "Partially update information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateSalesChannelAnalytics", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_analytics", - "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 Analytics resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelAnalytics", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-domain": { - "get": { - "tags": [ - "Sales Channel Domain" - ], - "summary": "List with basic information of Sales Channel Domain resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomainList", - "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 Domain 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/SalesChannelDomain" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel-domain?limit=25" - }, - "last": { - "example": "/sales-channel-domain?limit=25&page=11" - }, - "next": { - "example": "/sales-channel-domain?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel-domain?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Sales Channel Domain" - ], - "summary": "Create a new Sales Channel Domain resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelDomain", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelDomain", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-domain/{id}": { - "get": { - "tags": [ - "Sales Channel Domain" - ], - "summary": "Detailed information about a Sales Channel Domain resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomain", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_domain", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SalesChannelDomain", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Sales Channel Domain" - ], - "summary": "Delete a Sales Channel Domain resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelDomain", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_domain", - "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": [ - "Sales Channel Domain" - ], - "summary": "Partially update information about a Sales Channel Domain resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelDomain", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the sales_channel_domain", - "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 Domain resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelDomain", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-type": { - "get": { - "tags": [ - "Sales Channel Type" - ], - "summary": "List with basic information of Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelTypeList", - "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 Type 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/SalesChannelType" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/sales-channel-type?limit=25" - }, - "last": { - "example": "/sales-channel-type?limit=25&page=11" - }, - "next": { - "example": "/sales-channel-type?limit=25&page=4" - }, - "prev": { - "example": "/sales-channel-type?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Sales Channel Type" - ], - "summary": "Create a new Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/sales-channel-type/{id}": { - "get": { - "tags": [ - "Sales Channel Type" - ], - "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_type", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SalesChannelType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Sales Channel Type" - ], - "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_type", - "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": [ - "Sales Channel Type" - ], - "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_type", - "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 Type resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SalesChannelType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/salutation": { - "get": { - "tags": [ - "Salutation" - ], - "summary": "List with basic information of Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", - "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 Salutation 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/Salutation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/salutation?limit=25" - }, - "last": { - "example": "/salutation?limit=25&page=11" - }, - "next": { - "example": "/salutation?limit=25&page=4" - }, - "prev": { - "example": "/salutation?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Salutation" - ], - "summary": "Create a new Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalutation", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Salutation" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Salutation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Salutation" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/salutation/{id}": { - "get": { - "tags": [ - "Salutation" - ], - "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 salutation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Salutation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Salutation" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Salutation" - ], - "summary": "Delete a Salutation resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the salutation", - "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": [ - "Salutation" - ], - "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 salutation", - "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 Salutation resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Salutation" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Salutation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Salutation" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/scheduled-task": { - "get": { - "tags": [ - "Scheduled Task" - ], - "summary": "List with basic information of Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTaskList", - "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 Scheduled Task 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/ScheduledTask" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/scheduled-task?limit=25" - }, - "last": { - "example": "/scheduled-task?limit=25&page=11" - }, - "next": { - "example": "/scheduled-task?limit=25&page=4" - }, - "prev": { - "example": "/scheduled-task?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Scheduled Task" - ], - "summary": "Create a new Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createScheduledTask", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/scheduled-task/{id}": { - "get": { - "tags": [ - "Scheduled Task" - ], - "summary": "Detailed information about a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the scheduled_task", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Scheduled Task" - ], - "summary": "Delete a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteScheduledTask", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the scheduled_task", - "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": [ - "Scheduled Task" - ], - "summary": "Partially update information about a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateScheduledTask", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the scheduled_task", - "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 Scheduled Task resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/script": { - "get": { - "tags": [ - "Script" - ], - "summary": "List with basic information of Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getScriptList", - "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 Script 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/Script" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/script?limit=25" - }, - "last": { - "example": "/script?limit=25&page=11" - }, - "next": { - "example": "/script?limit=25&page=4" - }, - "prev": { - "example": "/script?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Script" - ], - "summary": "Create a new Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createScript", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Script" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Script", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Script" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/script/{id}": { - "get": { - "tags": [ - "Script" - ], - "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 script", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Script", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Script" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Script" - ], - "summary": "Delete a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteScript", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the script", - "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": [ - "Script" - ], - "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 script", - "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 Script resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Script" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Script", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Script" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/seo-url": { - "get": { - "tags": [ - "Seo Url" - ], - "summary": "List with basic information of Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlList", - "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 Seo Url 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/SeoUrl" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/seo-url?limit=25" - }, - "last": { - "example": "/seo-url?limit=25&page=11" - }, - "next": { - "example": "/seo-url?limit=25&page=4" - }, - "prev": { - "example": "/seo-url?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Seo Url" - ], - "summary": "Create a new Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrl", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SeoUrl", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/seo-url/{id}": { - "get": { - "tags": [ - "Seo Url" - ], - "summary": "Detailed information about a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrl", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the seo_url", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SeoUrl", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Seo Url" - ], - "summary": "Delete a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrl", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the seo_url", - "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": [ - "Seo Url" - ], - "summary": "Partially update information about a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrl", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the seo_url", - "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 Seo Url resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SeoUrl", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/seo-url-template": { - "get": { - "tags": [ - "Seo Url Template" - ], - "summary": "List with basic information of Seo Url Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplateList", - "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 Seo Url Template 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/SeoUrlTemplate" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/seo-url-template?limit=25" - }, - "last": { - "example": "/seo-url-template?limit=25&page=11" - }, - "next": { - "example": "/seo-url-template?limit=25&page=4" - }, - "prev": { - "example": "/seo-url-template?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Seo Url Template" - ], - "summary": "Create a new Seo Url Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrlTemplate", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SeoUrlTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/seo-url-template/{id}": { - "get": { - "tags": [ - "Seo Url Template" - ], - "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 seo_url_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SeoUrlTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Seo Url Template" - ], - "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 seo_url_template", - "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": [ - "Seo Url Template" - ], - "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 seo_url_template", - "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 Seo Url Template resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SeoUrlTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/shipping-method": { - "get": { - "tags": [ - "Shipping Method" - ], - "summary": "List with basic information of Shipping Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodList", - "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 Shipping Method 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/ShippingMethod" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/shipping-method?limit=25" - }, - "last": { - "example": "/shipping-method?limit=25&page=11" - }, - "next": { - "example": "/shipping-method?limit=25&page=4" - }, - "prev": { - "example": "/shipping-method?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Shipping Method" - ], - "summary": "Create a new Shipping Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethod", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ShippingMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/shipping-method/{id}": { - "get": { - "tags": [ - "Shipping Method" - ], - "summary": "Detailed information about a Shipping Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the shipping_method", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ShippingMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Shipping Method" - ], - "summary": "Delete a Shipping Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the shipping_method", - "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": [ - "Shipping Method" - ], - "summary": "Partially update information about a Shipping Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the shipping_method", - "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 Shipping Method resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ShippingMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/shipping-method-price": { - "get": { - "tags": [ - "Shipping Method Price" - ], - "summary": "List with basic information of Shipping Method Price resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPriceList", - "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 Shipping Method 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/ShippingMethodPrice" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/shipping-method-price?limit=25" - }, - "last": { - "example": "/shipping-method-price?limit=25&page=11" - }, - "next": { - "example": "/shipping-method-price?limit=25&page=4" - }, - "prev": { - "example": "/shipping-method-price?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Shipping Method Price" - ], - "summary": "Create a new Shipping Method Price resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethodPrice", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ShippingMethodPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/shipping-method-price/{id}": { - "get": { - "tags": [ - "Shipping Method Price" - ], - "summary": "Detailed information about a Shipping Method Price resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the shipping_method_price", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ShippingMethodPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Shipping Method Price" - ], - "summary": "Delete a Shipping Method Price resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethodPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the shipping_method_price", - "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": [ - "Shipping Method Price" - ], - "summary": "Partially update information about a Shipping Method Price resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethodPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the shipping_method_price", - "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 Shipping Method Price resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ShippingMethodPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/snippet": { - "get": { - "tags": [ - "Snippet" - ], - "summary": "List with basic information of Snippet resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSnippetList", - "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 Snippet 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/Snippet" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/snippet?limit=25" - }, - "last": { - "example": "/snippet?limit=25&page=11" - }, - "next": { - "example": "/snippet?limit=25&page=4" - }, - "prev": { - "example": "/snippet?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Snippet" - ], - "summary": "Create a new Snippet resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSnippet", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Snippet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Snippet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/snippet/{id}": { - "get": { - "tags": [ - "Snippet" - ], - "summary": "Detailed information about a Snippet resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Snippet" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Snippet" - ], - "summary": "Delete a Snippet resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet", - "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": [ - "Snippet" - ], - "summary": "Partially update information about a Snippet resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet", - "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 Snippet resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Snippet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Snippet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/snippet-set": { - "get": { - "tags": [ - "Snippet Set" - ], - "summary": "List with basic information of Snippet Set resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSetList", - "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 Snippet Set 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/SnippetSet" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/snippet-set?limit=25" - }, - "last": { - "example": "/snippet-set?limit=25&page=11" - }, - "next": { - "example": "/snippet-set?limit=25&page=4" - }, - "prev": { - "example": "/snippet-set?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Snippet Set" - ], - "summary": "Create a new Snippet Set resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSnippetSet", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SnippetSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/snippet-set/{id}": { - "get": { - "tags": [ - "Snippet Set" - ], - "summary": "Detailed information about a Snippet Set resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet_set", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SnippetSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Snippet Set" - ], - "summary": "Delete a Snippet Set resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippetSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet_set", - "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": [ - "Snippet Set" - ], - "summary": "Partially update information about a Snippet Set resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSnippetSet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet_set", - "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 Snippet Set resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SnippetSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine": { - "get": { - "tags": [ - "State Machine" - ], - "summary": "List with basic information of State Machine resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineList", - "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 State Machine 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/StateMachine" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/state-machine?limit=25" - }, - "last": { - "example": "/state-machine?limit=25&page=11" - }, - "next": { - "example": "/state-machine?limit=25&page=4" - }, - "prev": { - "example": "/state-machine?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "State Machine" - ], - "summary": "Create a new State Machine resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createStateMachine", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachine", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine/{id}": { - "get": { - "tags": [ - "State Machine" - ], - "summary": "Detailed information about a State Machine resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachine", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of StateMachine", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "State Machine" - ], - "summary": "Delete a State Machine resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachine", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine", - "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": [ - "State Machine" - ], - "summary": "Partially update information about a State Machine resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachine", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine", - "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 State Machine resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachine", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-history": { - "get": { - "tags": [ - "State Machine History" - ], - "summary": "List with basic information of State Machine History resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistoryList", - "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 State Machine History 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/StateMachineHistory" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/state-machine-history?limit=25" - }, - "last": { - "example": "/state-machine-history?limit=25&page=11" - }, - "next": { - "example": "/state-machine-history?limit=25&page=4" - }, - "prev": { - "example": "/state-machine-history?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "State Machine History" - ], - "summary": "Create a new State Machine History resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineHistory", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-history/{id}": { - "get": { - "tags": [ - "State Machine History" - ], - "summary": "Detailed information about a State Machine History resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_history", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "State Machine History" - ], - "summary": "Delete a State Machine History resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_history", - "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": [ - "State Machine History" - ], - "summary": "Partially update information about a State Machine History resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_history", - "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 State Machine History resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-state": { - "get": { - "tags": [ - "State Machine State" - ], - "summary": "List with basic information of State Machine State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineStateList", - "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 State Machine State 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/StateMachineState" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/state-machine-state?limit=25" - }, - "last": { - "example": "/state-machine-state?limit=25&page=11" - }, - "next": { - "example": "/state-machine-state?limit=25&page=4" - }, - "prev": { - "example": "/state-machine-state?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "State Machine State" - ], - "summary": "Create a new State Machine State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineState", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-state/{id}": { - "get": { - "tags": [ - "State Machine State" - ], - "summary": "Detailed information about a State Machine State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_state", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of StateMachineState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "State Machine State" - ], - "summary": "Delete a State Machine State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_state", - "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": [ - "State Machine State" - ], - "summary": "Partially update information about a State Machine State resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineState", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_state", - "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 State Machine State resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-transition": { - "get": { - "tags": [ - "State Machine Transition" - ], - "summary": "List with basic information of State Machine Transition resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransitionList", - "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 State Machine Transition 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/StateMachineTransition" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/state-machine-transition?limit=25" - }, - "last": { - "example": "/state-machine-transition?limit=25&page=11" - }, - "next": { - "example": "/state-machine-transition?limit=25&page=4" - }, - "prev": { - "example": "/state-machine-transition?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "State Machine Transition" - ], - "summary": "Create a new State Machine Transition resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineTransition", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineTransition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-transition/{id}": { - "get": { - "tags": [ - "State Machine Transition" - ], - "summary": "Detailed information about a State Machine Transition resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_transition", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of StateMachineTransition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "State Machine Transition" - ], - "summary": "Delete a State Machine Transition resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineTransition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_transition", - "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": [ - "State Machine Transition" - ], - "summary": "Partially update information about a State Machine Transition resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineTransition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_transition", - "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 State Machine Transition resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineTransition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/system-config": { - "get": { - "tags": [ - "System Config" - ], - "summary": "List with basic information of System Config resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfigList", - "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 System Config 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/SystemConfig" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/system-config?limit=25" - }, - "last": { - "example": "/system-config?limit=25&page=11" - }, - "next": { - "example": "/system-config?limit=25&page=4" - }, - "prev": { - "example": "/system-config?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "System Config" - ], - "summary": "Create a new System Config resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSystemConfig", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/system-config/{id}": { - "get": { - "tags": [ - "System Config" - ], - "summary": "Detailed information about a System Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the system_config", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "System Config" - ], - "summary": "Delete a System Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the system_config", - "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": [ - "System Config" - ], - "summary": "Partially update information about a System Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the system_config", - "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 System Config resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tag": { - "get": { - "tags": [ - "Tag" - ], - "summary": "List with basic information of Tag resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getTagList", - "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 Tag 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/Tag" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/tag?limit=25" - }, - "last": { - "example": "/tag?limit=25&page=11" - }, - "next": { - "example": "/tag?limit=25&page=4" - }, - "prev": { - "example": "/tag?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Tag" - ], - "summary": "Create a new Tag resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTag", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tag" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Tag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tag" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tag/{id}": { - "get": { - "tags": [ - "Tag" - ], - "summary": "Detailed information about a Tag resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTag", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tag", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Tag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tag" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Tag" - ], - "summary": "Delete a Tag resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTag", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tag", - "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": [ - "Tag" - ], - "summary": "Partially update information about a Tag resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTag", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tag", - "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 Tag resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tag" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Tag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tag" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax": { - "get": { - "tags": [ - "Tax" - ], - "summary": "List with basic information of Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getTaxList", - "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 Tax 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/Tax" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/tax?limit=25" - }, - "last": { - "example": "/tax?limit=25&page=11" - }, - "next": { - "example": "/tax?limit=25&page=4" - }, - "prev": { - "example": "/tax?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tax" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Tax" - ], - "summary": "Create a new Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTax", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tax" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Tax", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tax" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax/{id}": { - "get": { - "tags": [ - "Tax" - ], - "summary": "Detailed information about a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTax", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tax", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Tax", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tax" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Tax" - ], - "summary": "Delete a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTax", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tax", - "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": [ - "Tax" - ], - "summary": "Partially update information about a Tax resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTax", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tax", - "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 Tax resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tax" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Tax", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Tax" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-provider": { - "get": { - "tags": [ - "Tax Provider" - ], - "summary": "List with basic information of Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProviderList", - "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 Tax Provider 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/TaxProvider" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/tax-provider?limit=25" - }, - "last": { - "example": "/tax-provider?limit=25&page=11" - }, - "next": { - "example": "/tax-provider?limit=25&page=4" - }, - "prev": { - "example": "/tax-provider?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Tax Provider" - ], - "summary": "Create a new Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "createTaxProvider", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-provider/{id}": { - "get": { - "tags": [ - "Tax Provider" - ], - "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 tax_provider", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Tax Provider" - ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the tax_provider", - "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": [ - "Tax Provider" - ], - "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 tax_provider", - "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 Tax Provider resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-rule": { - "get": { - "tags": [ - "Tax Rule" - ], - "summary": "List with basic information of Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleList", - "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 Tax Rule 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/TaxRule" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/tax-rule?limit=25" - }, - "last": { - "example": "/tax-rule?limit=25&page=11" - }, - "next": { - "example": "/tax-rule?limit=25&page=4" - }, - "prev": { - "example": "/tax-rule?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Tax Rule" - ], - "summary": "Create a new Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRule", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxRule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-rule/{id}": { - "get": { - "tags": [ - "Tax Rule" - ], - "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_rule", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of TaxRule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Tax Rule" - ], - "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_rule", - "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": [ - "Tax Rule" - ], - "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_rule", - "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 Tax Rule resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxRule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-rule-type": { - "get": { - "tags": [ - "Tax Rule Type" - ], - "summary": "List with basic information of Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleTypeList", - "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 Tax Rule Type 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/TaxRuleType" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/tax-rule-type?limit=25" - }, - "last": { - "example": "/tax-rule-type?limit=25&page=11" - }, - "next": { - "example": "/tax-rule-type?limit=25&page=4" - }, - "prev": { - "example": "/tax-rule-type?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Tax Rule Type" - ], - "summary": "Create a new Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRuleType", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxRuleType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-rule-type/{id}": { - "get": { - "tags": [ - "Tax Rule Type" - ], - "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_rule_type", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of TaxRuleType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Tax Rule Type" - ], - "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_rule_type", - "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": [ - "Tax Rule Type" - ], - "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_rule_type", - "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 Tax Rule Type resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxRuleType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/theme": { - "get": { - "tags": [ - "Theme" - ], - "summary": "List with basic information of Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getThemeList", - "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 Theme 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/Theme" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/theme?limit=25" - }, - "last": { - "example": "/theme?limit=25&page=11" - }, - "next": { - "example": "/theme?limit=25&page=4" - }, - "prev": { - "example": "/theme?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Theme" - ], - "summary": "Create a new Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTheme", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Theme" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Theme" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/theme/{id}": { - "get": { - "tags": [ - "Theme" - ], - "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 theme", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Theme" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Theme" - ], - "summary": "Delete a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the theme", - "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": [ - "Theme" - ], - "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 theme", - "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 Theme resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Theme" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Theme" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/unit": { - "get": { - "tags": [ - "Unit" - ], - "summary": "List with basic information of Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUnitList", - "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 Unit 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/Unit" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/unit?limit=25" - }, - "last": { - "example": "/unit?limit=25&page=11" - }, - "next": { - "example": "/unit?limit=25&page=4" - }, - "prev": { - "example": "/unit?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Unit" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Unit" - ], - "summary": "Create a new Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUnit", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Unit", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/unit/{id}": { - "get": { - "tags": [ - "Unit" - ], - "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 unit", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Unit", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Unit" - ], - "summary": "Delete a Unit resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUnit", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the unit", - "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": [ - "Unit" - ], - "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 unit", - "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 Unit resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Unit", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Unit" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user": { - "get": { - "tags": [ - "User" - ], - "summary": "List with basic information of User resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserList", - "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 User 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/User" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/user?limit=25" - }, - "last": { - "example": "/user?limit=25&page=11" - }, - "next": { - "example": "/user?limit=25&page=4" - }, - "prev": { - "example": "/user?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "User" - ], - "summary": "Create a new User resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUser", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of User", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user/{id}": { - "get": { - "tags": [ - "User" - ], - "summary": "Detailed information about a User resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of User", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "User" - ], - "summary": "Delete a User resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user", - "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" - ], - "summary": "Partially update information about a User resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user", - "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 resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of User", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-access-key": { - "get": { - "tags": [ - "User Access Key" - ], - "summary": "List with basic information of User Access Key resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKeyList", - "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 User Access Key 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/UserAccessKey" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/user-access-key?limit=25" - }, - "last": { - "example": "/user-access-key?limit=25&page=11" - }, - "next": { - "example": "/user-access-key?limit=25&page=4" - }, - "prev": { - "example": "/user-access-key?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "User Access Key" - ], - "summary": "Create a new User Access Key resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserAccessKey", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-access-key/{id}": { - "get": { - "tags": [ - "User Access Key" - ], - "summary": "Detailed information about a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_access_key", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "User Access Key" - ], - "summary": "Delete a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_access_key", - "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 Access Key" - ], - "summary": "Partially update information about a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_access_key", - "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 Access Key resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-config": { - "get": { - "tags": [ - "User Config" - ], - "summary": "List with basic information of User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfigList", - "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 User Config 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/UserConfig" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/user-config?limit=25" - }, - "last": { - "example": "/user-config?limit=25&page=11" - }, - "next": { - "example": "/user-config?limit=25&page=4" - }, - "prev": { - "example": "/user-config?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "User Config" - ], - "summary": "Create a new User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createUserConfig", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of UserConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-config/{id}": { - "get": { - "tags": [ - "User Config" - ], - "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_config", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of UserConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "User Config" - ], - "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_config", - "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 Config" - ], - "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_config", - "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 Config resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of UserConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserConfig" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-recovery": { - "get": { - "tags": [ - "User Recovery" - ], - "summary": "List with basic information of User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecoveryList", - "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 User Recovery 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/UserRecovery" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/user-recovery?limit=25" - }, - "last": { - "example": "/user-recovery?limit=25&page=11" - }, - "next": { - "example": "/user-recovery?limit=25&page=4" - }, - "prev": { - "example": "/user-recovery?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "User Recovery" - ], - "summary": "Create a new User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserRecovery", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-recovery/{id}": { - "get": { - "tags": [ - "User Recovery" - ], - "summary": "Detailed information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecovery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_recovery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "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": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "User Recovery" - ], - "summary": "Delete a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserRecovery", - "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/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$ref": "#/components/schemas/UserRecovery" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "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/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$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": { - "$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/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$ref": "#/components/schemas/Webhook" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "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/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$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": { - "$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", - "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 Event Log" - ], - "summary": "Partially update information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "updateWebhookEventLog", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the webhook_event_log", - "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 Event Log resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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": { - "$ref": "#/components/schemas/WebhookEventLog" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/guided-shopping-presentation": { - "post": { - "tags": [ - "Presentation" - ], - "summary": "Search presentations", - "description": "Return list of presentations", - "operationId": "searchPresentations", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetListBodyRequest" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Presentation" - } - }, - "aggregations": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/guided-shopping-presentation/{presentationId}": { - "get": { - "tags": [ - "Presentation" - ], - "summary": "Get detail of presentation", - "description": "", - "operationId": "getPresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Presentation" - } - } - } - } - } - } - } - }, - "patch": { - "tags": [ - "Presentation" - ], - "summary": "Update partially the existing presentation", - "description": "", - "operationId": "updatePresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Presentation" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Presentation" - ], - "summary": "Delete presentation", - "description": "", - "operationId": "deletePresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, "/_action/guided-shopping/appointment/{appointmentId}/join-as-guide": { "post": { "tags": [ @@ -55217,6 +493,32 @@ } } }, + "/guided-shopping-appointment": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Create a new appointment", + "description": "", + "operationId": "createAppointment", + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Appointment" + } + } + } + }, + "responses": { + "204": { + "description": "" + } + } + } + }, "/guided-shopping-appointment/{appointmentId}": { "get": { "tags": [ @@ -55315,6 +617,181 @@ } } } + }, + "/search/guided-shopping-presentation": { + "post": { + "tags": [ + "Presentation" + ], + "summary": "Search presentations", + "description": "Return list of presentations", + "operationId": "searchPresentations", + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetListBodyRequest" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Presentation" + } + }, + "aggregations": { + "type": "array", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + } + }, + "/guided-shopping-presentation": { + "post": { + "tags": [ + "Presentation" + ], + "summary": "Create a new presentation", + "description": "", + "operationId": "createPresentation", + "parameters": [], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Presentation" + } + } + } + }, + "responses": { + "204": { + "description": "" + } + } + } + }, + "/guided-shopping-presentation/{presentationId}": { + "get": { + "tags": [ + "Presentation" + ], + "summary": "Get detail of presentation", + "description": "", + "operationId": "getPresentation", + "parameters": [ + { + "name": "presentationId", + "in": "path", + "description": "Presentation id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Presentation" + } + } + } + } + } + } + } + }, + "patch": { + "tags": [ + "Presentation" + ], + "summary": "Update partially the existing presentation", + "description": "", + "operationId": "updatePresentation", + "parameters": [ + { + "name": "presentationId", + "in": "path", + "description": "Presentation id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Presentation" + } + } + } + }, + "responses": { + "204": { + "description": "" + } + } + }, + "delete": { + "tags": [ + "Presentation" + ], + "summary": "Delete presentation", + "description": "", + "operationId": "deletePresentation", + "parameters": [ + { + "name": "presentationId", + "in": "path", + "description": "Presentation id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "" + } + } + } } }, "components": { @@ -56368,6 +1845,37 @@ } }, "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" @@ -56551,6 +2059,12 @@ "items": { "$ref": "#/components/schemas/AppFlowEvent" } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } }, "type": "object" @@ -57759,6 +3273,202 @@ }, "type": "object" }, + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "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": [ + "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": [ @@ -61335,6 +7045,10 @@ "labelProperty": { "type": "string" }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -61393,6 +7107,10 @@ "labelProperty": { "type": "string" }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -64291,6 +10009,9 @@ "deepLinkCode": { "type": "string" }, + "documentNumber": { + "type": "string" + }, "customFields": { "type": "object" }, @@ -64511,6 +10232,9 @@ "deepLinkCode": { "type": "string" }, + "documentNumber": { + "type": "string" + }, "customFields": { "type": "object" }, @@ -70388,6 +16112,9 @@ "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" @@ -71157,6 +16884,37 @@ } }, "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" @@ -71224,6 +16982,9 @@ "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" @@ -71439,6 +17200,12 @@ "items": { "$ref": "#/components/schemas/AppPaymentMethod" } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } }, "type": "object" @@ -72115,6 +17882,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "path": { + "type": "string" + }, "customFields": { "type": "object" }, @@ -72198,6 +17968,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "path": { + "type": "string" + }, "customFields": { "type": "object" }, @@ -78201,6 +23974,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -78547,6 +24323,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -90779,6 +36558,9 @@ "trackingUrl": { "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -91064,6 +36846,35 @@ } }, "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" @@ -91125,6 +36936,9 @@ "trackingUrl": { "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -91179,6 +36993,9 @@ }, "tax": { "$ref": "#/components/schemas/Tax" + }, + "appShippingMethod": { + "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" @@ -96076,6 +41893,9 @@ "url": { "type": "string" }, + "onlyLiveVersion": { + "type": "boolean" + }, "errorCount": { "type": "integer", "format": "int64", @@ -96160,6 +41980,9 @@ "url": { "type": "string" }, + "onlyLiveVersion": { + "type": "boolean" + }, "errorCount": { "type": "integer", "format": "int64", @@ -96246,6 +42069,9 @@ "url": { "type": "string" }, + "onlyLiveVersion": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -96317,6 +42143,9 @@ "url": { "type": "string" }, + "onlyLiveVersion": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -96333,291 +42162,614 @@ }, "type": "object" }, - "PresentationCmsPage": { + "flowBulderActionsResponse": { + "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" + } + } + } + }, + "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" + } + } + } + } + }, + "infoConfigResponse": { "type": "object", "properties": { - "id": { + "version": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation cms page id" + "description": "The Shopware version." }, - "title": { - "anyOf": [ - { - "type": "string" + "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." }, - { - "type": "null" + "transports": { + "type": "array", + "description": "Configured transports.", + "items": { + "type": "string" + } } - ], - "description": "The title of presentation cms page" - }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation using this presentation cms page" + } }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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." + } + } + } + } }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page id the presentation using" + "settings": { + "type": "object", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." + } + } + } + } + }, + "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" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page version id the presentation using" + "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" + ] + } }, - "productId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + }, + "naturalSorting": { + "type": "boolean" + } }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product detail" + "required": [ + "field" + ] + } }, - "productStreamId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } }, - { - "type": "null" - } - ], - "description": "The product stream id is assigned to presentation if it's product listing" + "required": [ + "type", + "field", + "value" + ] + } }, - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" + "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" } }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" + "required": [ + "name", + "type", + "field" + ] + } }, - "position": { - "type": "integer", - "description": "The position of slide" + "grouping": { + "type": "array", + "description": "Perform groupings over certain fields", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "isInstantListing": { - "type": "boolean", - "description": "True if this slide is an instant listing" + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "createdAt": { + "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", - "format": "date-time" + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" + ] + } + } + }, + "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" }, - "updatedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" }, - { - "type": "null" + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" } + }, + "required": [ + "client_id", + "client_secret" ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "customFields": { - "anyOf": [ - { - "type": "object" + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] }, - { - "type": "null" + "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" }, - "translated": { + { "type": "object", "properties": { - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } + "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" + ] } - } + ] }, - "GetAttendeeInsightsResponse": { + "GuidePresentationStateResponse": { "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "attendees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" }, - "currencySymbol": { - "type": "string" + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" } }, "example": { "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } - }, - "StateForGuides": { - "type": "object", - "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" }, - "default": [] - }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" }, - "default": [] + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "allowUserActionsForGuide": true, + "broadcastMode": false, + "extensions": [] }, - "guides": { + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "guideCartPermissionsGranted": false + }, + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "guideCartPermissionsGranted": false + }, + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "guideCartPermissionsGranted": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "guideCartPermissionsGranted": false + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "guideCartPermissionsGranted": false + } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "guideCartPermissionsGranted": false + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + } + } + }, + "JoinAppointmentResponse": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "mercureSubscriberTopics": { "type": "array", "items": { - "type": "string" + "type": "string", + "description": "mercure topic" }, - "default": [] + "description": "The topics to which the attendee/guide can subscribe for" }, - "videoGuideToken": { - "anyOf": [ + "mercurePublisherTopic": { + "oneOf": [ { "type": "string" }, { "type": "null" } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + ], + "description": "The topic to which the attendee/guide can send updates" }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "Attendee": { - "type": "object", - "required": [ - "appointmentId", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "JWTMercureSubscriberToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to publish updates" }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "mercureHubPublicUrl": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mercure hub url to connect for subscribing and updating" }, - "appointment": { - "$ref": "#/components/schemas/Appointment" + "JWTMercurePublisherToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to subscribe for updates" }, - "type": { + "id": { "type": "string", - "enum": [ - "CLIENT", - "GUIDE" - ] - }, - "attendeeName": { - "type": "string" - }, - "attendeeEmail": { - "type": "string" - }, - "videoUserId": { - "type": "string" - }, - "guideCartPermissionsGranted": { - "type": "boolean" + "pattern": "^[0-9a-f]{32}$", + "description": "The appointment id" }, - "attendeeSubmittedAt": { + "newContextToken": { "type": "string", - "format": "date-timme" + "description": "The new context token" }, - "customerId": { + "attendeeId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customer": { - "$ref": "#/components/schemas/Customer" + "pattern": "^[0-9a-f]{32}$", + "description": "The created Id for the attendee" }, - "userId": { + "salesChannelId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "user": { - "$ref": "#/components/schemas/User" - }, - "invitationStatus": { - "type": "string" + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the current sales channel" }, - "joinedAt": { + "presentationGuideMode": { "type": "string", - "format": "date-timme" + "enum": [ + "self", + "guided" + ], + "description": "The type of the appointment" }, - "lastActive": { + "isPreview": { + "type": "boolean", + "description": "To see if it's a preview appointment" + } + }, + "example": { + "mercureSubscriberTopics": [ + "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" + ], + "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", + "JWTMercureSubscriberToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6WyJncy1ndWlkZS1hY3Rpb25zLTJkMmMzNThmMWNhMDQwOThhYWNmMTI4NzNjMmVlZDgyIiwiZ3MtcHJlc2VudGF0aW9uLXN0YXRlLWZvci1jbGllbnQtMmQyYzM1OGYxY2EwNDA5OGFhY2YxMjg3M2MyZWVkODIiLCJncy1wcmVzZW50YXRpb24tc3RhdGUtZm9yLWFsbC0yZDJjMzU4ZjFjYTA0MDk4YWFjZjEyODczYzJlZWQ4MiJdLCJwdWJsaXNoIjpbXX19.UUkrRCu9PT2FOhkxhWKLo8nUGzwI7l3zqVo74laI-D8", + "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", + "JWTMercurePublisherToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6W10sInB1Ymxpc2giOlsiZ3MtY2xpZW50LWFjdGlvbnMtMmQyYzM1OGYxY2EwNDA5OGFhY2YxMjg3M2MyZWVkODIiXX19.g5-_JrB2xdeByr40t7XnnK_qxqOclaY5MKBpTytdFmY", + "id": "2d2c358f1ca04098aacf12873c2eed82", + "newContextToken": "VR9yWqI2ovhNpdRFWbbn6Z5Fy4wUmDsm", + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", + "presentationGuideMode": "guided", + "isPreview": false, + "apiAlias": "swag_guided_shopping_content_appointment_struct_appointment_join_struct" + } + }, + "AttendeeInsights": { + "type": "object", + "description": "Attendee Insights", + "properties": { + "id": { "type": "string", - "format": "date-timme" + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "interaction": { - "$ref": "#/components/schemas/Interaction" + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" }, - "productCollections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeProductCollection" - } + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" + } + }, + "example": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 } } }, @@ -96819,28 +42971,352 @@ } ] }, - "productListingDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "productListingDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "allowUserActionsForGuide": { + "type": "boolean", + "default": false + }, + "broadcastMode": { + "type": "boolean", + "default": false + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "AttendeeProductCollection": { + "type": "object", + "required": [ + "attendeeId", + "productId", + "productVersionId", + "alias" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "attendee": { + "$ref": "#/components/schemas/Attendee" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "alias": { + "type": "string", + "enum": [ + "liked", + "disliked" + ] + } + } + }, + "Interaction": { + "type": "object", + "required": [ + "name", + "triggeredAt", + "attendeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "triggeredAt": { + "type": "string", + "format": "date-time" + }, + "payload": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "attendee": { + "$ref": "#/components/schemas/Attendee" + } + } + }, + "Presentation": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "translations": { + "type": "array", + "items": { + "type": "object" + } + }, + "appointment": { + "$ref": "#/components/schemas/Appointment" + }, + "cmsPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + }, + "translated": { + "type": "object" + } + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "quickViewState": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "VideoChatCreateStruct": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" + }, + "roomName": { + "type": "string", + "description": "Name of the video room in daily" + }, + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" + }, + "ownerToken": { + "type": "string", + "description": "Token for the room owner (guide) to connect to the daily room" + }, + "startAsBroadcast": { + "type": "boolean", + "default": false + } + }, + "example": { + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "eyJhbGciOiJIUzI1NbIsInR5cCI6IkpXVCJ9.eyJyIjoiclNx4jBtcmd3Umo0ZUlYbzF1OTUiLCJvIjpmYWxzZSwiZCI6ImE2MmJkMTUzLTI2ZjYtNDc4OC04NGRjLWMzZjdkZDcyZGIxMiIsImlhdCI6MTY5MTc0MTgwOH0.jDdnfL2h9_mDoME2_CESbzUXYFQEgQLizXr47vUD6_c", + "ownerToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiclN3djBtcmd3Umo0ZUlYbzF1OTUiLCJvIjp0cnVlLCJkIjoiYTYyYmQxNTMtMjZmNi00Nzg4LTg0ZGMtYzNmN2RkNzJkYjEyIiwiaWF0IjoxNjkfNzQxODA4fQ.6hS8LKZndPBNRXBwHtF7pdeTBt02PIzeRNYamBJPo9E", + "roomName": "rSq20mrgwsj4eIXo1u95", + "startAsBroadcast": false, + "extensions": [] + } + }, + "GetListBodyRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" + }, + "page": { + "type": "integer", + "description": "The page to be returned" + } + } + }, + "Attendee": { + "type": "object", + "required": [ + "appointmentId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointment": { + "$ref": "#/components/schemas/Appointment" + }, + "type": { + "type": "string", + "enum": [ + "CLIENT", + "GUIDE" + ] + }, + "attendeeName": { + "type": "string" + }, + "attendeeEmail": { + "type": "string" + }, + "videoUserId": { + "type": "string" + }, + "guideCartPermissionsGranted": { + "type": "boolean" + }, + "attendeeSubmittedAt": { + "type": "string", + "format": "date-timme" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "invitationStatus": { + "type": "string" + }, + "joinedAt": { + "type": "string", + "format": "date-timme" }, - "allowUserActionsForGuide": { - "type": "boolean", - "default": false + "lastActive": { + "type": "string", + "format": "date-timme" }, - "broadcastMode": { - "type": "boolean", - "default": false + "interaction": { + "$ref": "#/components/schemas/Interaction" }, - "extensions": { + "productCollections": { "type": "array", - "default": [] + "items": { + "$ref": "#/components/schemas/AttendeeProductCollection" + } } } }, @@ -96957,67 +43433,37 @@ } } }, - "AttendeeInsights": { + "GetAttendeeInsightsResponse": { "type": "object", - "description": "Attendee Insights", + "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" - }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" + "attendees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendeeInsights" + } }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" - } - }, - "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - } - }, - "Interaction": { - "type": "object", - "required": [ - "name", - "triggeredAt", - "attendeeId" - ], - "properties": { - "id": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "triggeredAt": { - "type": "string", - "format": "date-time" - }, - "payload": { + "currencySymbol": { "type": "string" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendee": { - "$ref": "#/components/schemas/Attendee" } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + }, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" } }, "DynamicPageOpenedPayload": { @@ -97027,213 +43473,135 @@ } ] }, - "AttendeeProductCollection": { - "type": "object", - "required": [ - "attendeeId", - "productId", - "productVersionId", - "alias" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendee": { - "$ref": "#/components/schemas/Attendee" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "alias": { - "type": "string", - "enum": [ - "liked", - "disliked" - ] - } - } - }, - "Presentation": { + "PresentationCmsPage": { "type": "object", - "required": [ - "name" - ], "properties": { "id": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "The presentation cms page id" }, - "active": { - "type": "boolean" + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The title of presentation cms page" }, - "parentId": { + "presentationId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "The presentation using this presentation cms page" }, - "parentVersionId": { + "guidedShoppingPresentationVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "createdById": { + "cmsPageId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "pattern": "^[0-9a-f]{32}$", + "description": "The CMS page id the presentation using" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "updatedById": { + "cmsPageVersionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" - }, - "translations": { - "type": "array", - "items": { - "type": "object" - } - }, - "appointment": { - "$ref": "#/components/schemas/Appointment" - }, - "cmsPages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PresentationCmsPage" - } - }, - "translated": { - "type": "object" - } - } - }, - "JoinAppointmentResponse": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "mercureSubscriberTopics": { - "type": "array", - "items": { - "type": "string", - "description": "mercure topic" - }, - "description": "The topics to which the attendee/guide can subscribe for" + "pattern": "^[0-9a-f]{32}$", + "description": "The CMS page version id the presentation using" }, - "mercurePublisherTopic": { - "oneOf": [ + "productId": { + "anyOf": [ { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ], - "description": "The topic to which the attendee/guide can send updates" + "description": "The product id is assigned to presentation if it's product detail" }, - "JWTMercureSubscriberToken": { - "oneOf": [ + "productStreamId": { + "anyOf": [ { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, { "type": "null" } ], - "description": "The JWT mercure token to publish updates" + "description": "The product stream id is assigned to presentation if it's product listing" }, - "mercureHubPublicUrl": { - "oneOf": [ + "pickedProductIds": { + "anyOf": [ { - "type": "string" + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } }, { "type": "null" } ], - "description": "The mercure hub url to connect for subscribing and updating" + "description": "The product id is assigned to presentation if it's product listing or instant listing" }, - "JWTMercurePublisherToken": { - "oneOf": [ + "position": { + "type": "integer", + "description": "The position of slide" + }, + "isInstantListing": { + "type": "boolean", + "description": "True if this slide is an instant listing" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "anyOf": [ { - "type": "string" + "type": "string", + "format": "date-time" }, { "type": "null" } - ], - "description": "The JWT mercure token to subscribe for updates" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" - }, - "newContextToken": { - "type": "string", - "description": "The new context token" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" + ] }, - "presentationGuideMode": { - "type": "string", - "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" + "customFields": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" + "translated": { + "type": "object", + "properties": { + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } } - }, - "example": { - "mercureSubscriberTopics": [ - "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" - ], - "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", - "JWTMercureSubscriberToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6WyJncy1ndWlkZS1hY3Rpb25zLTJkMmMzNThmMWNhMDQwOThhYWNmMTI4NzNjMmVlZDgyIiwiZ3MtcHJlc2VudGF0aW9uLXN0YXRlLWZvci1jbGllbnQtMmQyYzM1OGYxY2EwNDA5OGFhY2YxMjg3M2MyZWVkODIiLCJncy1wcmVzZW50YXRpb24tc3RhdGUtZm9yLWFsbC0yZDJjMzU4ZjFjYTA0MDk4YWFjZjEyODczYzJlZWQ4MiJdLCJwdWJsaXNoIjpbXX19.UUkrRCu9PT2FOhkxhWKLo8nUGzwI7l3zqVo74laI-D8", - "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", - "JWTMercurePublisherToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6W10sInB1Ymxpc2giOlsiZ3MtY2xpZW50LWFjdGlvbnMtMmQyYzM1OGYxY2EwNDA5OGFhY2YxMjg3M2MyZWVkODIiXX19.g5-_JrB2xdeByr40t7XnnK_qxqOclaY5MKBpTytdFmY", - "id": "2d2c358f1ca04098aacf12873c2eed82", - "newContextToken": "VR9yWqI2ovhNpdRFWbbn6Z5Fy4wUmDsm", - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", - "presentationGuideMode": "guided", - "isPreview": false, - "apiAlias": "swag_guided_shopping_content_appointment_struct_appointment_join_struct" } }, "Appointment": { @@ -97355,162 +43723,6 @@ "$ref": "#/components/schemas/User" } } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" - } - } - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" - }, - "opened": { - "type": "boolean", - "default": true - } - } - }, - "VideoChatCreateStruct": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { - "type": "string", - "description": "Name of the video room in daily" - }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" - }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" - }, - "startAsBroadcast": { - "type": "boolean", - "default": false - } - }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "eyJhbGciOiJIUzI1NbIsInR5cCI6IkpXVCJ9.eyJyIjoiclNx4jBtcmd3Umo0ZUlYbzF1OTUiLCJvIjpmYWxzZSwiZCI6ImE2MmJkMTUzLTI2ZjYtNDc4OC04NGRjLWMzZjdkZDcyZGIxMiIsImlhdCI6MTY5MTc0MTgwOH0.jDdnfL2h9_mDoME2_CESbzUXYFQEgQLizXr47vUD6_c", - "ownerToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiclN3djBtcmd3Umo0ZUlYbzF1OTUiLCJvIjp0cnVlLCJkIjoiYTYyYmQxNTMtMjZmNi00Nzg4LTg0ZGMtYzNmN2RkNzJkYjEyIiwiaWF0IjoxNjkfNzQxODA4fQ.6hS8LKZndPBNRXBwHtF7pdeTBt02PIzeRNYamBJPo9E", - "roomName": "rSq20mrgwsj4eIXo1u95", - "startAsBroadcast": false, - "extensions": [] - } - }, - "GuidePresentationStateResponse": { - "type": "object", - "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" - }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" - } - }, - "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "allowUserActionsForGuide": true, - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "guideCartPermissionsGranted": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "guideCartPermissionsGranted": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "guideCartPermissionsGranted": false - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } - } } }, "responses": { @@ -97680,8 +43892,12 @@ ], "tags": [ { - "name": "Acl Role", - "description": "The endpoint for operations on Acl Role" + "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", @@ -97715,6 +43931,10 @@ "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" From ac4c0536f9efcfa4aafb6e7a77be4cd3a4dce3c1 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Mon, 4 Dec 2023 14:46:45 +0100 Subject: [PATCH 13/63] Add working branch --- .github/workflows/plugin_commercial_schema.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index effa40c..8aa76dd 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -30,6 +30,7 @@ jobs: schema_file: ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json plugin_name: ${{ needs.vars.outputs.PLUGIN_NAME }} plugin_url: ${{ needs.vars.outputs.PLUGIN_URL }} + git_options: '-b 6.5.x' shopware_version: ${{ inputs.shopware_version }} secrets: inherit open-pr: From b1934824cd5710cac5e3fc513d5337865e6a1e23 Mon Sep 17 00:00:00 2001 From: Micha Hobert Date: Mon, 4 Dec 2023 14:55:32 +0100 Subject: [PATCH 14/63] Change name --- .github/workflows/manual_versioning.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/manual_versioning.yml b/.github/workflows/manual_versioning.yml index 7c4e1cd..7184b30 100644 --- a/.github/workflows/manual_versioning.yml +++ b/.github/workflows/manual_versioning.yml @@ -1,4 +1,4 @@ -name: Schedule version PRs +name: Manual versioning on: workflow_dispatch: From 76ae5c7c8eefd64424cea4c3ebef903338998196 Mon Sep 17 00:00:00 2001 From: Bojan Rajh Date: Thu, 26 Sep 2024 13:49:12 +0200 Subject: [PATCH 15/63] feat: upgrade to v4 --- .github/workflows/add_descriptions.yml | 2 +- .github/workflows/base_schema.yml | 10 +++++----- .github/workflows/plugin_commercial_schema.yml | 4 ++-- .github/workflows/plugin_digitalsalesroom_schema.yml | 4 ++-- .github/workflows/validate_descriptions.yml | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/add_descriptions.yml b/.github/workflows/add_descriptions.yml index ff17a34..6ca0e38 100644 --- a/.github/workflows/add_descriptions.yml +++ b/.github/workflows/add_descriptions.yml @@ -14,7 +14,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: install yq uses: cachix/install-nix-action@v18 diff --git a/.github/workflows/base_schema.yml b/.github/workflows/base_schema.yml index b27f7e1..cef0ead 100644 --- a/.github/workflows/base_schema.yml +++ b/.github/workflows/base_schema.yml @@ -16,12 +16,12 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - shell: bash run: | cp adminapi.json adminapi-original.json - name: Upload original file - uses: actions/upload-artifact@v3 + uses: actions/upload-artifact@v4 with: name: original-file path: adminapi-original.json @@ -43,10 +43,10 @@ jobs: BRANCH_NAME: ${{ github.head_ref || github.ref_name }} steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: download api schema - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: ${{needs.generate-schema.outputs.api_schema}} @@ -62,7 +62,7 @@ jobs: done - name: Download original file - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: original-file diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index 8aa76dd..5ddcacb 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -39,10 +39,10 @@ jobs: needs: [generate-schema,vars] steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: download api schema - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: ${{needs.generate-schema.outputs.api_schema}} diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 649736c..7bfffc7 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -44,10 +44,10 @@ jobs: needs: [generate-schema,vars] steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: download api schema - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: ${{needs.generate-schema.outputs.api_schema}} diff --git a/.github/workflows/validate_descriptions.yml b/.github/workflows/validate_descriptions.yml index d9015c5..15e86d0 100644 --- a/.github/workflows/validate_descriptions.yml +++ b/.github/workflows/validate_descriptions.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Validate with yq uses: mikefarah/yq@master From 271381242f0f30b19f526d5d9f2f1d18f4b58766 Mon Sep 17 00:00:00 2001 From: Bojan Rajh Date: Thu, 26 Sep 2024 13:58:19 +0200 Subject: [PATCH 16/63] fix: commercial to 6.6 --- .github/workflows/plugin_commercial_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index 5ddcacb..87488b4 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -30,7 +30,7 @@ jobs: schema_file: ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json plugin_name: ${{ needs.vars.outputs.PLUGIN_NAME }} plugin_url: ${{ needs.vars.outputs.PLUGIN_URL }} - git_options: '-b 6.5.x' + git_options: '-b 6.6.x' shopware_version: ${{ inputs.shopware_version }} secrets: inherit open-pr: From d5f9e6fb151fbb67fe10bd8784581bae27c45498 Mon Sep 17 00:00:00 2001 From: Bojan Rajh Date: Thu, 26 Sep 2024 14:09:47 +0200 Subject: [PATCH 17/63] fix: remove hardcoded version --- .github/workflows/plugin_commercial_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index 87488b4..e89d8d8 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -30,7 +30,7 @@ jobs: schema_file: ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json plugin_name: ${{ needs.vars.outputs.PLUGIN_NAME }} plugin_url: ${{ needs.vars.outputs.PLUGIN_URL }} - git_options: '-b 6.6.x' + #git_options: '-b 6.6.x' shopware_version: ${{ inputs.shopware_version }} secrets: inherit open-pr: From 23e668cc25e2d2dfee4c9809657f5fc410e2a2b8 Mon Sep 17 00:00:00 2001 From: Bojan Rajh Date: Thu, 26 Sep 2024 14:16:31 +0200 Subject: [PATCH 18/63] fix: upgrade pwa to 0.5 --- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 7bfffc7..4f3d746 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -11,7 +11,7 @@ on: env: PLUGIN_NAME: SwagGuidedShopping PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagguidedshopping.git - COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.4 symfony/mercure ^0.6.2 spatie/icalendar-generator ^2.5 + COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.2 spatie/icalendar-generator ^2.5 # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: From 6b1513ecf00d2369b5b22c648c7ff21f1a872a91 Mon Sep 17 00:00:00 2001 From: Bojan Rajh Date: Thu, 26 Sep 2024 14:20:22 +0200 Subject: [PATCH 19/63] fix: upgrade deps --- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 4f3d746..ecd78b2 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -11,7 +11,7 @@ on: env: PLUGIN_NAME: SwagGuidedShopping PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagguidedshopping.git - COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.2 spatie/icalendar-generator ^2.5 + COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.4 spatie/icalendar-generator ^2.6 # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: From e6bdb99a1e419af43e5f980bdb809deadc366090 Mon Sep 17 00:00:00 2001 From: Bojan Rajh Date: Thu, 26 Sep 2024 14:30:50 +0200 Subject: [PATCH 20/63] fix: upgrade peter-evans/create-pull-request to v7 --- .github/workflows/add_descriptions.yml | 2 +- .github/workflows/base_schema.yml | 2 +- .github/workflows/plugin_commercial_schema.yml | 2 +- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/add_descriptions.yml b/.github/workflows/add_descriptions.yml index 6ca0e38..896522e 100644 --- a/.github/workflows/add_descriptions.yml +++ b/.github/workflows/add_descriptions.yml @@ -28,7 +28,7 @@ jobs: done - name: Create PR - uses: peter-evans/create-pull-request@v4 + uses: peter-evans/create-pull-request@v7 with: add-paths: adminapi.json author: shopwareBot diff --git a/.github/workflows/base_schema.yml b/.github/workflows/base_schema.yml index cef0ead..c968bae 100644 --- a/.github/workflows/base_schema.yml +++ b/.github/workflows/base_schema.yml @@ -76,7 +76,7 @@ jobs: - name: Create PR if: ${{ env.FILE_DIFFERENCE == 1 }} - uses: peter-evans/create-pull-request@v4 + uses: peter-evans/create-pull-request@v7 with: add-paths: adminapi.json author: shopwareBot diff --git a/.github/workflows/plugin_commercial_schema.yml b/.github/workflows/plugin_commercial_schema.yml index e89d8d8..5250a10 100644 --- a/.github/workflows/plugin_commercial_schema.yml +++ b/.github/workflows/plugin_commercial_schema.yml @@ -57,7 +57,7 @@ jobs: ./.github/scripts/find_delta_paths.sh ${{ needs.vars.outputs.PLUGIN_NAME }} - name: Create DSR PR - uses: peter-evans/create-pull-request@v4 + uses: peter-evans/create-pull-request@v7 with: add-paths: ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json author: shopwareBot diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index ecd78b2..e5e984b 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -62,7 +62,7 @@ jobs: ./.github/scripts/find_delta_paths.sh ${{ needs.vars.outputs.PLUGIN_NAME }} - name: Create DSR PR - uses: peter-evans/create-pull-request@v4 + uses: peter-evans/create-pull-request@v7 with: add-paths: ${{ needs.vars.outputs.PLUGIN_NAME }}-adminapi.json author: shopwareBot From 706f9775dcdd7b358c60aea26e59ad71b53be6a8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 27 Sep 2024 08:04:09 +0200 Subject: [PATCH 21/63] [create-pull-request] automated change (#309) Co-authored-by: shopwareBot --- adminapi.json | 27669 ++++++++++++++++++++++++++++++++++++------------ 1 file changed, 21188 insertions(+), 6481 deletions(-) diff --git a/adminapi.json b/adminapi.json index 7b158b0..1857bc9 100644 --- a/adminapi.json +++ b/adminapi.json @@ -3,7 +3,11 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.6.1" + "license": { + "name": "MIT", + "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" + }, + "version": "6.6.6.1" }, "servers": [ { @@ -193,7 +197,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AclRole" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/acl-role": { + "post": { + "tags": [ + "Acl Role" + ], + "summary": "Search for the Acl Role resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchAclRole", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } } } } @@ -250,7 +336,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AclRole" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + } + } } } } @@ -381,7 +475,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AclRole" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AclRole" + } + } } } } @@ -580,7 +682,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/App" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/App" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app": { + "post": { + "tags": [ + "App" + ], + "summary": "Search for the App resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchApp", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of App", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } } } } @@ -637,7 +821,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/App" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/App" + } + } } } } @@ -768,7 +960,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/App" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/App" + } + } } } } @@ -967,7 +1167,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppActionButton" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-action-button": { + "post": { + "tags": [ + "App Action Button" + ], + "summary": "Search for the App Action Button resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchAppActionButton", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppActionButton", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } } } } @@ -1024,7 +1306,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppActionButton" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + } + } } } } @@ -1155,7 +1445,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppActionButton" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppActionButton" + } + } } } } @@ -1354,7 +1652,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-administration-snippet": { + "post": { + "tags": [ + "App Administration Snippet" + ], + "summary": "Search for the App Administration Snippet resources.", + "description": "Available since: 6.4.15.0", + "operationId": "searchAppAdministrationSnippet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppAdministrationSnippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } } } } @@ -1411,7 +1791,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } } } } @@ -1542,7 +1930,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppAdministrationSnippet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } } } } @@ -1741,7 +2137,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppCmsBlock" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-cms-block": { + "post": { + "tags": [ + "App Cms Block" + ], + "summary": "Search for the App Cms Block resources.", + "description": "Available since: 6.4.2.0", + "operationId": "searchAppCmsBlock", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppCmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } } } } @@ -1798,7 +2276,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppCmsBlock" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } } } } @@ -1929,7 +2415,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppCmsBlock" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } } } } @@ -2128,7 +2622,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppFlowAction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-flow-action": { + "post": { + "tags": [ + "App Flow Action" + ], + "summary": "Search for the App Flow Action resources.", + "description": "Available since: 6.4.10.0", + "operationId": "searchAppFlowAction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppFlowAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } } } } @@ -2185,7 +2761,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppFlowAction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + } + } } } } @@ -2316,7 +2900,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppFlowAction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowAction" + } + } } } } @@ -2515,7 +3107,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppFlowEvent" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-flow-event": { + "post": { + "tags": [ + "App Flow Event" + ], + "summary": "Search for the App Flow Event resources.", + "description": "Available since: 6.5.2.0", + "operationId": "searchAppFlowEvent", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppFlowEvent", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } } } } @@ -2572,7 +3246,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppFlowEvent" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } } } } @@ -2703,7 +3385,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppFlowEvent" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } } } } @@ -2902,7 +3592,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-payment-method": { + "post": { + "tags": [ + "App Payment Method" + ], + "summary": "Search for the App Payment Method resources.", + "description": "Available since: 6.4.1.0", + "operationId": "searchAppPaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppPaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } } } } @@ -2959,7 +3731,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } } } } @@ -3090,7 +3870,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppPaymentMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } } } } @@ -3289,7 +4077,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppScriptCondition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/app-script-condition": { + "post": { + "tags": [ + "App Script Condition" + ], + "summary": "Search for the App Script Condition resources.", + "description": "Available since: 6.4.10.3", + "operationId": "searchAppScriptCondition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } } } } @@ -3346,7 +4216,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppScriptCondition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } } } } @@ -3477,7 +4355,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppScriptCondition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } } } } @@ -3494,14 +4380,14 @@ } } }, - "/app-template": { + "/app-shipping-method": { "get": { "tags": [ - "App Template" + "App Shipping Method" ], - "summary": "List with basic information of App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppTemplateList", + "summary": "List with basic information of App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "getAppShippingMethodList", "parameters": [ { "name": "limit", @@ -3530,7 +4416,7 @@ ], "responses": { "200": { - "description": "List of App Template resources.", + "description": "List of App Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3549,7 +4435,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } ] @@ -3563,16 +4449,16 @@ "type": "object", "properties": { "first": { - "example": "/app-template?limit=25" + "example": "/app-shipping-method?limit=25" }, "last": { - "example": "/app-template?limit=25&page=11" + "example": "/app-shipping-method?limit=25&page=11" }, "next": { - "example": "/app-template?limit=25&page=4" + "example": "/app-shipping-method?limit=25&page=4" }, "prev": { - "example": "/app-template?limit=25&page=2" + "example": "/app-shipping-method?limit=25&page=2" } } } @@ -3593,7 +4479,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -3608,11 +4494,11 @@ }, "post": { "tags": [ - "App Template" + "App Shipping Method" ], - "summary": "Create a new App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createAppTemplate", + "summary": "Create a new App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "createAppShippingMethod", "parameters": [ { "name": "_response", @@ -3634,7 +4520,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" }, "included": { "type": "array", @@ -3648,14 +4534,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of AppTemplate", + "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -3667,7 +4553,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -3676,7 +4562,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } } } } @@ -3690,19 +4584,93 @@ } } }, - "/app-template/{id}": { + "/search/app-shipping-method": { + "post": { + "tags": [ + "App Shipping Method" + ], + "summary": "Search for the App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "searchAppShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-shipping-method/{id}": { "get": { "tags": [ - "App Template" + "App Shipping Method" ], - "summary": "Detailed information about a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getAppTemplate", + "summary": "Detailed information about a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "getAppShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_template", + "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", @@ -3712,7 +4680,7 @@ ], "responses": { "200": { - "description": "Detail of AppTemplate", + "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -3724,7 +4692,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -3733,7 +4701,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } } } } @@ -3748,16 +4724,16 @@ }, "delete": { "tags": [ - "App Template" + "App Shipping Method" ], - "summary": "Delete a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteAppTemplate", + "summary": "Delete a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "deleteAppShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_template", + "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", @@ -3788,16 +4764,16 @@ }, "patch": { "tags": [ - "App Template" + "App Shipping Method" ], - "summary": "Partially update information about a App Template resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateAppTemplate", + "summary": "Partially update information about a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "updateAppShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_template", + "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", @@ -3815,14 +4791,14 @@ } ], "requestBody": { - "description": "Partially update information about a App Template resource.", + "description": "Partially update information about a App Shipping Method resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" }, "included": { "type": "array", @@ -3836,14 +4812,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of AppTemplate", + "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -3855,7 +4831,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppTemplate" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -3864,7 +4840,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } } } } @@ -3881,14 +4865,14 @@ } } }, - "/category": { + "/app-template": { "get": { "tags": [ - "Category" + "App Template" ], - "summary": "List with basic information of Category resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCategoryList", + "summary": "List with basic information of App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppTemplateList", "parameters": [ { "name": "limit", @@ -3917,7 +4901,7 @@ ], "responses": { "200": { - "description": "List of Category resources.", + "description": "List of App Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3936,7 +4920,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } ] @@ -3950,16 +4934,16 @@ "type": "object", "properties": { "first": { - "example": "/category?limit=25" + "example": "/app-template?limit=25" }, "last": { - "example": "/category?limit=25&page=11" + "example": "/app-template?limit=25&page=11" }, "next": { - "example": "/category?limit=25&page=4" + "example": "/app-template?limit=25&page=4" }, "prev": { - "example": "/category?limit=25&page=2" + "example": "/app-template?limit=25&page=2" } } } @@ -3980,7 +4964,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -3995,11 +4979,11 @@ }, "post": { "tags": [ - "Category" + "App Template" ], - "summary": "Create a new Category resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCategory", + "summary": "Create a new App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createAppTemplate", "parameters": [ { "name": "_response", @@ -4021,7 +5005,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" }, "included": { "type": "array", @@ -4035,14 +5019,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } } }, "responses": { "200": { - "description": "Detail of Category", + "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -4054,7 +5038,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -4063,7 +5047,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + } + } } } } @@ -4077,19 +5069,93 @@ } } }, - "/category/{id}": { + "/search/app-template": { + "post": { + "tags": [ + "App Template" + ], + "summary": "Search for the App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchAppTemplate", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-template/{id}": { "get": { "tags": [ - "Category" + "App Template" ], - "summary": "Detailed information about a Category resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCategory", + "summary": "Detailed information about a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getAppTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the category", + "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", @@ -4099,7 +5165,7 @@ ], "responses": { "200": { - "description": "Detail of Category", + "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -4111,7 +5177,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -4120,7 +5186,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + } + } } } } @@ -4135,16 +5209,16 @@ }, "delete": { "tags": [ - "Category" + "App Template" ], - "summary": "Delete a Category resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCategory", + "summary": "Delete a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteAppTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the category", + "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", @@ -4175,16 +5249,16 @@ }, "patch": { "tags": [ - "Category" + "App Template" ], - "summary": "Partially update information about a Category resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCategory", + "summary": "Partially update information about a App Template resource.", + "description": "Available since: 6.3.1.0", + "operationId": "updateAppTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the category", + "description": "Identifier for the app_template", "required": true, "schema": { "type": "string", @@ -4202,14 +5276,14 @@ } ], "requestBody": { - "description": "Partially update information about a Category resource.", + "description": "Partially update information about a App Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" }, "included": { "type": "array", @@ -4223,14 +5297,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } } }, "responses": { "200": { - "description": "Detail of Category", + "description": "Detail of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -4242,7 +5316,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -4251,7 +5325,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Category" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppTemplate" + } + } } } } @@ -4268,14 +5350,14 @@ } } }, - "/cms-block": { + "/category": { "get": { "tags": [ - "Cms Block" + "Category" ], - "summary": "List with basic information of Cms Block resources.", + "summary": "List with basic information of Category resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsBlockList", + "operationId": "getCategoryList", "parameters": [ { "name": "limit", @@ -4304,7 +5386,7 @@ ], "responses": { "200": { - "description": "List of Cms Block resources.", + "description": "List of Category resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4323,7 +5405,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } ] @@ -4337,16 +5419,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-block?limit=25" + "example": "/category?limit=25" }, "last": { - "example": "/cms-block?limit=25&page=11" + "example": "/category?limit=25&page=11" }, "next": { - "example": "/cms-block?limit=25&page=4" + "example": "/category?limit=25&page=4" }, "prev": { - "example": "/cms-block?limit=25&page=2" + "example": "/category?limit=25&page=2" } } } @@ -4367,7 +5449,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } } @@ -4382,11 +5464,11 @@ }, "post": { "tags": [ - "Cms Block" + "Category" ], - "summary": "Create a new Cms Block resources.", + "summary": "Create a new Category resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsBlock", + "operationId": "createCategory", "parameters": [ { "name": "_response", @@ -4408,7 +5490,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" }, "included": { "type": "array", @@ -4422,14 +5504,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } } }, "responses": { "200": { - "description": "Detail of CmsBlock", + "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { @@ -4441,7 +5523,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } } @@ -4450,7 +5532,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + } + } } } } @@ -4464,19 +5554,93 @@ } } }, - "/cms-block/{id}": { + "/search/category": { + "post": { + "tags": [ + "Category" + ], + "summary": "Search for the Category resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCategory", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/category/{id}": { "get": { "tags": [ - "Cms Block" + "Category" ], - "summary": "Detailed information about a Cms Block resource.", + "summary": "Detailed information about a Category resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsBlock", + "operationId": "getCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_block", + "description": "Identifier for the category", "required": true, "schema": { "type": "string", @@ -4486,7 +5650,7 @@ ], "responses": { "200": { - "description": "Detail of CmsBlock", + "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { @@ -4498,7 +5662,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } } @@ -4507,7 +5671,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + } + } } } } @@ -4522,16 +5694,16 @@ }, "delete": { "tags": [ - "Cms Block" + "Category" ], - "summary": "Delete a Cms Block resource.", + "summary": "Delete a Category resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsBlock", + "operationId": "deleteCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_block", + "description": "Identifier for the category", "required": true, "schema": { "type": "string", @@ -4562,16 +5734,16 @@ }, "patch": { "tags": [ - "Cms Block" + "Category" ], - "summary": "Partially update information about a Cms Block resource.", + "summary": "Partially update information about a Category resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsBlock", + "operationId": "updateCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_block", + "description": "Identifier for the category", "required": true, "schema": { "type": "string", @@ -4589,14 +5761,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Block resource.", + "description": "Partially update information about a Category resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" }, "included": { "type": "array", @@ -4610,14 +5782,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } } }, "responses": { "200": { - "description": "Detail of CmsBlock", + "description": "Detail of Category", "content": { "application/vnd.api+json": { "schema": { @@ -4629,7 +5801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/Category" } } } @@ -4638,7 +5810,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsBlock" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Category" + } + } } } } @@ -4655,14 +5835,14 @@ } } }, - "/cms-page": { + "/cms-block": { "get": { "tags": [ - "Cms Page" + "Cms Block" ], - "summary": "List with basic information of Cms Page resources.", + "summary": "List with basic information of Cms Block resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsPageList", + "operationId": "getCmsBlockList", "parameters": [ { "name": "limit", @@ -4691,7 +5871,7 @@ ], "responses": { "200": { - "description": "List of Cms Page resources.", + "description": "List of Cms Block resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4710,7 +5890,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } ] @@ -4724,16 +5904,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-page?limit=25" + "example": "/cms-block?limit=25" }, "last": { - "example": "/cms-page?limit=25&page=11" + "example": "/cms-block?limit=25&page=11" }, "next": { - "example": "/cms-page?limit=25&page=4" + "example": "/cms-block?limit=25&page=4" }, "prev": { - "example": "/cms-page?limit=25&page=2" + "example": "/cms-block?limit=25&page=2" } } } @@ -4754,7 +5934,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4769,11 +5949,11 @@ }, "post": { "tags": [ - "Cms Page" + "Cms Block" ], - "summary": "Create a new Cms Page resources.", + "summary": "Create a new Cms Block resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsPage", + "operationId": "createCmsBlock", "parameters": [ { "name": "_response", @@ -4795,7 +5975,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" }, "included": { "type": "array", @@ -4809,14 +5989,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } } }, "responses": { "200": { - "description": "Detail of CmsPage", + "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -4828,7 +6008,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4837,7 +6017,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + } + } } } } @@ -4851,19 +6039,93 @@ } } }, - "/cms-page/{id}": { + "/search/cms-block": { + "post": { + "tags": [ + "Cms Block" + ], + "summary": "Search for the Cms Block resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsBlock", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-block/{id}": { "get": { "tags": [ - "Cms Page" + "Cms Block" ], - "summary": "Detailed information about a Cms Page resource.", + "summary": "Detailed information about a Cms Block resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsPage", + "operationId": "getCmsBlock", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_page", + "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", @@ -4873,7 +6135,7 @@ ], "responses": { "200": { - "description": "Detail of CmsPage", + "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -4885,7 +6147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -4894,7 +6156,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + } + } } } } @@ -4909,16 +6179,16 @@ }, "delete": { "tags": [ - "Cms Page" + "Cms Block" ], - "summary": "Delete a Cms Page resource.", + "summary": "Delete a Cms Block resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsPage", + "operationId": "deleteCmsBlock", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_page", + "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", @@ -4949,16 +6219,16 @@ }, "patch": { "tags": [ - "Cms Page" + "Cms Block" ], - "summary": "Partially update information about a Cms Page resource.", + "summary": "Partially update information about a Cms Block resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsPage", + "operationId": "updateCmsBlock", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_page", + "description": "Identifier for the cms_block", "required": true, "schema": { "type": "string", @@ -4976,14 +6246,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Page resource.", + "description": "Partially update information about a Cms Block resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" }, "included": { "type": "array", @@ -4997,14 +6267,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } } }, "responses": { "200": { - "description": "Detail of CmsPage", + "description": "Detail of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -5016,7 +6286,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -5025,7 +6295,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsPage" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsBlock" + } + } } } } @@ -5042,14 +6320,14 @@ } } }, - "/cms-section": { + "/cms-page": { "get": { "tags": [ - "Cms Section" + "Cms Page" ], - "summary": "List with basic information of Cms Section resources.", + "summary": "List with basic information of Cms Page resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSectionList", + "operationId": "getCmsPageList", "parameters": [ { "name": "limit", @@ -5078,7 +6356,7 @@ ], "responses": { "200": { - "description": "List of Cms Section resources.", + "description": "List of Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5097,7 +6375,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } ] @@ -5111,16 +6389,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-section?limit=25" + "example": "/cms-page?limit=25" }, "last": { - "example": "/cms-section?limit=25&page=11" + "example": "/cms-page?limit=25&page=11" }, "next": { - "example": "/cms-section?limit=25&page=4" + "example": "/cms-page?limit=25&page=4" }, "prev": { - "example": "/cms-section?limit=25&page=2" + "example": "/cms-page?limit=25&page=2" } } } @@ -5141,7 +6419,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } } @@ -5156,11 +6434,11 @@ }, "post": { "tags": [ - "Cms Section" + "Cms Page" ], - "summary": "Create a new Cms Section resources.", + "summary": "Create a new Cms Page resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsSection", + "operationId": "createCmsPage", "parameters": [ { "name": "_response", @@ -5182,7 +6460,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" }, "included": { "type": "array", @@ -5196,14 +6474,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } } }, "responses": { "200": { - "description": "Detail of CmsSection", + "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -5215,7 +6493,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } } @@ -5224,7 +6502,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + } + } } } } @@ -5238,19 +6524,93 @@ } } }, - "/cms-section/{id}": { + "/search/cms-page": { + "post": { + "tags": [ + "Cms Page" + ], + "summary": "Search for the Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsPage", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-page/{id}": { "get": { "tags": [ - "Cms Section" + "Cms Page" ], - "summary": "Detailed information about a Cms Section resource.", + "summary": "Detailed information about a Cms Page resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSection", + "operationId": "getCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_section", + "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", @@ -5260,7 +6620,7 @@ ], "responses": { "200": { - "description": "Detail of CmsSection", + "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -5272,7 +6632,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } } @@ -5281,7 +6641,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + } + } } } } @@ -5296,16 +6664,16 @@ }, "delete": { "tags": [ - "Cms Section" + "Cms Page" ], - "summary": "Delete a Cms Section resource.", + "summary": "Delete a Cms Page resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsSection", + "operationId": "deleteCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_section", + "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", @@ -5336,16 +6704,16 @@ }, "patch": { "tags": [ - "Cms Section" + "Cms Page" ], - "summary": "Partially update information about a Cms Section resource.", + "summary": "Partially update information about a Cms Page resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsSection", + "operationId": "updateCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_section", + "description": "Identifier for the cms_page", "required": true, "schema": { "type": "string", @@ -5363,14 +6731,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Section resource.", + "description": "Partially update information about a Cms Page resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" }, "included": { "type": "array", @@ -5384,14 +6752,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } } }, "responses": { "200": { - "description": "Detail of CmsSection", + "description": "Detail of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -5403,7 +6771,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/CmsPage" } } } @@ -5412,7 +6780,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsPage" + } + } } } } @@ -5429,14 +6805,14 @@ } } }, - "/cms-slot": { + "/cms-section": { "get": { "tags": [ - "Cms Slot" + "Cms Section" ], - "summary": "List with basic information of Cms Slot resources.", + "summary": "List with basic information of Cms Section resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSlotList", + "operationId": "getCmsSectionList", "parameters": [ { "name": "limit", @@ -5465,7 +6841,7 @@ ], "responses": { "200": { - "description": "List of Cms Slot resources.", + "description": "List of Cms Section resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5484,7 +6860,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } ] @@ -5498,16 +6874,16 @@ "type": "object", "properties": { "first": { - "example": "/cms-slot?limit=25" + "example": "/cms-section?limit=25" }, "last": { - "example": "/cms-slot?limit=25&page=11" + "example": "/cms-section?limit=25&page=11" }, "next": { - "example": "/cms-slot?limit=25&page=4" + "example": "/cms-section?limit=25&page=4" }, "prev": { - "example": "/cms-slot?limit=25&page=2" + "example": "/cms-section?limit=25&page=2" } } } @@ -5528,7 +6904,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5543,11 +6919,11 @@ }, "post": { "tags": [ - "Cms Slot" + "Cms Section" ], - "summary": "Create a new Cms Slot resources.", + "summary": "Create a new Cms Section resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCmsSlot", + "operationId": "createCmsSection", "parameters": [ { "name": "_response", @@ -5569,7 +6945,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" }, "included": { "type": "array", @@ -5583,14 +6959,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } } }, "responses": { "200": { - "description": "Detail of CmsSlot", + "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -5602,7 +6978,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5611,7 +6987,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } } } } @@ -5625,19 +7009,93 @@ } } }, - "/cms-slot/{id}": { + "/search/cms-section": { + "post": { + "tags": [ + "Cms Section" + ], + "summary": "Search for the Cms Section resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsSection", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-section/{id}": { "get": { "tags": [ - "Cms Slot" + "Cms Section" ], - "summary": "Detailed information about a Cms Slot resource.", + "summary": "Detailed information about a Cms Section resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCmsSlot", + "operationId": "getCmsSection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_slot", + "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", @@ -5647,7 +7105,7 @@ ], "responses": { "200": { - "description": "Detail of CmsSlot", + "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -5659,7 +7117,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5668,7 +7126,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } } } } @@ -5683,16 +7149,16 @@ }, "delete": { "tags": [ - "Cms Slot" + "Cms Section" ], - "summary": "Delete a Cms Slot resource.", + "summary": "Delete a Cms Section resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCmsSlot", + "operationId": "deleteCmsSection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_slot", + "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", @@ -5723,16 +7189,16 @@ }, "patch": { "tags": [ - "Cms Slot" + "Cms Section" ], - "summary": "Partially update information about a Cms Slot resource.", + "summary": "Partially update information about a Cms Section resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCmsSlot", + "operationId": "updateCmsSection", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the cms_slot", + "description": "Identifier for the cms_section", "required": true, "schema": { "type": "string", @@ -5750,14 +7216,14 @@ } ], "requestBody": { - "description": "Partially update information about a Cms Slot resource.", + "description": "Partially update information about a Cms Section resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" }, "included": { "type": "array", @@ -5771,14 +7237,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } } }, "responses": { "200": { - "description": "Detail of CmsSlot", + "description": "Detail of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -5790,7 +7256,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CmsSlot" + "$ref": "#/components/schemas/CmsSection" } } } @@ -5799,7 +7265,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSlot" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } } } } @@ -5816,14 +7290,14 @@ } } }, - "/country": { + "/cms-slot": { "get": { "tags": [ - "Country" + "Cms Slot" ], - "summary": "List with basic information of Country resources.", + "summary": "List with basic information of Cms Slot resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCountryList", + "operationId": "getCmsSlotList", "parameters": [ { "name": "limit", @@ -5852,7 +7326,7 @@ ], "responses": { "200": { - "description": "List of Country resources.", + "description": "List of Cms Slot resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5871,7 +7345,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } ] @@ -5885,16 +7359,16 @@ "type": "object", "properties": { "first": { - "example": "/country?limit=25" + "example": "/cms-slot?limit=25" }, "last": { - "example": "/country?limit=25&page=11" + "example": "/cms-slot?limit=25&page=11" }, "next": { - "example": "/country?limit=25&page=4" + "example": "/cms-slot?limit=25&page=4" }, "prev": { - "example": "/country?limit=25&page=2" + "example": "/cms-slot?limit=25&page=2" } } } @@ -5915,7 +7389,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5930,11 +7404,11 @@ }, "post": { "tags": [ - "Country" + "Cms Slot" ], - "summary": "Create a new Country resources.", + "summary": "Create a new Cms Slot resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCountry", + "operationId": "createCmsSlot", "parameters": [ { "name": "_response", @@ -5956,7 +7430,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" }, "included": { "type": "array", @@ -5970,14 +7444,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } } }, "responses": { "200": { - "description": "Detail of Country", + "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -5989,7 +7463,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -5998,7 +7472,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + } + } } } } @@ -6012,19 +7494,93 @@ } } }, - "/country/{id}": { + "/search/cms-slot": { + "post": { + "tags": [ + "Cms Slot" + ], + "summary": "Search for the Cms Slot resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsSlot", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-slot/{id}": { "get": { "tags": [ - "Country" + "Cms Slot" ], - "summary": "Detailed information about a Country resource.", + "summary": "Detailed information about a Cms Slot resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCountry", + "operationId": "getCmsSlot", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country", + "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", @@ -6034,7 +7590,7 @@ ], "responses": { "200": { - "description": "Detail of Country", + "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -6046,7 +7602,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -6055,7 +7611,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + } + } } } } @@ -6070,16 +7634,16 @@ }, "delete": { "tags": [ - "Country" + "Cms Slot" ], - "summary": "Delete a Country resource.", + "summary": "Delete a Cms Slot resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCountry", + "operationId": "deleteCmsSlot", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country", + "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", @@ -6110,16 +7674,16 @@ }, "patch": { "tags": [ - "Country" + "Cms Slot" ], - "summary": "Partially update information about a Country resource.", + "summary": "Partially update information about a Cms Slot resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCountry", + "operationId": "updateCmsSlot", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country", + "description": "Identifier for the cms_slot", "required": true, "schema": { "type": "string", @@ -6137,14 +7701,14 @@ } ], "requestBody": { - "description": "Partially update information about a Country resource.", + "description": "Partially update information about a Cms Slot resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" }, "included": { "type": "array", @@ -6158,14 +7722,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } } }, "responses": { "200": { - "description": "Detail of Country", + "description": "Detail of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -6177,7 +7741,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -6186,7 +7750,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Country" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSlot" + } + } } } } @@ -6203,14 +7775,14 @@ } } }, - "/country-state": { + "/country": { "get": { "tags": [ - "Country State" + "Country" ], - "summary": "List with basic information of Country State resources.", + "summary": "List with basic information of Country resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCountryStateList", + "operationId": "getCountryList", "parameters": [ { "name": "limit", @@ -6239,7 +7811,7 @@ ], "responses": { "200": { - "description": "List of Country State resources.", + "description": "List of Country resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6258,7 +7830,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } ] @@ -6272,16 +7844,16 @@ "type": "object", "properties": { "first": { - "example": "/country-state?limit=25" + "example": "/country?limit=25" }, "last": { - "example": "/country-state?limit=25&page=11" + "example": "/country?limit=25&page=11" }, "next": { - "example": "/country-state?limit=25&page=4" + "example": "/country?limit=25&page=4" }, "prev": { - "example": "/country-state?limit=25&page=2" + "example": "/country?limit=25&page=2" } } } @@ -6302,7 +7874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } } @@ -6317,11 +7889,11 @@ }, "post": { "tags": [ - "Country State" + "Country" ], - "summary": "Create a new Country State resources.", + "summary": "Create a new Country resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCountryState", + "operationId": "createCountry", "parameters": [ { "name": "_response", @@ -6343,7 +7915,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" }, "included": { "type": "array", @@ -6357,14 +7929,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } } }, "responses": { "200": { - "description": "Detail of CountryState", + "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { @@ -6376,7 +7948,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } } @@ -6385,7 +7957,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + } + } } } } @@ -6399,19 +7979,93 @@ } } }, - "/country-state/{id}": { + "/search/country": { + "post": { + "tags": [ + "Country" + ], + "summary": "Search for the Country resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCountry", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/country/{id}": { "get": { "tags": [ - "Country State" + "Country" ], - "summary": "Detailed information about a Country State resource.", + "summary": "Detailed information about a Country resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCountryState", + "operationId": "getCountry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country_state", + "description": "Identifier for the country", "required": true, "schema": { "type": "string", @@ -6421,7 +8075,7 @@ ], "responses": { "200": { - "description": "Detail of CountryState", + "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { @@ -6433,7 +8087,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } } @@ -6442,7 +8096,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + } + } } } } @@ -6457,16 +8119,16 @@ }, "delete": { "tags": [ - "Country State" + "Country" ], - "summary": "Delete a Country State resource.", + "summary": "Delete a Country resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCountryState", + "operationId": "deleteCountry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country_state", + "description": "Identifier for the country", "required": true, "schema": { "type": "string", @@ -6497,16 +8159,16 @@ }, "patch": { "tags": [ - "Country State" + "Country" ], - "summary": "Partially update information about a Country State resource.", + "summary": "Partially update information about a Country resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCountryState", + "operationId": "updateCountry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the country_state", + "description": "Identifier for the country", "required": true, "schema": { "type": "string", @@ -6524,14 +8186,14 @@ } ], "requestBody": { - "description": "Partially update information about a Country State resource.", + "description": "Partially update information about a Country resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" }, "included": { "type": "array", @@ -6545,14 +8207,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } } }, "responses": { "200": { - "description": "Detail of CountryState", + "description": "Detail of Country", "content": { "application/vnd.api+json": { "schema": { @@ -6564,7 +8226,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/Country" } } } @@ -6573,7 +8235,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CountryState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Country" + } + } } } } @@ -6590,14 +8260,14 @@ } } }, - "/currency": { + "/country-state": { "get": { "tags": [ - "Currency" + "Country State" ], - "summary": "List with basic information of Currency resources.", + "summary": "List with basic information of Country State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCurrencyList", + "operationId": "getCountryStateList", "parameters": [ { "name": "limit", @@ -6626,7 +8296,7 @@ ], "responses": { "200": { - "description": "List of Currency resources.", + "description": "List of Country State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6645,7 +8315,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } ] @@ -6659,16 +8329,16 @@ "type": "object", "properties": { "first": { - "example": "/currency?limit=25" + "example": "/country-state?limit=25" }, "last": { - "example": "/currency?limit=25&page=11" + "example": "/country-state?limit=25&page=11" }, "next": { - "example": "/currency?limit=25&page=4" + "example": "/country-state?limit=25&page=4" }, "prev": { - "example": "/currency?limit=25&page=2" + "example": "/country-state?limit=25&page=2" } } } @@ -6689,7 +8359,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } } @@ -6704,11 +8374,11 @@ }, "post": { "tags": [ - "Currency" + "Country State" ], - "summary": "Create a new Currency resources.", + "summary": "Create a new Country State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCurrency", + "operationId": "createCountryState", "parameters": [ { "name": "_response", @@ -6730,7 +8400,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" }, "included": { "type": "array", @@ -6744,14 +8414,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } } }, "responses": { "200": { - "description": "Detail of Currency", + "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -6763,7 +8433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } } @@ -6772,7 +8442,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + } + } } } } @@ -6786,19 +8464,93 @@ } } }, - "/currency/{id}": { + "/search/country-state": { + "post": { + "tags": [ + "Country State" + ], + "summary": "Search for the Country State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCountryState", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/country-state/{id}": { "get": { "tags": [ - "Currency" + "Country State" ], - "summary": "Detailed information about a Currency resource.", + "summary": "Detailed information about a Country State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCurrency", + "operationId": "getCountryState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency", + "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", @@ -6808,7 +8560,7 @@ ], "responses": { "200": { - "description": "Detail of Currency", + "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -6820,7 +8572,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } } @@ -6829,7 +8581,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + } + } } } } @@ -6844,16 +8604,16 @@ }, "delete": { "tags": [ - "Currency" + "Country State" ], - "summary": "Delete a Currency resource.", + "summary": "Delete a Country State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCurrency", + "operationId": "deleteCountryState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency", + "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", @@ -6884,16 +8644,16 @@ }, "patch": { "tags": [ - "Currency" + "Country State" ], - "summary": "Partially update information about a Currency resource.", + "summary": "Partially update information about a Country State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCurrency", + "operationId": "updateCountryState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency", + "description": "Identifier for the country_state", "required": true, "schema": { "type": "string", @@ -6911,14 +8671,14 @@ } ], "requestBody": { - "description": "Partially update information about a Currency resource.", + "description": "Partially update information about a Country State resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" }, "included": { "type": "array", @@ -6932,14 +8692,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } } }, "responses": { "200": { - "description": "Detail of Currency", + "description": "Detail of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -6951,7 +8711,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/CountryState" } } } @@ -6960,7 +8720,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Currency" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CountryState" + } + } } } } @@ -6977,14 +8745,14 @@ } } }, - "/currency-country-rounding": { + "/currency": { "get": { "tags": [ - "Currency Country Rounding" + "Currency" ], - "summary": "List with basic information of Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "getCurrencyCountryRoundingList", + "summary": "List with basic information of Currency resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCurrencyList", "parameters": [ { "name": "limit", @@ -7013,7 +8781,7 @@ ], "responses": { "200": { - "description": "List of Currency Country Rounding resources.", + "description": "List of Currency resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7032,7 +8800,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } ] @@ -7046,16 +8814,16 @@ "type": "object", "properties": { "first": { - "example": "/currency-country-rounding?limit=25" + "example": "/currency?limit=25" }, "last": { - "example": "/currency-country-rounding?limit=25&page=11" + "example": "/currency?limit=25&page=11" }, "next": { - "example": "/currency-country-rounding?limit=25&page=4" + "example": "/currency?limit=25&page=4" }, "prev": { - "example": "/currency-country-rounding?limit=25&page=2" + "example": "/currency?limit=25&page=2" } } } @@ -7076,7 +8844,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } } @@ -7091,11 +8859,11 @@ }, "post": { "tags": [ - "Currency Country Rounding" + "Currency" ], - "summary": "Create a new Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "createCurrencyCountryRounding", + "summary": "Create a new Currency resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCurrency", "parameters": [ { "name": "_response", @@ -7117,7 +8885,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" }, "included": { "type": "array", @@ -7131,14 +8899,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } } }, "responses": { "200": { - "description": "Detail of CurrencyCountryRounding", + "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -7150,7 +8918,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } } @@ -7159,7 +8927,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + } + } } } } @@ -7173,19 +8949,93 @@ } } }, - "/currency-country-rounding/{id}": { + "/search/currency": { + "post": { + "tags": [ + "Currency" + ], + "summary": "Search for the Currency resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCurrency", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/currency/{id}": { "get": { "tags": [ - "Currency Country Rounding" + "Currency" ], - "summary": "Detailed information about a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "getCurrencyCountryRounding", + "summary": "Detailed information about a Currency resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCurrency", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency_country_rounding", + "description": "Identifier for the currency", "required": true, "schema": { "type": "string", @@ -7195,7 +9045,7 @@ ], "responses": { "200": { - "description": "Detail of CurrencyCountryRounding", + "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -7207,7 +9057,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } } @@ -7216,7 +9066,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + } + } } } } @@ -7231,16 +9089,16 @@ }, "delete": { "tags": [ - "Currency Country Rounding" + "Currency" ], - "summary": "Delete a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "deleteCurrencyCountryRounding", + "summary": "Delete a Currency resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCurrency", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency_country_rounding", + "description": "Identifier for the currency", "required": true, "schema": { "type": "string", @@ -7271,16 +9129,16 @@ }, "patch": { "tags": [ - "Currency Country Rounding" + "Currency" ], - "summary": "Partially update information about a Currency Country Rounding resource.", - "description": "Available since: 6.4.0.0", - "operationId": "updateCurrencyCountryRounding", + "summary": "Partially update information about a Currency resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCurrency", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the currency_country_rounding", + "description": "Identifier for the currency", "required": true, "schema": { "type": "string", @@ -7298,14 +9156,14 @@ } ], "requestBody": { - "description": "Partially update information about a Currency Country Rounding resource.", + "description": "Partially update information about a Currency resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" }, "included": { "type": "array", @@ -7319,14 +9177,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } } }, "responses": { "200": { - "description": "Detail of CurrencyCountryRounding", + "description": "Detail of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -7338,7 +9196,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/Currency" } } } @@ -7347,7 +9205,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Currency" + } + } } } } @@ -7364,14 +9230,14 @@ } } }, - "/custom-entity": { + "/currency-country-rounding": { "get": { "tags": [ - "Custom Entity" + "Currency Country Rounding" ], - "summary": "List with basic information of Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "getCustomEntityList", + "summary": "List with basic information of Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "getCurrencyCountryRoundingList", "parameters": [ { "name": "limit", @@ -7400,7 +9266,7 @@ ], "responses": { "200": { - "description": "List of Custom Entity resources.", + "description": "List of Currency Country Rounding resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7419,7 +9285,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } ] @@ -7433,16 +9299,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-entity?limit=25" + "example": "/currency-country-rounding?limit=25" }, "last": { - "example": "/custom-entity?limit=25&page=11" + "example": "/currency-country-rounding?limit=25&page=11" }, "next": { - "example": "/custom-entity?limit=25&page=4" + "example": "/currency-country-rounding?limit=25&page=4" }, "prev": { - "example": "/custom-entity?limit=25&page=2" + "example": "/currency-country-rounding?limit=25&page=2" } } } @@ -7463,7 +9329,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7478,11 +9344,11 @@ }, "post": { "tags": [ - "Custom Entity" + "Currency Country Rounding" ], - "summary": "Create a new Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "createCustomEntity", + "summary": "Create a new Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "createCurrencyCountryRounding", "parameters": [ { "name": "_response", @@ -7504,7 +9370,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" }, "included": { "type": "array", @@ -7518,14 +9384,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } }, "responses": { "200": { - "description": "Detail of CustomEntity", + "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -7537,7 +9403,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7546,7 +9412,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } } } } @@ -7560,19 +9434,93 @@ } } }, - "/custom-entity/{id}": { + "/search/currency-country-rounding": { + "post": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Search for the Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "searchCurrencyCountryRounding", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/currency-country-rounding/{id}": { "get": { "tags": [ - "Custom Entity" + "Currency Country Rounding" ], - "summary": "Detailed information about a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "getCustomEntity", + "summary": "Detailed information about a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "getCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_entity", + "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", @@ -7582,7 +9530,7 @@ ], "responses": { "200": { - "description": "Detail of CustomEntity", + "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -7594,7 +9542,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7603,7 +9551,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } } } } @@ -7618,16 +9574,16 @@ }, "delete": { "tags": [ - "Custom Entity" + "Currency Country Rounding" ], - "summary": "Delete a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "deleteCustomEntity", + "summary": "Delete a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "deleteCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_entity", + "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", @@ -7658,16 +9614,16 @@ }, "patch": { "tags": [ - "Custom Entity" + "Currency Country Rounding" ], - "summary": "Partially update information about a Custom Entity resource.", - "description": "Available since: 6.4.9.0", - "operationId": "updateCustomEntity", + "summary": "Partially update information about a Currency Country Rounding resource.", + "description": "Available since: 6.4.0.0", + "operationId": "updateCurrencyCountryRounding", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_entity", + "description": "Identifier for the currency_country_rounding", "required": true, "schema": { "type": "string", @@ -7685,14 +9641,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Entity resource.", + "description": "Partially update information about a Currency Country Rounding resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" }, "included": { "type": "array", @@ -7706,14 +9662,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } }, "responses": { "200": { - "description": "Detail of CustomEntity", + "description": "Detail of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -7725,7 +9681,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/CurrencyCountryRounding" } } } @@ -7734,7 +9690,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomEntity" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } } } } @@ -7751,14 +9715,14 @@ } } }, - "/custom-field": { + "/custom-entity": { "get": { "tags": [ - "Custom Field" + "Custom Entity" ], - "summary": "List with basic information of Custom Field resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldList", + "summary": "List with basic information of Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "getCustomEntityList", "parameters": [ { "name": "limit", @@ -7787,7 +9751,7 @@ ], "responses": { "200": { - "description": "List of Custom Field resources.", + "description": "List of Custom Entity resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7806,7 +9770,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } ] @@ -7820,16 +9784,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-field?limit=25" + "example": "/custom-entity?limit=25" }, "last": { - "example": "/custom-field?limit=25&page=11" + "example": "/custom-entity?limit=25&page=11" }, "next": { - "example": "/custom-field?limit=25&page=4" + "example": "/custom-entity?limit=25&page=4" }, "prev": { - "example": "/custom-field?limit=25&page=2" + "example": "/custom-entity?limit=25&page=2" } } } @@ -7850,7 +9814,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7865,11 +9829,11 @@ }, "post": { "tags": [ - "Custom Field" + "Custom Entity" ], - "summary": "Create a new Custom Field resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createCustomField", + "summary": "Create a new Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "createCustomEntity", "parameters": [ { "name": "_response", @@ -7891,7 +9855,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" }, "included": { "type": "array", @@ -7905,14 +9869,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } } }, "responses": { "200": { - "description": "Detail of CustomField", + "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -7924,7 +9888,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7933,7 +9897,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + } + } } } } @@ -7947,19 +9919,93 @@ } } }, - "/custom-field/{id}": { + "/search/custom-entity": { + "post": { + "tags": [ + "Custom Entity" + ], + "summary": "Search for the Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "searchCustomEntity", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-entity/{id}": { "get": { "tags": [ - "Custom Field" + "Custom Entity" ], - "summary": "Detailed information about a Custom Field resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCustomField", + "summary": "Detailed information about a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "getCustomEntity", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field", + "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", @@ -7969,7 +10015,7 @@ ], "responses": { "200": { - "description": "Detail of CustomField", + "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -7981,7 +10027,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -7990,7 +10036,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + } + } } } } @@ -8005,16 +10059,16 @@ }, "delete": { "tags": [ - "Custom Field" + "Custom Entity" ], - "summary": "Delete a Custom Field resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomField", + "summary": "Delete a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "deleteCustomEntity", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field", + "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", @@ -8045,16 +10099,16 @@ }, "patch": { "tags": [ - "Custom Field" + "Custom Entity" ], - "summary": "Partially update information about a Custom Field resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateCustomField", + "summary": "Partially update information about a Custom Entity resource.", + "description": "Available since: 6.4.9.0", + "operationId": "updateCustomEntity", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field", + "description": "Identifier for the custom_entity", "required": true, "schema": { "type": "string", @@ -8072,14 +10126,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Field resource.", + "description": "Partially update information about a Custom Entity resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" }, "included": { "type": "array", @@ -8093,14 +10147,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } } }, "responses": { "200": { - "description": "Detail of CustomField", + "description": "Detail of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -8112,7 +10166,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -8121,7 +10175,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomEntity" + } + } } } } @@ -8138,14 +10200,14 @@ } } }, - "/custom-field-set": { + "/custom-field": { "get": { "tags": [ - "Custom Field Set" + "Custom Field" ], - "summary": "List with basic information of Custom Field Set resources.", + "summary": "List with basic information of Custom Field resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetList", + "operationId": "getCustomFieldList", "parameters": [ { "name": "limit", @@ -8174,7 +10236,7 @@ ], "responses": { "200": { - "description": "List of Custom Field Set resources.", + "description": "List of Custom Field resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8193,7 +10255,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } ] @@ -8207,16 +10269,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-field-set?limit=25" + "example": "/custom-field?limit=25" }, "last": { - "example": "/custom-field-set?limit=25&page=11" + "example": "/custom-field?limit=25&page=11" }, "next": { - "example": "/custom-field-set?limit=25&page=4" + "example": "/custom-field?limit=25&page=4" }, "prev": { - "example": "/custom-field-set?limit=25&page=2" + "example": "/custom-field?limit=25&page=2" } } } @@ -8237,7 +10299,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } } @@ -8252,11 +10314,11 @@ }, "post": { "tags": [ - "Custom Field Set" + "Custom Field" ], - "summary": "Create a new Custom Field Set resources.", + "summary": "Create a new Custom Field resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomFieldSet", + "operationId": "createCustomField", "parameters": [ { "name": "_response", @@ -8278,7 +10340,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" }, "included": { "type": "array", @@ -8292,14 +10354,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSet", + "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -8311,7 +10373,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } } @@ -8320,7 +10382,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + } + } } } } @@ -8334,19 +10404,93 @@ } } }, - "/custom-field-set/{id}": { + "/search/custom-field": { + "post": { + "tags": [ + "Custom Field" + ], + "summary": "Search for the Custom Field resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomField", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field/{id}": { "get": { "tags": [ - "Custom Field Set" + "Custom Field" ], - "summary": "Detailed information about a Custom Field Set resource.", + "summary": "Detailed information about a Custom Field resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSet", + "operationId": "getCustomField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set", + "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", @@ -8356,7 +10500,7 @@ ], "responses": { "200": { - "description": "Detail of CustomFieldSet", + "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -8368,7 +10512,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } } @@ -8377,7 +10521,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + } + } } } } @@ -8392,16 +10544,16 @@ }, "delete": { "tags": [ - "Custom Field Set" + "Custom Field" ], - "summary": "Delete a Custom Field Set resource.", + "summary": "Delete a Custom Field resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomFieldSet", + "operationId": "deleteCustomField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set", + "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", @@ -8432,16 +10584,16 @@ }, "patch": { "tags": [ - "Custom Field Set" + "Custom Field" ], - "summary": "Partially update information about a Custom Field Set resource.", + "summary": "Partially update information about a Custom Field resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomFieldSet", + "operationId": "updateCustomField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set", + "description": "Identifier for the custom_field", "required": true, "schema": { "type": "string", @@ -8459,14 +10611,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Field Set resource.", + "description": "Partially update information about a Custom Field resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" }, "included": { "type": "array", @@ -8480,14 +10632,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSet", + "description": "Detail of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -8499,7 +10651,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/CustomField" } } } @@ -8508,7 +10660,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomField" + } + } } } } @@ -8525,14 +10685,14 @@ } } }, - "/custom-field-set-relation": { + "/custom-field-set": { "get": { "tags": [ - "Custom Field Set Relation" + "Custom Field Set" ], - "summary": "List with basic information of Custom Field Set Relation resources.", + "summary": "List with basic information of Custom Field Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetRelationList", + "operationId": "getCustomFieldSetList", "parameters": [ { "name": "limit", @@ -8561,7 +10721,7 @@ ], "responses": { "200": { - "description": "List of Custom Field Set Relation resources.", + "description": "List of Custom Field Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8580,7 +10740,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } ] @@ -8594,16 +10754,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-field-set-relation?limit=25" + "example": "/custom-field-set?limit=25" }, "last": { - "example": "/custom-field-set-relation?limit=25&page=11" + "example": "/custom-field-set?limit=25&page=11" }, "next": { - "example": "/custom-field-set-relation?limit=25&page=4" + "example": "/custom-field-set?limit=25&page=4" }, "prev": { - "example": "/custom-field-set-relation?limit=25&page=2" + "example": "/custom-field-set?limit=25&page=2" } } } @@ -8624,7 +10784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8639,11 +10799,11 @@ }, "post": { "tags": [ - "Custom Field Set Relation" + "Custom Field Set" ], - "summary": "Create a new Custom Field Set Relation resources.", + "summary": "Create a new Custom Field Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomFieldSetRelation", + "operationId": "createCustomFieldSet", "parameters": [ { "name": "_response", @@ -8665,7 +10825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" }, "included": { "type": "array", @@ -8679,14 +10839,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSetRelation", + "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -8698,7 +10858,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8707,7 +10867,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } } } } @@ -8721,19 +10889,93 @@ } } }, - "/custom-field-set-relation/{id}": { + "/search/custom-field-set": { + "post": { + "tags": [ + "Custom Field Set" + ], + "summary": "Search for the Custom Field Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomFieldSet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field-set/{id}": { "get": { "tags": [ - "Custom Field Set Relation" + "Custom Field Set" ], - "summary": "Detailed information about a Custom Field Set Relation resource.", + "summary": "Detailed information about a Custom Field Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomFieldSetRelation", + "operationId": "getCustomFieldSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set_relation", + "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", @@ -8743,7 +10985,7 @@ ], "responses": { "200": { - "description": "Detail of CustomFieldSetRelation", + "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -8755,7 +10997,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8764,7 +11006,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } } } } @@ -8779,16 +11029,16 @@ }, "delete": { "tags": [ - "Custom Field Set Relation" + "Custom Field Set" ], - "summary": "Delete a Custom Field Set Relation resource.", + "summary": "Delete a Custom Field Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomFieldSetRelation", + "operationId": "deleteCustomFieldSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set_relation", + "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", @@ -8819,16 +11069,16 @@ }, "patch": { "tags": [ - "Custom Field Set Relation" + "Custom Field Set" ], - "summary": "Partially update information about a Custom Field Set Relation resource.", + "summary": "Partially update information about a Custom Field Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomFieldSetRelation", + "operationId": "updateCustomFieldSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_field_set_relation", + "description": "Identifier for the custom_field_set", "required": true, "schema": { "type": "string", @@ -8846,14 +11096,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Field Set Relation resource.", + "description": "Partially update information about a Custom Field Set resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" }, "included": { "type": "array", @@ -8867,14 +11117,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } } }, "responses": { "200": { - "description": "Detail of CustomFieldSetRelation", + "description": "Detail of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -8886,7 +11136,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -8895,7 +11145,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } } } } @@ -8912,14 +11170,14 @@ } } }, - "/customer": { + "/custom-field-set-relation": { "get": { "tags": [ - "Customer" + "Custom Field Set Relation" ], - "summary": "List with basic information of Customer resources.", + "summary": "List with basic information of Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerList", + "operationId": "getCustomFieldSetRelationList", "parameters": [ { "name": "limit", @@ -8948,7 +11206,7 @@ ], "responses": { "200": { - "description": "List of Customer resources.", + "description": "List of Custom Field Set Relation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8967,7 +11225,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } ] @@ -8981,16 +11239,16 @@ "type": "object", "properties": { "first": { - "example": "/customer?limit=25" + "example": "/custom-field-set-relation?limit=25" }, "last": { - "example": "/customer?limit=25&page=11" + "example": "/custom-field-set-relation?limit=25&page=11" }, "next": { - "example": "/customer?limit=25&page=4" + "example": "/custom-field-set-relation?limit=25&page=4" }, "prev": { - "example": "/customer?limit=25&page=2" + "example": "/custom-field-set-relation?limit=25&page=2" } } } @@ -9011,7 +11269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -9026,11 +11284,11 @@ }, "post": { "tags": [ - "Customer" + "Custom Field Set Relation" ], - "summary": "Create a new Customer resources.", + "summary": "Create a new Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomer", + "operationId": "createCustomFieldSetRelation", "parameters": [ { "name": "_response", @@ -9052,7 +11310,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" }, "included": { "type": "array", @@ -9066,14 +11324,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } }, "responses": { "200": { - "description": "Detail of Customer", + "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -9085,7 +11343,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -9094,7 +11352,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } } } } @@ -9108,19 +11374,93 @@ } } }, - "/customer/{id}": { + "/search/custom-field-set-relation": { + "post": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Search for the Custom Field Set Relation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomFieldSetRelation", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-field-set-relation/{id}": { "get": { "tags": [ - "Customer" + "Custom Field Set Relation" ], - "summary": "Detailed information about a Customer resource.", + "summary": "Detailed information about a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomer", + "operationId": "getCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer", + "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", @@ -9130,7 +11470,7 @@ ], "responses": { "200": { - "description": "Detail of Customer", + "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -9142,7 +11482,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -9151,7 +11491,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } } } } @@ -9166,16 +11514,16 @@ }, "delete": { "tags": [ - "Customer" + "Custom Field Set Relation" ], - "summary": "Delete a Customer resource.", + "summary": "Delete a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomer", + "operationId": "deleteCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer", + "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", @@ -9206,16 +11554,16 @@ }, "patch": { "tags": [ - "Customer" + "Custom Field Set Relation" ], - "summary": "Partially update information about a Customer resource.", + "summary": "Partially update information about a Custom Field Set Relation resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomer", + "operationId": "updateCustomFieldSetRelation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer", + "description": "Identifier for the custom_field_set_relation", "required": true, "schema": { "type": "string", @@ -9233,14 +11581,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer resource.", + "description": "Partially update information about a Custom Field Set Relation resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" }, "included": { "type": "array", @@ -9254,14 +11602,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } }, "responses": { "200": { - "description": "Detail of Customer", + "description": "Detail of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -9273,7 +11621,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/CustomFieldSetRelation" } } } @@ -9282,7 +11630,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Customer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } } } } @@ -9299,14 +11655,14 @@ } } }, - "/customer-address": { + "/customer": { "get": { "tags": [ - "Customer Address" + "Customer" ], - "summary": "List with basic information of Customer Address resources.", + "summary": "List with basic information of Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerAddressList", + "operationId": "getCustomerList", "parameters": [ { "name": "limit", @@ -9335,7 +11691,7 @@ ], "responses": { "200": { - "description": "List of Customer Address resources.", + "description": "List of Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9354,7 +11710,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } ] @@ -9368,16 +11724,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-address?limit=25" + "example": "/customer?limit=25" }, "last": { - "example": "/customer-address?limit=25&page=11" + "example": "/customer?limit=25&page=11" }, "next": { - "example": "/customer-address?limit=25&page=4" + "example": "/customer?limit=25&page=4" }, "prev": { - "example": "/customer-address?limit=25&page=2" + "example": "/customer?limit=25&page=2" } } } @@ -9398,7 +11754,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } } @@ -9413,11 +11769,11 @@ }, "post": { "tags": [ - "Customer Address" + "Customer" ], - "summary": "Create a new Customer Address resources.", + "summary": "Create a new Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomerAddress", + "operationId": "createCustomer", "parameters": [ { "name": "_response", @@ -9439,7 +11795,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" }, "included": { "type": "array", @@ -9453,14 +11809,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { - "description": "Detail of CustomerAddress", + "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -9472,7 +11828,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } } @@ -9481,7 +11837,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + } + } } } } @@ -9495,19 +11859,93 @@ } } }, - "/customer-address/{id}": { + "/search/customer": { + "post": { + "tags": [ + "Customer" + ], + "summary": "Search for the Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer/{id}": { "get": { "tags": [ - "Customer Address" + "Customer" ], - "summary": "Detailed information about a Customer Address resource.", + "summary": "Detailed information about a Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerAddress", + "operationId": "getCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_address", + "description": "Identifier for the customer", "required": true, "schema": { "type": "string", @@ -9517,7 +11955,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerAddress", + "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -9529,7 +11967,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } } @@ -9538,7 +11976,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + } + } } } } @@ -9553,16 +11999,16 @@ }, "delete": { "tags": [ - "Customer Address" + "Customer" ], - "summary": "Delete a Customer Address resource.", + "summary": "Delete a Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomerAddress", + "operationId": "deleteCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_address", + "description": "Identifier for the customer", "required": true, "schema": { "type": "string", @@ -9593,16 +12039,16 @@ }, "patch": { "tags": [ - "Customer Address" + "Customer" ], - "summary": "Partially update information about a Customer Address resource.", + "summary": "Partially update information about a Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomerAddress", + "operationId": "updateCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_address", + "description": "Identifier for the customer", "required": true, "schema": { "type": "string", @@ -9620,14 +12066,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Address resource.", + "description": "Partially update information about a Customer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" }, "included": { "type": "array", @@ -9641,14 +12087,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } } }, "responses": { "200": { - "description": "Detail of CustomerAddress", + "description": "Detail of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -9660,7 +12106,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/Customer" } } } @@ -9669,7 +12115,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerAddress" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Customer" + } + } } } } @@ -9686,14 +12140,14 @@ } } }, - "/customer-group": { + "/customer-address": { "get": { "tags": [ - "Customer Group" + "Customer Address" ], - "summary": "List with basic information of Customer Group resources.", + "summary": "List with basic information of Customer Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerGroupList", + "operationId": "getCustomerAddressList", "parameters": [ { "name": "limit", @@ -9722,7 +12176,7 @@ ], "responses": { "200": { - "description": "List of Customer Group resources.", + "description": "List of Customer Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9741,7 +12195,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } ] @@ -9755,16 +12209,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-group?limit=25" + "example": "/customer-address?limit=25" }, "last": { - "example": "/customer-group?limit=25&page=11" + "example": "/customer-address?limit=25&page=11" }, "next": { - "example": "/customer-group?limit=25&page=4" + "example": "/customer-address?limit=25&page=4" }, "prev": { - "example": "/customer-group?limit=25&page=2" + "example": "/customer-address?limit=25&page=2" } } } @@ -9785,7 +12239,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9800,11 +12254,11 @@ }, "post": { "tags": [ - "Customer Group" + "Customer Address" ], - "summary": "Create a new Customer Group resources.", + "summary": "Create a new Customer Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "createCustomerGroup", + "operationId": "createCustomerAddress", "parameters": [ { "name": "_response", @@ -9826,7 +12280,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" }, "included": { "type": "array", @@ -9840,14 +12294,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of CustomerGroup", + "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9859,7 +12313,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9868,7 +12322,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + } + } } } } @@ -9882,19 +12344,93 @@ } } }, - "/customer-group/{id}": { + "/search/customer-address": { + "post": { + "tags": [ + "Customer Address" + ], + "summary": "Search for the Customer Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomerAddress", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-address/{id}": { "get": { "tags": [ - "Customer Group" + "Customer Address" ], - "summary": "Detailed information about a Customer Group resource.", + "summary": "Detailed information about a Customer Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "getCustomerGroup", + "operationId": "getCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_group", + "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", @@ -9904,7 +12440,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerGroup", + "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9916,7 +12452,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -9925,7 +12461,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + } + } } } } @@ -9940,16 +12484,16 @@ }, "delete": { "tags": [ - "Customer Group" + "Customer Address" ], - "summary": "Delete a Customer Group resource.", + "summary": "Delete a Customer Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteCustomerGroup", + "operationId": "deleteCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_group", + "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", @@ -9980,16 +12524,16 @@ }, "patch": { "tags": [ - "Customer Group" + "Customer Address" ], - "summary": "Partially update information about a Customer Group resource.", + "summary": "Partially update information about a Customer Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateCustomerGroup", + "operationId": "updateCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_group", + "description": "Identifier for the customer_address", "required": true, "schema": { "type": "string", @@ -10007,14 +12551,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Group resource.", + "description": "Partially update information about a Customer Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" }, "included": { "type": "array", @@ -10028,14 +12572,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of CustomerGroup", + "description": "Detail of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -10047,7 +12591,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -10056,7 +12600,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerAddress" + } + } } } } @@ -10073,14 +12625,14 @@ } } }, - "/customer-recovery": { + "/customer-group": { "get": { "tags": [ - "Customer Recovery" + "Customer Group" ], - "summary": "List with basic information of Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getCustomerRecoveryList", + "summary": "List with basic information of Customer Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerGroupList", "parameters": [ { "name": "limit", @@ -10109,7 +12661,7 @@ ], "responses": { "200": { - "description": "List of Customer Recovery resources.", + "description": "List of Customer Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10128,7 +12680,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } ] @@ -10142,16 +12694,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-recovery?limit=25" + "example": "/customer-group?limit=25" }, "last": { - "example": "/customer-recovery?limit=25&page=11" + "example": "/customer-group?limit=25&page=11" }, "next": { - "example": "/customer-recovery?limit=25&page=4" + "example": "/customer-group?limit=25&page=4" }, "prev": { - "example": "/customer-recovery?limit=25&page=2" + "example": "/customer-group?limit=25&page=2" } } } @@ -10172,7 +12724,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -10187,11 +12739,11 @@ }, "post": { "tags": [ - "Customer Recovery" + "Customer Group" ], - "summary": "Create a new Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createCustomerRecovery", + "summary": "Create a new Customer Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createCustomerGroup", "parameters": [ { "name": "_response", @@ -10213,7 +12765,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" }, "included": { "type": "array", @@ -10227,14 +12779,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } } }, "responses": { "200": { - "description": "Detail of CustomerRecovery", + "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -10246,7 +12798,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -10255,7 +12807,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + } + } } } } @@ -10269,19 +12829,93 @@ } } }, - "/customer-recovery/{id}": { + "/search/customer-group": { + "post": { + "tags": [ + "Customer Group" + ], + "summary": "Search for the Customer Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomerGroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-group/{id}": { "get": { "tags": [ - "Customer Recovery" + "Customer Group" ], - "summary": "Detailed information about a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getCustomerRecovery", + "summary": "Detailed information about a Customer Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCustomerGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_recovery", + "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", @@ -10291,7 +12925,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerRecovery", + "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -10303,7 +12937,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -10312,7 +12946,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + } + } } } } @@ -10327,16 +12969,16 @@ }, "delete": { "tags": [ - "Customer Recovery" + "Customer Group" ], - "summary": "Delete a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteCustomerRecovery", + "summary": "Delete a Customer Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteCustomerGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_recovery", + "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", @@ -10367,16 +13009,16 @@ }, "patch": { "tags": [ - "Customer Recovery" + "Customer Group" ], - "summary": "Partially update information about a Customer Recovery resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateCustomerRecovery", + "summary": "Partially update information about a Customer Group resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateCustomerGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_recovery", + "description": "Identifier for the customer_group", "required": true, "schema": { "type": "string", @@ -10394,14 +13036,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Recovery resource.", + "description": "Partially update information about a Customer Group resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" }, "included": { "type": "array", @@ -10415,14 +13057,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } } }, "responses": { "200": { - "description": "Detail of CustomerRecovery", + "description": "Detail of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -10434,7 +13076,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerRecovery" + "$ref": "#/components/schemas/CustomerGroup" } } } @@ -10443,7 +13085,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerRecovery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerGroup" + } + } } } } @@ -10460,14 +13110,14 @@ } } }, - "/customer-wishlist": { + "/customer-recovery": { "get": { "tags": [ - "Customer Wishlist" + "Customer Recovery" ], - "summary": "List with basic information of Customer Wishlist resources.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistList", + "summary": "List with basic information of Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getCustomerRecoveryList", "parameters": [ { "name": "limit", @@ -10496,7 +13146,7 @@ ], "responses": { "200": { - "description": "List of Customer Wishlist resources.", + "description": "List of Customer Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10515,7 +13165,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } ] @@ -10529,16 +13179,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-wishlist?limit=25" + "example": "/customer-recovery?limit=25" }, "last": { - "example": "/customer-wishlist?limit=25&page=11" + "example": "/customer-recovery?limit=25&page=11" }, "next": { - "example": "/customer-wishlist?limit=25&page=4" + "example": "/customer-recovery?limit=25&page=4" }, "prev": { - "example": "/customer-wishlist?limit=25&page=2" + "example": "/customer-recovery?limit=25&page=2" } } } @@ -10559,7 +13209,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10574,11 +13224,11 @@ }, "post": { "tags": [ - "Customer Wishlist" + "Customer Recovery" ], - "summary": "Create a new Customer Wishlist resources.", - "description": "Available since: 6.3.4.0", - "operationId": "createCustomerWishlist", + "summary": "Create a new Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createCustomerRecovery", "parameters": [ { "name": "_response", @@ -10600,7 +13250,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" }, "included": { "type": "array", @@ -10614,14 +13264,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlist", + "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10633,7 +13283,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10642,7 +13292,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } } } } @@ -10656,19 +13314,93 @@ } } }, - "/customer-wishlist/{id}": { + "/search/customer-recovery": { + "post": { + "tags": [ + "Customer Recovery" + ], + "summary": "Search for the Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchCustomerRecovery", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-recovery/{id}": { "get": { "tags": [ - "Customer Wishlist" + "Customer Recovery" ], - "summary": "Detailed information about a Customer Wishlist resource.", - "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlist", + "summary": "Detailed information about a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getCustomerRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist", + "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", @@ -10678,7 +13410,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerWishlist", + "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10690,7 +13422,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10699,7 +13431,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } } } } @@ -10714,16 +13454,16 @@ }, "delete": { "tags": [ - "Customer Wishlist" + "Customer Recovery" ], - "summary": "Delete a Customer Wishlist resource.", - "description": "Available since: 6.3.4.0", - "operationId": "deleteCustomerWishlist", + "summary": "Delete a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteCustomerRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist", + "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", @@ -10754,16 +13494,16 @@ }, "patch": { "tags": [ - "Customer Wishlist" + "Customer Recovery" ], - "summary": "Partially update information about a Customer Wishlist resource.", - "description": "Available since: 6.3.4.0", - "operationId": "updateCustomerWishlist", + "summary": "Partially update information about a Customer Recovery resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateCustomerRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist", + "description": "Identifier for the customer_recovery", "required": true, "schema": { "type": "string", @@ -10781,14 +13521,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Wishlist resource.", + "description": "Partially update information about a Customer Recovery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" }, "included": { "type": "array", @@ -10802,14 +13542,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlist", + "description": "Detail of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10821,7 +13561,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlist" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -10830,7 +13570,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlist" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } } } } @@ -10847,14 +13595,14 @@ } } }, - "/customer-wishlist-product": { + "/customer-wishlist": { "get": { "tags": [ - "Customer Wishlist Product" + "Customer Wishlist" ], - "summary": "List with basic information of Customer Wishlist Product resources.", + "summary": "List with basic information of Customer Wishlist resources.", "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistProductList", + "operationId": "getCustomerWishlistList", "parameters": [ { "name": "limit", @@ -10883,7 +13631,7 @@ ], "responses": { "200": { - "description": "List of Customer Wishlist Product resources.", + "description": "List of Customer Wishlist resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10902,7 +13650,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } ] @@ -10916,16 +13664,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-wishlist-product?limit=25" + "example": "/customer-wishlist?limit=25" }, "last": { - "example": "/customer-wishlist-product?limit=25&page=11" + "example": "/customer-wishlist?limit=25&page=11" }, "next": { - "example": "/customer-wishlist-product?limit=25&page=4" + "example": "/customer-wishlist?limit=25&page=4" }, "prev": { - "example": "/customer-wishlist-product?limit=25&page=2" + "example": "/customer-wishlist?limit=25&page=2" } } } @@ -10946,7 +13694,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10961,11 +13709,11 @@ }, "post": { "tags": [ - "Customer Wishlist Product" + "Customer Wishlist" ], - "summary": "Create a new Customer Wishlist Product resources.", + "summary": "Create a new Customer Wishlist resources.", "description": "Available since: 6.3.4.0", - "operationId": "createCustomerWishlistProduct", + "operationId": "createCustomerWishlist", "parameters": [ { "name": "_response", @@ -10987,7 +13735,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" }, "included": { "type": "array", @@ -11001,14 +13749,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlistProduct", + "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -11020,7 +13768,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -11029,7 +13777,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } } } } @@ -11043,19 +13799,93 @@ } } }, - "/customer-wishlist-product/{id}": { + "/search/customer-wishlist": { + "post": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Search for the Customer Wishlist resources.", + "description": "Available since: 6.3.4.0", + "operationId": "searchCustomerWishlist", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-wishlist/{id}": { "get": { "tags": [ - "Customer Wishlist Product" + "Customer Wishlist" ], - "summary": "Detailed information about a Customer Wishlist Product resource.", + "summary": "Detailed information about a Customer Wishlist resource.", "description": "Available since: 6.3.4.0", - "operationId": "getCustomerWishlistProduct", + "operationId": "getCustomerWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist_product", + "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", @@ -11065,7 +13895,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerWishlistProduct", + "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -11077,7 +13907,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -11086,7 +13916,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } } } } @@ -11101,16 +13939,16 @@ }, "delete": { "tags": [ - "Customer Wishlist Product" + "Customer Wishlist" ], - "summary": "Delete a Customer Wishlist Product resource.", + "summary": "Delete a Customer Wishlist resource.", "description": "Available since: 6.3.4.0", - "operationId": "deleteCustomerWishlistProduct", + "operationId": "deleteCustomerWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist_product", + "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", @@ -11141,16 +13979,16 @@ }, "patch": { "tags": [ - "Customer Wishlist Product" + "Customer Wishlist" ], - "summary": "Partially update information about a Customer Wishlist Product resource.", + "summary": "Partially update information about a Customer Wishlist resource.", "description": "Available since: 6.3.4.0", - "operationId": "updateCustomerWishlistProduct", + "operationId": "updateCustomerWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_wishlist_product", + "description": "Identifier for the customer_wishlist", "required": true, "schema": { "type": "string", @@ -11168,14 +14006,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Wishlist Product resource.", + "description": "Partially update information about a Customer Wishlist resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" }, "included": { "type": "array", @@ -11189,14 +14027,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } } }, "responses": { "200": { - "description": "Detail of CustomerWishlistProduct", + "description": "Detail of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -11208,7 +14046,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -11217,7 +14055,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } } } } @@ -11234,14 +14080,14 @@ } } }, - "/delivery-time": { + "/customer-wishlist-product": { "get": { "tags": [ - "Delivery Time" + "Customer Wishlist Product" ], - "summary": "List with basic information of Delivery Time resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDeliveryTimeList", + "summary": "List with basic information of Customer Wishlist Product resources.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlistProductList", "parameters": [ { "name": "limit", @@ -11270,7 +14116,7 @@ ], "responses": { "200": { - "description": "List of Delivery Time resources.", + "description": "List of Customer Wishlist Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11289,7 +14135,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } ] @@ -11303,16 +14149,16 @@ "type": "object", "properties": { "first": { - "example": "/delivery-time?limit=25" + "example": "/customer-wishlist-product?limit=25" }, "last": { - "example": "/delivery-time?limit=25&page=11" + "example": "/customer-wishlist-product?limit=25&page=11" }, "next": { - "example": "/delivery-time?limit=25&page=4" + "example": "/customer-wishlist-product?limit=25&page=4" }, "prev": { - "example": "/delivery-time?limit=25&page=2" + "example": "/customer-wishlist-product?limit=25&page=2" } } } @@ -11333,7 +14179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11348,11 +14194,11 @@ }, "post": { "tags": [ - "Delivery Time" + "Customer Wishlist Product" ], - "summary": "Create a new Delivery Time resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDeliveryTime", + "summary": "Create a new Customer Wishlist Product resources.", + "description": "Available since: 6.3.4.0", + "operationId": "createCustomerWishlistProduct", "parameters": [ { "name": "_response", @@ -11374,7 +14220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" }, "included": { "type": "array", @@ -11388,14 +14234,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of DeliveryTime", + "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11407,7 +14253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11416,7 +14262,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } } } } @@ -11430,19 +14284,93 @@ } } }, - "/delivery-time/{id}": { + "/search/customer-wishlist-product": { + "post": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Search for the Customer Wishlist Product resources.", + "description": "Available since: 6.3.4.0", + "operationId": "searchCustomerWishlistProduct", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-wishlist-product/{id}": { "get": { "tags": [ - "Delivery Time" + "Customer Wishlist Product" ], - "summary": "Detailed information about a Delivery Time resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDeliveryTime", + "summary": "Detailed information about a Customer Wishlist Product resource.", + "description": "Available since: 6.3.4.0", + "operationId": "getCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the delivery_time", + "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", @@ -11452,7 +14380,7 @@ ], "responses": { "200": { - "description": "Detail of DeliveryTime", + "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11464,7 +14392,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11473,7 +14401,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } } } } @@ -11488,16 +14424,16 @@ }, "delete": { "tags": [ - "Delivery Time" + "Customer Wishlist Product" ], - "summary": "Delete a Delivery Time resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDeliveryTime", + "summary": "Delete a Customer Wishlist Product resource.", + "description": "Available since: 6.3.4.0", + "operationId": "deleteCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the delivery_time", + "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", @@ -11528,16 +14464,16 @@ }, "patch": { "tags": [ - "Delivery Time" + "Customer Wishlist Product" ], - "summary": "Partially update information about a Delivery Time resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDeliveryTime", + "summary": "Partially update information about a Customer Wishlist Product resource.", + "description": "Available since: 6.3.4.0", + "operationId": "updateCustomerWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the delivery_time", + "description": "Identifier for the customer_wishlist_product", "required": true, "schema": { "type": "string", @@ -11555,14 +14491,14 @@ } ], "requestBody": { - "description": "Partially update information about a Delivery Time resource.", + "description": "Partially update information about a Customer Wishlist Product resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" }, "included": { "type": "array", @@ -11576,14 +14512,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of DeliveryTime", + "description": "Detail of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11595,7 +14531,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/CustomerWishlistProduct" } } } @@ -11604,7 +14540,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DeliveryTime" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } } } } @@ -11621,14 +14565,14 @@ } } }, - "/document": { + "/delivery-time": { "get": { "tags": [ - "Document" + "Delivery Time" ], - "summary": "List with basic information of Document resources.", + "summary": "List with basic information of Delivery Time resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentList", + "operationId": "getDeliveryTimeList", "parameters": [ { "name": "limit", @@ -11657,7 +14601,7 @@ ], "responses": { "200": { - "description": "List of Document resources.", + "description": "List of Delivery Time resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11676,7 +14620,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } ] @@ -11690,16 +14634,16 @@ "type": "object", "properties": { "first": { - "example": "/document?limit=25" + "example": "/delivery-time?limit=25" }, "last": { - "example": "/document?limit=25&page=11" + "example": "/delivery-time?limit=25&page=11" }, "next": { - "example": "/document?limit=25&page=4" + "example": "/delivery-time?limit=25&page=4" }, "prev": { - "example": "/document?limit=25&page=2" + "example": "/delivery-time?limit=25&page=2" } } } @@ -11720,7 +14664,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11735,11 +14679,11 @@ }, "post": { "tags": [ - "Document" + "Delivery Time" ], - "summary": "Create a new Document resources.", + "summary": "Create a new Delivery Time resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocument", + "operationId": "createDeliveryTime", "parameters": [ { "name": "_response", @@ -11761,7 +14705,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" }, "included": { "type": "array", @@ -11775,14 +14719,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } } }, "responses": { "200": { - "description": "Detail of Document", + "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11794,7 +14738,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11803,7 +14747,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + } + } } } } @@ -11817,19 +14769,93 @@ } } }, - "/document/{id}": { + "/search/delivery-time": { + "post": { + "tags": [ + "Delivery Time" + ], + "summary": "Search for the Delivery Time resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDeliveryTime", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/delivery-time/{id}": { "get": { "tags": [ - "Document" + "Delivery Time" ], - "summary": "Detailed information about a Document resource.", + "summary": "Detailed information about a Delivery Time resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocument", + "operationId": "getDeliveryTime", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document", + "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", @@ -11839,7 +14865,7 @@ ], "responses": { "200": { - "description": "Detail of Document", + "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11851,7 +14877,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11860,7 +14886,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + } + } } } } @@ -11875,16 +14909,16 @@ }, "delete": { "tags": [ - "Document" + "Delivery Time" ], - "summary": "Delete a Document resource.", + "summary": "Delete a Delivery Time resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocument", + "operationId": "deleteDeliveryTime", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document", + "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", @@ -11915,16 +14949,16 @@ }, "patch": { "tags": [ - "Document" + "Delivery Time" ], - "summary": "Partially update information about a Document resource.", + "summary": "Partially update information about a Delivery Time resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocument", + "operationId": "updateDeliveryTime", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document", + "description": "Identifier for the delivery_time", "required": true, "schema": { "type": "string", @@ -11942,14 +14976,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document resource.", + "description": "Partially update information about a Delivery Time resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" }, "included": { "type": "array", @@ -11963,14 +14997,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } } }, "responses": { "200": { - "description": "Detail of Document", + "description": "Detail of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11982,7 +15016,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -11991,7 +15025,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Document" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DeliveryTime" + } + } } } } @@ -12008,14 +15050,14 @@ } } }, - "/document-base-config": { + "/document": { "get": { "tags": [ - "Document Base Config" + "Document" ], - "summary": "List with basic information of Document Base Config resources.", + "summary": "List with basic information of Document resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigList", + "operationId": "getDocumentList", "parameters": [ { "name": "limit", @@ -12044,7 +15086,7 @@ ], "responses": { "200": { - "description": "List of Document Base Config resources.", + "description": "List of Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12063,7 +15105,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } ] @@ -12077,16 +15119,16 @@ "type": "object", "properties": { "first": { - "example": "/document-base-config?limit=25" + "example": "/document?limit=25" }, "last": { - "example": "/document-base-config?limit=25&page=11" + "example": "/document?limit=25&page=11" }, "next": { - "example": "/document-base-config?limit=25&page=4" + "example": "/document?limit=25&page=4" }, "prev": { - "example": "/document-base-config?limit=25&page=2" + "example": "/document?limit=25&page=2" } } } @@ -12107,7 +15149,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } } @@ -12122,11 +15164,11 @@ }, "post": { "tags": [ - "Document Base Config" + "Document" ], - "summary": "Create a new Document Base Config resources.", + "summary": "Create a new Document resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocumentBaseConfig", + "operationId": "createDocument", "parameters": [ { "name": "_response", @@ -12148,7 +15190,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" }, "included": { "type": "array", @@ -12162,14 +15204,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfig", + "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { @@ -12181,7 +15223,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } } @@ -12190,7 +15232,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + } + } } } } @@ -12204,19 +15254,93 @@ } } }, - "/document-base-config/{id}": { + "/search/document": { + "post": { + "tags": [ + "Document" + ], + "summary": "Search for the Document resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocument", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document/{id}": { "get": { "tags": [ - "Document Base Config" + "Document" ], - "summary": "Detailed information about a Document Base Config resource.", + "summary": "Detailed information about a Document resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfig", + "operationId": "getDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config", + "description": "Identifier for the document", "required": true, "schema": { "type": "string", @@ -12226,7 +15350,7 @@ ], "responses": { "200": { - "description": "Detail of DocumentBaseConfig", + "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { @@ -12238,7 +15362,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } } @@ -12247,7 +15371,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + } + } } } } @@ -12262,16 +15394,16 @@ }, "delete": { "tags": [ - "Document Base Config" + "Document" ], - "summary": "Delete a Document Base Config resource.", + "summary": "Delete a Document resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentBaseConfig", + "operationId": "deleteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config", + "description": "Identifier for the document", "required": true, "schema": { "type": "string", @@ -12302,16 +15434,16 @@ }, "patch": { "tags": [ - "Document Base Config" + "Document" ], - "summary": "Partially update information about a Document Base Config resource.", + "summary": "Partially update information about a Document resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentBaseConfig", + "operationId": "updateDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config", + "description": "Identifier for the document", "required": true, "schema": { "type": "string", @@ -12329,14 +15461,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document Base Config resource.", + "description": "Partially update information about a Document resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" }, "included": { "type": "array", @@ -12350,14 +15482,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfig", + "description": "Detail of Document", "content": { "application/vnd.api+json": { "schema": { @@ -12369,7 +15501,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Document" } } } @@ -12378,7 +15510,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Document" + } + } } } } @@ -12395,14 +15535,14 @@ } } }, - "/document-base-config-sales-channel": { + "/document-base-config": { "get": { "tags": [ - "Document Base Config Sales Channel" + "Document Base Config" ], - "summary": "List with basic information of Document Base Config Sales Channel resources.", + "summary": "List with basic information of Document Base Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannelList", + "operationId": "getDocumentBaseConfigList", "parameters": [ { "name": "limit", @@ -12431,7 +15571,7 @@ ], "responses": { "200": { - "description": "List of Document Base Config Sales Channel resources.", + "description": "List of Document Base Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12450,7 +15590,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } ] @@ -12464,16 +15604,16 @@ "type": "object", "properties": { "first": { - "example": "/document-base-config-sales-channel?limit=25" + "example": "/document-base-config?limit=25" }, "last": { - "example": "/document-base-config-sales-channel?limit=25&page=11" + "example": "/document-base-config?limit=25&page=11" }, "next": { - "example": "/document-base-config-sales-channel?limit=25&page=4" + "example": "/document-base-config?limit=25&page=4" }, "prev": { - "example": "/document-base-config-sales-channel?limit=25&page=2" + "example": "/document-base-config?limit=25&page=2" } } } @@ -12494,7 +15634,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12509,11 +15649,11 @@ }, "post": { "tags": [ - "Document Base Config Sales Channel" + "Document Base Config" ], - "summary": "Create a new Document Base Config Sales Channel resources.", + "summary": "Create a new Document Base Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocumentBaseConfigSalesChannel", + "operationId": "createDocumentBaseConfig", "parameters": [ { "name": "_response", @@ -12535,7 +15675,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" }, "included": { "type": "array", @@ -12549,14 +15689,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", + "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -12568,7 +15708,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12577,7 +15717,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } } } } @@ -12591,19 +15739,93 @@ } } }, - "/document-base-config-sales-channel/{id}": { + "/search/document-base-config": { + "post": { + "tags": [ + "Document Base Config" + ], + "summary": "Search for the Document Base Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentBaseConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config/{id}": { "get": { "tags": [ - "Document Base Config Sales Channel" + "Document Base Config" ], - "summary": "Detailed information about a Document Base Config Sales Channel resource.", + "summary": "Detailed information about a Document Base Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannel", + "operationId": "getDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config_sales_channel", + "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", @@ -12613,7 +15835,7 @@ ], "responses": { "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", + "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -12625,7 +15847,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12634,7 +15856,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } } } } @@ -12649,16 +15879,16 @@ }, "delete": { "tags": [ - "Document Base Config Sales Channel" + "Document Base Config" ], - "summary": "Delete a Document Base Config Sales Channel resource.", + "summary": "Delete a Document Base Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentBaseConfigSalesChannel", + "operationId": "deleteDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config_sales_channel", + "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", @@ -12689,16 +15919,16 @@ }, "patch": { "tags": [ - "Document Base Config Sales Channel" + "Document Base Config" ], - "summary": "Partially update information about a Document Base Config Sales Channel resource.", + "summary": "Partially update information about a Document Base Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentBaseConfigSalesChannel", + "operationId": "updateDocumentBaseConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_base_config_sales_channel", + "description": "Identifier for the document_base_config", "required": true, "schema": { "type": "string", @@ -12716,14 +15946,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document Base Config Sales Channel resource.", + "description": "Partially update information about a Document Base Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" }, "included": { "type": "array", @@ -12737,14 +15967,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } }, "responses": { "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", + "description": "Detail of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -12756,7 +15986,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -12765,7 +15995,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } } } } @@ -12782,14 +16020,14 @@ } } }, - "/document-type": { + "/document-base-config-sales-channel": { "get": { "tags": [ - "Document Type" + "Document Base Config Sales Channel" ], - "summary": "List with basic information of Document Type resources.", + "summary": "List with basic information of Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentTypeList", + "operationId": "getDocumentBaseConfigSalesChannelList", "parameters": [ { "name": "limit", @@ -12818,7 +16056,7 @@ ], "responses": { "200": { - "description": "List of Document Type resources.", + "description": "List of Document Base Config Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12837,7 +16075,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } ] @@ -12851,16 +16089,16 @@ "type": "object", "properties": { "first": { - "example": "/document-type?limit=25" + "example": "/document-base-config-sales-channel?limit=25" }, "last": { - "example": "/document-type?limit=25&page=11" + "example": "/document-base-config-sales-channel?limit=25&page=11" }, "next": { - "example": "/document-type?limit=25&page=4" + "example": "/document-base-config-sales-channel?limit=25&page=4" }, "prev": { - "example": "/document-type?limit=25&page=2" + "example": "/document-base-config-sales-channel?limit=25&page=2" } } } @@ -12881,7 +16119,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12896,11 +16134,11 @@ }, "post": { "tags": [ - "Document Type" + "Document Base Config Sales Channel" ], - "summary": "Create a new Document Type resources.", + "summary": "Create a new Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createDocumentType", + "operationId": "createDocumentBaseConfigSalesChannel", "parameters": [ { "name": "_response", @@ -12922,7 +16160,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" }, "included": { "type": "array", @@ -12936,14 +16174,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of DocumentType", + "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -12955,7 +16193,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -12964,7 +16202,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } } } } @@ -12978,19 +16224,93 @@ } } }, - "/document-type/{id}": { + "/search/document-base-config-sales-channel": { + "post": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Search for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentBaseConfigSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config-sales-channel/{id}": { "get": { "tags": [ - "Document Type" + "Document Base Config Sales Channel" ], - "summary": "Detailed information about a Document Type resource.", + "summary": "Detailed information about a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getDocumentType", + "operationId": "getDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_type", + "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", @@ -13000,7 +16320,7 @@ ], "responses": { "200": { - "description": "Detail of DocumentType", + "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -13012,7 +16332,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -13021,7 +16341,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } } } } @@ -13036,16 +16364,16 @@ }, "delete": { "tags": [ - "Document Type" + "Document Base Config Sales Channel" ], - "summary": "Delete a Document Type resource.", + "summary": "Delete a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteDocumentType", + "operationId": "deleteDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_type", + "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", @@ -13076,16 +16404,16 @@ }, "patch": { "tags": [ - "Document Type" + "Document Base Config Sales Channel" ], - "summary": "Partially update information about a Document Type resource.", + "summary": "Partially update information about a Document Base Config Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateDocumentType", + "operationId": "updateDocumentBaseConfigSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the document_type", + "description": "Identifier for the document_base_config_sales_channel", "required": true, "schema": { "type": "string", @@ -13103,14 +16431,14 @@ } ], "requestBody": { - "description": "Partially update information about a Document Type resource.", + "description": "Partially update information about a Document Base Config Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" }, "included": { "type": "array", @@ -13124,14 +16452,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of DocumentType", + "description": "Detail of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -13143,7 +16471,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DocumentType" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } } @@ -13152,7 +16480,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } } } } @@ -13169,14 +16505,14 @@ } } }, - "/flow": { + "/document-type": { "get": { "tags": [ - "Flow" + "Document Type" ], - "summary": "List with basic information of Flow resources.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlowList", + "summary": "List with basic information of Document Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentTypeList", "parameters": [ { "name": "limit", @@ -13205,7 +16541,7 @@ ], "responses": { "200": { - "description": "List of Flow resources.", + "description": "List of Document Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13224,7 +16560,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } ] @@ -13238,16 +16574,16 @@ "type": "object", "properties": { "first": { - "example": "/flow?limit=25" + "example": "/document-type?limit=25" }, "last": { - "example": "/flow?limit=25&page=11" + "example": "/document-type?limit=25&page=11" }, "next": { - "example": "/flow?limit=25&page=4" + "example": "/document-type?limit=25&page=4" }, "prev": { - "example": "/flow?limit=25&page=2" + "example": "/document-type?limit=25&page=2" } } } @@ -13268,7 +16604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13283,11 +16619,11 @@ }, "post": { "tags": [ - "Flow" + "Document Type" ], - "summary": "Create a new Flow resources.", - "description": "Available since: 6.4.6.0", - "operationId": "createFlow", + "summary": "Create a new Document Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDocumentType", "parameters": [ { "name": "_response", @@ -13309,7 +16645,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" }, "included": { "type": "array", @@ -13323,14 +16659,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { - "description": "Detail of Flow", + "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -13342,7 +16678,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13351,7 +16687,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + } + } } } } @@ -13365,19 +16709,93 @@ } } }, - "/flow/{id}": { + "/search/document-type": { + "post": { + "tags": [ + "Document Type" + ], + "summary": "Search for the Document Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-type/{id}": { "get": { "tags": [ - "Flow" + "Document Type" ], - "summary": "Detailed information about a Flow resource.", - "description": "Available since: 6.4.6.0", - "operationId": "getFlow", + "summary": "Detailed information about a Document Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow", + "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", @@ -13387,7 +16805,7 @@ ], "responses": { "200": { - "description": "Detail of Flow", + "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -13399,7 +16817,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13408,7 +16826,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + } + } } } } @@ -13423,16 +16849,16 @@ }, "delete": { "tags": [ - "Flow" + "Document Type" ], - "summary": "Delete a Flow resource.", - "description": "Available since: 6.4.6.0", - "operationId": "deleteFlow", + "summary": "Delete a Document Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDocumentType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow", + "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", @@ -13463,16 +16889,16 @@ }, "patch": { "tags": [ - "Flow" + "Document Type" ], - "summary": "Partially update information about a Flow resource.", - "description": "Available since: 6.4.6.0", - "operationId": "updateFlow", + "summary": "Partially update information about a Document Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDocumentType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow", + "description": "Identifier for the document_type", "required": true, "schema": { "type": "string", @@ -13490,14 +16916,14 @@ } ], "requestBody": { - "description": "Partially update information about a Flow resource.", + "description": "Partially update information about a Document Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" }, "included": { "type": "array", @@ -13511,14 +16937,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } } }, "responses": { "200": { - "description": "Detail of Flow", + "description": "Detail of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -13530,7 +16956,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Flow" + "$ref": "#/components/schemas/DocumentType" } } } @@ -13539,7 +16965,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Flow" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentType" + } + } } } } @@ -13556,14 +16990,14 @@ } } }, - "/flow-sequence": { + "/flow": { "get": { "tags": [ - "Flow Sequence" + "Flow" ], - "summary": "List with basic information of Flow Sequence resources.", + "summary": "List with basic information of Flow resources.", "description": "Available since: 6.4.6.0", - "operationId": "getFlowSequenceList", + "operationId": "getFlowList", "parameters": [ { "name": "limit", @@ -13592,7 +17026,7 @@ ], "responses": { "200": { - "description": "List of Flow Sequence resources.", + "description": "List of Flow resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13611,7 +17045,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } ] @@ -13625,16 +17059,16 @@ "type": "object", "properties": { "first": { - "example": "/flow-sequence?limit=25" + "example": "/flow?limit=25" }, "last": { - "example": "/flow-sequence?limit=25&page=11" + "example": "/flow?limit=25&page=11" }, "next": { - "example": "/flow-sequence?limit=25&page=4" + "example": "/flow?limit=25&page=4" }, "prev": { - "example": "/flow-sequence?limit=25&page=2" + "example": "/flow?limit=25&page=2" } } } @@ -13655,7 +17089,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } } @@ -13670,11 +17104,11 @@ }, "post": { "tags": [ - "Flow Sequence" + "Flow" ], - "summary": "Create a new Flow Sequence resources.", + "summary": "Create a new Flow resources.", "description": "Available since: 6.4.6.0", - "operationId": "createFlowSequence", + "operationId": "createFlow", "parameters": [ { "name": "_response", @@ -13696,7 +17130,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" }, "included": { "type": "array", @@ -13710,14 +17144,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } } }, "responses": { "200": { - "description": "Detail of FlowSequence", + "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -13729,7 +17163,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } } @@ -13738,7 +17172,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + } + } } } } @@ -13752,19 +17194,93 @@ } } }, - "/flow-sequence/{id}": { + "/search/flow": { + "post": { + "tags": [ + "Flow" + ], + "summary": "Search for the Flow resources.", + "description": "Available since: 6.4.6.0", + "operationId": "searchFlow", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow/{id}": { "get": { "tags": [ - "Flow Sequence" + "Flow" ], - "summary": "Detailed information about a Flow Sequence resource.", + "summary": "Detailed information about a Flow resource.", "description": "Available since: 6.4.6.0", - "operationId": "getFlowSequence", + "operationId": "getFlow", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_sequence", + "description": "Identifier for the flow", "required": true, "schema": { "type": "string", @@ -13774,7 +17290,7 @@ ], "responses": { "200": { - "description": "Detail of FlowSequence", + "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -13786,7 +17302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } } @@ -13795,7 +17311,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + } + } } } } @@ -13810,16 +17334,16 @@ }, "delete": { "tags": [ - "Flow Sequence" + "Flow" ], - "summary": "Delete a Flow Sequence resource.", + "summary": "Delete a Flow resource.", "description": "Available since: 6.4.6.0", - "operationId": "deleteFlowSequence", + "operationId": "deleteFlow", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_sequence", + "description": "Identifier for the flow", "required": true, "schema": { "type": "string", @@ -13850,16 +17374,16 @@ }, "patch": { "tags": [ - "Flow Sequence" + "Flow" ], - "summary": "Partially update information about a Flow Sequence resource.", + "summary": "Partially update information about a Flow resource.", "description": "Available since: 6.4.6.0", - "operationId": "updateFlowSequence", + "operationId": "updateFlow", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_sequence", + "description": "Identifier for the flow", "required": true, "schema": { "type": "string", @@ -13877,14 +17401,14 @@ } ], "requestBody": { - "description": "Partially update information about a Flow Sequence resource.", + "description": "Partially update information about a Flow resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" }, "included": { "type": "array", @@ -13898,14 +17422,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } } }, "responses": { "200": { - "description": "Detail of FlowSequence", + "description": "Detail of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -13917,7 +17441,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/Flow" } } } @@ -13926,7 +17450,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowSequence" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Flow" + } + } } } } @@ -13943,14 +17475,14 @@ } } }, - "/flow-template": { + "/flow-sequence": { "get": { "tags": [ - "Flow Template" + "Flow Sequence" ], - "summary": "List with basic information of Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "getFlowTemplateList", + "summary": "List with basic information of Flow Sequence resources.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlowSequenceList", "parameters": [ { "name": "limit", @@ -13979,7 +17511,7 @@ ], "responses": { "200": { - "description": "List of Flow Template resources.", + "description": "List of Flow Sequence resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13998,7 +17530,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } ] @@ -14012,16 +17544,16 @@ "type": "object", "properties": { "first": { - "example": "/flow-template?limit=25" + "example": "/flow-sequence?limit=25" }, "last": { - "example": "/flow-template?limit=25&page=11" + "example": "/flow-sequence?limit=25&page=11" }, "next": { - "example": "/flow-template?limit=25&page=4" + "example": "/flow-sequence?limit=25&page=4" }, "prev": { - "example": "/flow-template?limit=25&page=2" + "example": "/flow-sequence?limit=25&page=2" } } } @@ -14042,7 +17574,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -14057,11 +17589,11 @@ }, "post": { "tags": [ - "Flow Template" + "Flow Sequence" ], - "summary": "Create a new Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "createFlowTemplate", + "summary": "Create a new Flow Sequence resources.", + "description": "Available since: 6.4.6.0", + "operationId": "createFlowSequence", "parameters": [ { "name": "_response", @@ -14083,7 +17615,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" }, "included": { "type": "array", @@ -14097,14 +17629,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } } }, "responses": { "200": { - "description": "Detail of FlowTemplate", + "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -14116,7 +17648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -14125,7 +17657,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + } + } } } } @@ -14139,19 +17679,93 @@ } } }, - "/flow-template/{id}": { + "/search/flow-sequence": { + "post": { + "tags": [ + "Flow Sequence" + ], + "summary": "Search for the Flow Sequence resources.", + "description": "Available since: 6.4.6.0", + "operationId": "searchFlowSequence", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow-sequence/{id}": { "get": { "tags": [ - "Flow Template" + "Flow Sequence" ], - "summary": "Detailed information about a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "getFlowTemplate", + "summary": "Detailed information about a Flow Sequence resource.", + "description": "Available since: 6.4.6.0", + "operationId": "getFlowSequence", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_template", + "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", @@ -14161,7 +17775,7 @@ ], "responses": { "200": { - "description": "Detail of FlowTemplate", + "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -14173,7 +17787,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -14182,7 +17796,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + } + } } } } @@ -14197,16 +17819,16 @@ }, "delete": { "tags": [ - "Flow Template" + "Flow Sequence" ], - "summary": "Delete a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "deleteFlowTemplate", + "summary": "Delete a Flow Sequence resource.", + "description": "Available since: 6.4.6.0", + "operationId": "deleteFlowSequence", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_template", + "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", @@ -14237,16 +17859,16 @@ }, "patch": { "tags": [ - "Flow Template" + "Flow Sequence" ], - "summary": "Partially update information about a Flow Template resource.", - "description": "Available since: 6.4.18.0", - "operationId": "updateFlowTemplate", + "summary": "Partially update information about a Flow Sequence resource.", + "description": "Available since: 6.4.6.0", + "operationId": "updateFlowSequence", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the flow_template", + "description": "Identifier for the flow_sequence", "required": true, "schema": { "type": "string", @@ -14264,14 +17886,14 @@ } ], "requestBody": { - "description": "Partially update information about a Flow Template resource.", + "description": "Partially update information about a Flow Sequence resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" }, "included": { "type": "array", @@ -14285,14 +17907,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } } }, "responses": { "200": { - "description": "Detail of FlowTemplate", + "description": "Detail of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -14304,7 +17926,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/FlowTemplate" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -14313,7 +17935,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/FlowTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/FlowSequence" + } + } } } } @@ -14330,14 +17960,14 @@ } } }, - "/import-export-file": { + "/flow-template": { "get": { "tags": [ - "Import Export File" + "Flow Template" ], - "summary": "List with basic information of Import Export File resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportFileList", + "summary": "List with basic information of Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "getFlowTemplateList", "parameters": [ { "name": "limit", @@ -14366,7 +17996,7 @@ ], "responses": { "200": { - "description": "List of Import Export File resources.", + "description": "List of Flow Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14385,7 +18015,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } ] @@ -14399,16 +18029,16 @@ "type": "object", "properties": { "first": { - "example": "/import-export-file?limit=25" + "example": "/flow-template?limit=25" }, "last": { - "example": "/import-export-file?limit=25&page=11" + "example": "/flow-template?limit=25&page=11" }, "next": { - "example": "/import-export-file?limit=25&page=4" + "example": "/flow-template?limit=25&page=4" }, "prev": { - "example": "/import-export-file?limit=25&page=2" + "example": "/flow-template?limit=25&page=2" } } } @@ -14429,7 +18059,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14444,11 +18074,11 @@ }, "post": { "tags": [ - "Import Export File" + "Flow Template" ], - "summary": "Create a new Import Export File resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createImportExportFile", + "summary": "Create a new Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "createFlowTemplate", "parameters": [ { "name": "_response", @@ -14470,7 +18100,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" }, "included": { "type": "array", @@ -14484,14 +18114,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } } }, "responses": { "200": { - "description": "Detail of ImportExportFile", + "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -14503,7 +18133,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14512,7 +18142,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + } + } } } } @@ -14526,19 +18164,93 @@ } } }, - "/import-export-file/{id}": { + "/search/flow-template": { + "post": { + "tags": [ + "Flow Template" + ], + "summary": "Search for the Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "searchFlowTemplate", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/flow-template/{id}": { "get": { "tags": [ - "Import Export File" + "Flow Template" ], - "summary": "Detailed information about a Import Export File resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getImportExportFile", + "summary": "Detailed information about a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "getFlowTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_file", + "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", @@ -14548,7 +18260,7 @@ ], "responses": { "200": { - "description": "Detail of ImportExportFile", + "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -14560,7 +18272,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14569,7 +18281,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + } + } } } } @@ -14584,16 +18304,16 @@ }, "delete": { "tags": [ - "Import Export File" + "Flow Template" ], - "summary": "Delete a Import Export File resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportFile", + "summary": "Delete a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "deleteFlowTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_file", + "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", @@ -14624,16 +18344,16 @@ }, "patch": { "tags": [ - "Import Export File" + "Flow Template" ], - "summary": "Partially update information about a Import Export File resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportFile", + "summary": "Partially update information about a Flow Template resource.", + "description": "Available since: 6.4.18.0", + "operationId": "updateFlowTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_file", + "description": "Identifier for the flow_template", "required": true, "schema": { "type": "string", @@ -14651,14 +18371,14 @@ } ], "requestBody": { - "description": "Partially update information about a Import Export File resource.", + "description": "Partially update information about a Flow Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" }, "included": { "type": "array", @@ -14672,14 +18392,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } } }, "responses": { "200": { - "description": "Detail of ImportExportFile", + "description": "Detail of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -14691,7 +18411,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportFile" + "$ref": "#/components/schemas/FlowTemplate" } } } @@ -14700,7 +18420,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportFile" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/FlowTemplate" + } + } } } } @@ -14717,14 +18445,14 @@ } } }, - "/import-export-log": { + "/import-export-file": { "get": { "tags": [ - "Import Export Log" + "Import Export File" ], - "summary": "List with basic information of Import Export Log resources.", + "summary": "List with basic information of Import Export File resources.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportLogList", + "operationId": "getImportExportFileList", "parameters": [ { "name": "limit", @@ -14753,7 +18481,7 @@ ], "responses": { "200": { - "description": "List of Import Export Log resources.", + "description": "List of Import Export File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14772,7 +18500,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } ] @@ -14786,16 +18514,16 @@ "type": "object", "properties": { "first": { - "example": "/import-export-log?limit=25" + "example": "/import-export-file?limit=25" }, "last": { - "example": "/import-export-log?limit=25&page=11" + "example": "/import-export-file?limit=25&page=11" }, "next": { - "example": "/import-export-log?limit=25&page=4" + "example": "/import-export-file?limit=25&page=4" }, "prev": { - "example": "/import-export-log?limit=25&page=2" + "example": "/import-export-file?limit=25&page=2" } } } @@ -14816,7 +18544,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14831,11 +18559,11 @@ }, "post": { "tags": [ - "Import Export Log" + "Import Export File" ], - "summary": "Create a new Import Export Log resources.", + "summary": "Create a new Import Export File resources.", "description": "Available since: 6.0.0.0", - "operationId": "createImportExportLog", + "operationId": "createImportExportFile", "parameters": [ { "name": "_response", @@ -14857,7 +18585,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" }, "included": { "type": "array", @@ -14871,14 +18599,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } } }, "responses": { "200": { - "description": "Detail of ImportExportLog", + "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -14890,7 +18618,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14899,7 +18627,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + } + } } } } @@ -14913,19 +18649,93 @@ } } }, - "/import-export-log/{id}": { + "/search/import-export-file": { + "post": { + "tags": [ + "Import Export File" + ], + "summary": "Search for the Import Export File resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchImportExportFile", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-file/{id}": { "get": { "tags": [ - "Import Export Log" + "Import Export File" ], - "summary": "Detailed information about a Import Export Log resource.", + "summary": "Detailed information about a Import Export File resource.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportLog", + "operationId": "getImportExportFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_log", + "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", @@ -14935,7 +18745,7 @@ ], "responses": { "200": { - "description": "Detail of ImportExportLog", + "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -14947,7 +18757,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -14956,7 +18766,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + } + } } } } @@ -14971,16 +18789,16 @@ }, "delete": { "tags": [ - "Import Export Log" + "Import Export File" ], - "summary": "Delete a Import Export Log resource.", + "summary": "Delete a Import Export File resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportLog", + "operationId": "deleteImportExportFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_log", + "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", @@ -15011,16 +18829,16 @@ }, "patch": { "tags": [ - "Import Export Log" + "Import Export File" ], - "summary": "Partially update information about a Import Export Log resource.", + "summary": "Partially update information about a Import Export File resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportLog", + "operationId": "updateImportExportFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_log", + "description": "Identifier for the import_export_file", "required": true, "schema": { "type": "string", @@ -15038,14 +18856,14 @@ } ], "requestBody": { - "description": "Partially update information about a Import Export Log resource.", + "description": "Partially update information about a Import Export File resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" }, "included": { "type": "array", @@ -15059,14 +18877,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } } }, "responses": { "200": { - "description": "Detail of ImportExportLog", + "description": "Detail of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -15078,7 +18896,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/ImportExportFile" } } } @@ -15087,7 +18905,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportLog" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportFile" + } + } } } } @@ -15104,14 +18930,14 @@ } } }, - "/import-export-profile": { + "/import-export-log": { "get": { "tags": [ - "Import Export Profile" + "Import Export Log" ], - "summary": "List with basic information of Import Export Profile resources.", + "summary": "List with basic information of Import Export Log resources.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportProfileList", + "operationId": "getImportExportLogList", "parameters": [ { "name": "limit", @@ -15140,7 +18966,7 @@ ], "responses": { "200": { - "description": "List of Import Export Profile resources.", + "description": "List of Import Export Log resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15159,7 +18985,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } ] @@ -15173,16 +18999,16 @@ "type": "object", "properties": { "first": { - "example": "/import-export-profile?limit=25" + "example": "/import-export-log?limit=25" }, "last": { - "example": "/import-export-profile?limit=25&page=11" + "example": "/import-export-log?limit=25&page=11" }, "next": { - "example": "/import-export-profile?limit=25&page=4" + "example": "/import-export-log?limit=25&page=4" }, "prev": { - "example": "/import-export-profile?limit=25&page=2" + "example": "/import-export-log?limit=25&page=2" } } } @@ -15203,7 +19029,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -15218,11 +19044,11 @@ }, "post": { "tags": [ - "Import Export Profile" + "Import Export Log" ], - "summary": "Create a new Import Export Profile resources.", + "summary": "Create a new Import Export Log resources.", "description": "Available since: 6.0.0.0", - "operationId": "createImportExportProfile", + "operationId": "createImportExportLog", "parameters": [ { "name": "_response", @@ -15244,7 +19070,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" }, "included": { "type": "array", @@ -15258,14 +19084,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } } }, "responses": { "200": { - "description": "Detail of ImportExportProfile", + "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -15277,7 +19103,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -15286,7 +19112,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + } + } } } } @@ -15300,19 +19134,93 @@ } } }, - "/import-export-profile/{id}": { + "/search/import-export-log": { + "post": { + "tags": [ + "Import Export Log" + ], + "summary": "Search for the Import Export Log resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchImportExportLog", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-log/{id}": { "get": { "tags": [ - "Import Export Profile" + "Import Export Log" ], - "summary": "Detailed information about a Import Export Profile resource.", + "summary": "Detailed information about a Import Export Log resource.", "description": "Available since: 6.0.0.0", - "operationId": "getImportExportProfile", + "operationId": "getImportExportLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_profile", + "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", @@ -15322,7 +19230,7 @@ ], "responses": { "200": { - "description": "Detail of ImportExportProfile", + "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -15334,7 +19242,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -15343,7 +19251,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + } + } } } } @@ -15358,16 +19274,16 @@ }, "delete": { "tags": [ - "Import Export Profile" + "Import Export Log" ], - "summary": "Delete a Import Export Profile resource.", + "summary": "Delete a Import Export Log resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteImportExportProfile", + "operationId": "deleteImportExportLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_profile", + "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", @@ -15398,16 +19314,16 @@ }, "patch": { "tags": [ - "Import Export Profile" + "Import Export Log" ], - "summary": "Partially update information about a Import Export Profile resource.", + "summary": "Partially update information about a Import Export Log resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateImportExportProfile", + "operationId": "updateImportExportLog", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the import_export_profile", + "description": "Identifier for the import_export_log", "required": true, "schema": { "type": "string", @@ -15425,14 +19341,14 @@ } ], "requestBody": { - "description": "Partially update information about a Import Export Profile resource.", + "description": "Partially update information about a Import Export Log resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" }, "included": { "type": "array", @@ -15446,14 +19362,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } } }, "responses": { "200": { - "description": "Detail of ImportExportProfile", + "description": "Detail of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -15465,7 +19381,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ImportExportProfile" + "$ref": "#/components/schemas/ImportExportLog" } } } @@ -15474,7 +19390,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ImportExportProfile" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportLog" + } + } } } } @@ -15491,14 +19415,14 @@ } } }, - "/integration": { + "/import-export-profile": { "get": { "tags": [ - "Integration" + "Import Export Profile" ], - "summary": "List with basic information of Integration resources.", + "summary": "List with basic information of Import Export Profile resources.", "description": "Available since: 6.0.0.0", - "operationId": "getIntegrationList", + "operationId": "getImportExportProfileList", "parameters": [ { "name": "limit", @@ -15527,7 +19451,7 @@ ], "responses": { "200": { - "description": "List of Integration resources.", + "description": "List of Import Export Profile resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15546,7 +19470,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } ] @@ -15560,16 +19484,16 @@ "type": "object", "properties": { "first": { - "example": "/integration?limit=25" + "example": "/import-export-profile?limit=25" }, "last": { - "example": "/integration?limit=25&page=11" + "example": "/import-export-profile?limit=25&page=11" }, "next": { - "example": "/integration?limit=25&page=4" + "example": "/import-export-profile?limit=25&page=4" }, "prev": { - "example": "/integration?limit=25&page=2" + "example": "/import-export-profile?limit=25&page=2" } } } @@ -15590,7 +19514,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15605,11 +19529,11 @@ }, "post": { "tags": [ - "Integration" + "Import Export Profile" ], - "summary": "Create a new Integration resources.", + "summary": "Create a new Import Export Profile resources.", "description": "Available since: 6.0.0.0", - "operationId": "createIntegration", + "operationId": "createImportExportProfile", "parameters": [ { "name": "_response", @@ -15631,7 +19555,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" }, "included": { "type": "array", @@ -15645,14 +19569,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } } }, "responses": { "200": { - "description": "Detail of Integration", + "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -15664,7 +19588,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15673,7 +19597,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } } } } @@ -15687,19 +19619,93 @@ } } }, - "/integration/{id}": { + "/search/import-export-profile": { + "post": { + "tags": [ + "Import Export Profile" + ], + "summary": "Search for the Import Export Profile resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchImportExportProfile", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/import-export-profile/{id}": { "get": { "tags": [ - "Integration" + "Import Export Profile" ], - "summary": "Detailed information about a Integration resource.", + "summary": "Detailed information about a Import Export Profile resource.", "description": "Available since: 6.0.0.0", - "operationId": "getIntegration", + "operationId": "getImportExportProfile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the integration", + "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", @@ -15709,7 +19715,7 @@ ], "responses": { "200": { - "description": "Detail of Integration", + "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -15721,7 +19727,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15730,7 +19736,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } } } } @@ -15745,16 +19759,16 @@ }, "delete": { "tags": [ - "Integration" + "Import Export Profile" ], - "summary": "Delete a Integration resource.", + "summary": "Delete a Import Export Profile resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteIntegration", + "operationId": "deleteImportExportProfile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the integration", + "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", @@ -15785,16 +19799,16 @@ }, "patch": { "tags": [ - "Integration" + "Import Export Profile" ], - "summary": "Partially update information about a Integration resource.", + "summary": "Partially update information about a Import Export Profile resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateIntegration", + "operationId": "updateImportExportProfile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the integration", + "description": "Identifier for the import_export_profile", "required": true, "schema": { "type": "string", @@ -15812,14 +19826,14 @@ } ], "requestBody": { - "description": "Partially update information about a Integration resource.", + "description": "Partially update information about a Import Export Profile resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" }, "included": { "type": "array", @@ -15833,14 +19847,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } } }, "responses": { "200": { - "description": "Detail of Integration", + "description": "Detail of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -15852,7 +19866,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -15861,7 +19875,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Integration" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } } } } @@ -15878,14 +19900,14 @@ } } }, - "/landing-page": { + "/integration": { "get": { "tags": [ - "Landing Page" + "Integration" ], - "summary": "List with basic information of Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "getLandingPageList", + "summary": "List with basic information of Integration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getIntegrationList", "parameters": [ { "name": "limit", @@ -15914,7 +19936,7 @@ ], "responses": { "200": { - "description": "List of Landing Page resources.", + "description": "List of Integration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15933,7 +19955,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } ] @@ -15947,16 +19969,16 @@ "type": "object", "properties": { "first": { - "example": "/landing-page?limit=25" + "example": "/integration?limit=25" }, "last": { - "example": "/landing-page?limit=25&page=11" + "example": "/integration?limit=25&page=11" }, "next": { - "example": "/landing-page?limit=25&page=4" + "example": "/integration?limit=25&page=4" }, "prev": { - "example": "/landing-page?limit=25&page=2" + "example": "/integration?limit=25&page=2" } } } @@ -15977,7 +19999,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } } @@ -15992,11 +20014,11 @@ }, "post": { "tags": [ - "Landing Page" + "Integration" ], - "summary": "Create a new Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "createLandingPage", + "summary": "Create a new Integration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createIntegration", "parameters": [ { "name": "_response", @@ -16018,7 +20040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" }, "included": { "type": "array", @@ -16032,14 +20054,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } } }, "responses": { "200": { - "description": "Detail of LandingPage", + "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -16051,7 +20073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } } @@ -16060,7 +20082,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + } + } } } } @@ -16074,19 +20104,93 @@ } } }, - "/landing-page/{id}": { + "/search/integration": { + "post": { + "tags": [ + "Integration" + ], + "summary": "Search for the Integration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchIntegration", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/integration/{id}": { "get": { "tags": [ - "Landing Page" + "Integration" ], - "summary": "Detailed information about a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "getLandingPage", + "summary": "Detailed information about a Integration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getIntegration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the landing_page", + "description": "Identifier for the integration", "required": true, "schema": { "type": "string", @@ -16096,7 +20200,7 @@ ], "responses": { "200": { - "description": "Detail of LandingPage", + "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -16108,7 +20212,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } } @@ -16117,7 +20221,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + } + } } } } @@ -16132,16 +20244,16 @@ }, "delete": { "tags": [ - "Landing Page" + "Integration" ], - "summary": "Delete a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "deleteLandingPage", + "summary": "Delete a Integration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteIntegration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the landing_page", + "description": "Identifier for the integration", "required": true, "schema": { "type": "string", @@ -16172,16 +20284,16 @@ }, "patch": { "tags": [ - "Landing Page" + "Integration" ], - "summary": "Partially update information about a Landing Page resource.", - "description": "Available since: 6.4.0.0", - "operationId": "updateLandingPage", + "summary": "Partially update information about a Integration resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateIntegration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the landing_page", + "description": "Identifier for the integration", "required": true, "schema": { "type": "string", @@ -16199,14 +20311,14 @@ } ], "requestBody": { - "description": "Partially update information about a Landing Page resource.", + "description": "Partially update information about a Integration resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" }, "included": { "type": "array", @@ -16220,14 +20332,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } } }, "responses": { "200": { - "description": "Detail of LandingPage", + "description": "Detail of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -16239,7 +20351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/Integration" } } } @@ -16248,7 +20360,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LandingPage" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Integration" + } + } } } } @@ -16265,14 +20385,14 @@ } } }, - "/language": { + "/landing-page": { "get": { "tags": [ - "Language" + "Landing Page" ], - "summary": "List with basic information of Language resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getLanguageList", + "summary": "List with basic information of Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "getLandingPageList", "parameters": [ { "name": "limit", @@ -16301,7 +20421,7 @@ ], "responses": { "200": { - "description": "List of Language resources.", + "description": "List of Landing Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16320,7 +20440,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } ] @@ -16334,16 +20454,16 @@ "type": "object", "properties": { "first": { - "example": "/language?limit=25" + "example": "/landing-page?limit=25" }, "last": { - "example": "/language?limit=25&page=11" + "example": "/landing-page?limit=25&page=11" }, "next": { - "example": "/language?limit=25&page=4" + "example": "/landing-page?limit=25&page=4" }, "prev": { - "example": "/language?limit=25&page=2" + "example": "/landing-page?limit=25&page=2" } } } @@ -16364,7 +20484,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16379,11 +20499,11 @@ }, "post": { "tags": [ - "Language" + "Landing Page" ], - "summary": "Create a new Language resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createLanguage", + "summary": "Create a new Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "createLandingPage", "parameters": [ { "name": "_response", @@ -16405,7 +20525,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" }, "included": { "type": "array", @@ -16419,14 +20539,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } } }, "responses": { "200": { - "description": "Detail of Language", + "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -16438,7 +20558,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16447,7 +20567,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + } + } } } } @@ -16461,19 +20589,93 @@ } } }, - "/language/{id}": { + "/search/landing-page": { + "post": { + "tags": [ + "Landing Page" + ], + "summary": "Search for the Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "searchLandingPage", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/landing-page/{id}": { "get": { "tags": [ - "Language" + "Landing Page" ], - "summary": "Detailed information about a Language resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getLanguage", + "summary": "Detailed information about a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "getLandingPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the language", + "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", @@ -16483,7 +20685,7 @@ ], "responses": { "200": { - "description": "Detail of Language", + "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -16495,7 +20697,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16504,7 +20706,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + } + } } } } @@ -16519,16 +20729,16 @@ }, "delete": { "tags": [ - "Language" + "Landing Page" ], - "summary": "Delete a Language resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteLanguage", + "summary": "Delete a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "deleteLandingPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the language", + "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", @@ -16559,16 +20769,16 @@ }, "patch": { "tags": [ - "Language" + "Landing Page" ], - "summary": "Partially update information about a Language resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateLanguage", + "summary": "Partially update information about a Landing Page resource.", + "description": "Available since: 6.4.0.0", + "operationId": "updateLandingPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the language", + "description": "Identifier for the landing_page", "required": true, "schema": { "type": "string", @@ -16586,14 +20796,14 @@ } ], "requestBody": { - "description": "Partially update information about a Language resource.", + "description": "Partially update information about a Landing Page resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" }, "included": { "type": "array", @@ -16607,14 +20817,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } } }, "responses": { "200": { - "description": "Detail of Language", + "description": "Detail of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -16626,7 +20836,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/LandingPage" } } } @@ -16635,7 +20845,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Language" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/LandingPage" + } + } } } } @@ -16652,14 +20870,14 @@ } } }, - "/locale": { + "/language": { "get": { "tags": [ - "Locale" + "Language" ], - "summary": "List with basic information of Locale resources.", + "summary": "List with basic information of Language resources.", "description": "Available since: 6.0.0.0", - "operationId": "getLocaleList", + "operationId": "getLanguageList", "parameters": [ { "name": "limit", @@ -16688,7 +20906,7 @@ ], "responses": { "200": { - "description": "List of Locale resources.", + "description": "List of Language resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16707,7 +20925,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } ] @@ -16721,16 +20939,16 @@ "type": "object", "properties": { "first": { - "example": "/locale?limit=25" + "example": "/language?limit=25" }, "last": { - "example": "/locale?limit=25&page=11" + "example": "/language?limit=25&page=11" }, "next": { - "example": "/locale?limit=25&page=4" + "example": "/language?limit=25&page=4" }, "prev": { - "example": "/locale?limit=25&page=2" + "example": "/language?limit=25&page=2" } } } @@ -16751,7 +20969,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } } @@ -16766,11 +20984,11 @@ }, "post": { "tags": [ - "Locale" + "Language" ], - "summary": "Create a new Locale resources.", + "summary": "Create a new Language resources.", "description": "Available since: 6.0.0.0", - "operationId": "createLocale", + "operationId": "createLanguage", "parameters": [ { "name": "_response", @@ -16792,7 +21010,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" }, "included": { "type": "array", @@ -16806,14 +21024,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } } }, "responses": { "200": { - "description": "Detail of Locale", + "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { @@ -16825,7 +21043,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } } @@ -16834,7 +21052,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + } + } } } } @@ -16848,19 +21074,93 @@ } } }, - "/locale/{id}": { + "/search/language": { + "post": { + "tags": [ + "Language" + ], + "summary": "Search for the Language resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchLanguage", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/language/{id}": { "get": { "tags": [ - "Locale" + "Language" ], - "summary": "Detailed information about a Locale resource.", + "summary": "Detailed information about a Language resource.", "description": "Available since: 6.0.0.0", - "operationId": "getLocale", + "operationId": "getLanguage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the locale", + "description": "Identifier for the language", "required": true, "schema": { "type": "string", @@ -16870,7 +21170,7 @@ ], "responses": { "200": { - "description": "Detail of Locale", + "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { @@ -16882,7 +21182,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } } @@ -16891,7 +21191,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + } + } } } } @@ -16906,16 +21214,16 @@ }, "delete": { "tags": [ - "Locale" + "Language" ], - "summary": "Delete a Locale resource.", + "summary": "Delete a Language resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteLocale", + "operationId": "deleteLanguage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the locale", + "description": "Identifier for the language", "required": true, "schema": { "type": "string", @@ -16946,16 +21254,16 @@ }, "patch": { "tags": [ - "Locale" + "Language" ], - "summary": "Partially update information about a Locale resource.", + "summary": "Partially update information about a Language resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateLocale", + "operationId": "updateLanguage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the locale", + "description": "Identifier for the language", "required": true, "schema": { "type": "string", @@ -16973,14 +21281,14 @@ } ], "requestBody": { - "description": "Partially update information about a Locale resource.", + "description": "Partially update information about a Language resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" }, "included": { "type": "array", @@ -16994,14 +21302,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } } }, "responses": { "200": { - "description": "Detail of Locale", + "description": "Detail of Language", "content": { "application/vnd.api+json": { "schema": { @@ -17013,7 +21321,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Language" } } } @@ -17022,7 +21330,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Locale" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Language" + } + } } } } @@ -17039,14 +21355,14 @@ } } }, - "/log-entry": { + "/locale": { "get": { "tags": [ - "Log Entry" + "Locale" ], - "summary": "List with basic information of Log Entry resources.", + "summary": "List with basic information of Locale resources.", "description": "Available since: 6.0.0.0", - "operationId": "getLogEntryList", + "operationId": "getLocaleList", "parameters": [ { "name": "limit", @@ -17075,7 +21391,7 @@ ], "responses": { "200": { - "description": "List of Log Entry resources.", + "description": "List of Locale resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17094,7 +21410,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } ] @@ -17108,16 +21424,16 @@ "type": "object", "properties": { "first": { - "example": "/log-entry?limit=25" + "example": "/locale?limit=25" }, "last": { - "example": "/log-entry?limit=25&page=11" + "example": "/locale?limit=25&page=11" }, "next": { - "example": "/log-entry?limit=25&page=4" + "example": "/locale?limit=25&page=4" }, "prev": { - "example": "/log-entry?limit=25&page=2" + "example": "/locale?limit=25&page=2" } } } @@ -17138,7 +21454,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } } @@ -17153,11 +21469,11 @@ }, "post": { "tags": [ - "Log Entry" + "Locale" ], - "summary": "Create a new Log Entry resources.", + "summary": "Create a new Locale resources.", "description": "Available since: 6.0.0.0", - "operationId": "createLogEntry", + "operationId": "createLocale", "parameters": [ { "name": "_response", @@ -17179,7 +21495,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" }, "included": { "type": "array", @@ -17193,14 +21509,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } } }, "responses": { "200": { - "description": "Detail of LogEntry", + "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -17212,7 +21528,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } } @@ -17221,7 +21537,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + } + } } } } @@ -17235,19 +21559,93 @@ } } }, - "/log-entry/{id}": { + "/search/locale": { + "post": { + "tags": [ + "Locale" + ], + "summary": "Search for the Locale resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchLocale", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/locale/{id}": { "get": { "tags": [ - "Log Entry" + "Locale" ], - "summary": "Detailed information about a Log Entry resource.", + "summary": "Detailed information about a Locale resource.", "description": "Available since: 6.0.0.0", - "operationId": "getLogEntry", + "operationId": "getLocale", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the log_entry", + "description": "Identifier for the locale", "required": true, "schema": { "type": "string", @@ -17257,7 +21655,7 @@ ], "responses": { "200": { - "description": "Detail of LogEntry", + "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -17269,7 +21667,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } } @@ -17278,7 +21676,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + } + } } } } @@ -17293,16 +21699,16 @@ }, "delete": { "tags": [ - "Log Entry" + "Locale" ], - "summary": "Delete a Log Entry resource.", + "summary": "Delete a Locale resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteLogEntry", + "operationId": "deleteLocale", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the log_entry", + "description": "Identifier for the locale", "required": true, "schema": { "type": "string", @@ -17333,16 +21739,16 @@ }, "patch": { "tags": [ - "Log Entry" + "Locale" ], - "summary": "Partially update information about a Log Entry resource.", + "summary": "Partially update information about a Locale resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateLogEntry", + "operationId": "updateLocale", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the log_entry", + "description": "Identifier for the locale", "required": true, "schema": { "type": "string", @@ -17360,14 +21766,14 @@ } ], "requestBody": { - "description": "Partially update information about a Log Entry resource.", + "description": "Partially update information about a Locale resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" }, "included": { "type": "array", @@ -17381,14 +21787,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } } }, "responses": { "200": { - "description": "Detail of LogEntry", + "description": "Detail of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -17400,7 +21806,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/LogEntry" + "$ref": "#/components/schemas/Locale" } } } @@ -17409,7 +21815,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/LogEntry" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Locale" + } + } } } } @@ -17426,14 +21840,14 @@ } } }, - "/mail-header-footer": { + "/log-entry": { "get": { "tags": [ - "Mail Header Footer" + "Log Entry" ], - "summary": "List with basic information of Mail Header Footer resources.", + "summary": "List with basic information of Log Entry resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMailHeaderFooterList", + "operationId": "getLogEntryList", "parameters": [ { "name": "limit", @@ -17462,7 +21876,7 @@ ], "responses": { "200": { - "description": "List of Mail Header Footer resources.", + "description": "List of Log Entry resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17481,7 +21895,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } ] @@ -17495,16 +21909,16 @@ "type": "object", "properties": { "first": { - "example": "/mail-header-footer?limit=25" + "example": "/log-entry?limit=25" }, "last": { - "example": "/mail-header-footer?limit=25&page=11" + "example": "/log-entry?limit=25&page=11" }, "next": { - "example": "/mail-header-footer?limit=25&page=4" + "example": "/log-entry?limit=25&page=4" }, "prev": { - "example": "/mail-header-footer?limit=25&page=2" + "example": "/log-entry?limit=25&page=2" } } } @@ -17525,7 +21939,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17540,11 +21954,11 @@ }, "post": { "tags": [ - "Mail Header Footer" + "Log Entry" ], - "summary": "Create a new Mail Header Footer resources.", + "summary": "Create a new Log Entry resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMailHeaderFooter", + "operationId": "createLogEntry", "parameters": [ { "name": "_response", @@ -17566,7 +21980,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" }, "included": { "type": "array", @@ -17580,14 +21994,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } } }, "responses": { "200": { - "description": "Detail of MailHeaderFooter", + "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -17599,7 +22013,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17608,7 +22022,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + } + } } } } @@ -17622,19 +22044,93 @@ } } }, - "/mail-header-footer/{id}": { + "/search/log-entry": { + "post": { + "tags": [ + "Log Entry" + ], + "summary": "Search for the Log Entry resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchLogEntry", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/log-entry/{id}": { "get": { "tags": [ - "Mail Header Footer" + "Log Entry" ], - "summary": "Detailed information about a Mail Header Footer resource.", + "summary": "Detailed information about a Log Entry resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMailHeaderFooter", + "operationId": "getLogEntry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_header_footer", + "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", @@ -17644,7 +22140,7 @@ ], "responses": { "200": { - "description": "Detail of MailHeaderFooter", + "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -17656,7 +22152,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17665,7 +22161,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + } + } } } } @@ -17680,16 +22184,16 @@ }, "delete": { "tags": [ - "Mail Header Footer" + "Log Entry" ], - "summary": "Delete a Mail Header Footer resource.", + "summary": "Delete a Log Entry resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMailHeaderFooter", + "operationId": "deleteLogEntry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_header_footer", + "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", @@ -17720,16 +22224,16 @@ }, "patch": { "tags": [ - "Mail Header Footer" + "Log Entry" ], - "summary": "Partially update information about a Mail Header Footer resource.", + "summary": "Partially update information about a Log Entry resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMailHeaderFooter", + "operationId": "updateLogEntry", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_header_footer", + "description": "Identifier for the log_entry", "required": true, "schema": { "type": "string", @@ -17747,14 +22251,14 @@ } ], "requestBody": { - "description": "Partially update information about a Mail Header Footer resource.", + "description": "Partially update information about a Log Entry resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" }, "included": { "type": "array", @@ -17768,14 +22272,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } } }, "responses": { "200": { - "description": "Detail of MailHeaderFooter", + "description": "Detail of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -17787,7 +22291,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailHeaderFooter" + "$ref": "#/components/schemas/LogEntry" } } } @@ -17796,7 +22300,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailHeaderFooter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/LogEntry" + } + } } } } @@ -17813,14 +22325,14 @@ } } }, - "/mail-template": { + "/mail-header-footer": { "get": { "tags": [ - "Mail Template" + "Mail Header Footer" ], - "summary": "List with basic information of Mail Template resources.", + "summary": "List with basic information of Mail Header Footer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateList", + "operationId": "getMailHeaderFooterList", "parameters": [ { "name": "limit", @@ -17849,7 +22361,7 @@ ], "responses": { "200": { - "description": "List of Mail Template resources.", + "description": "List of Mail Header Footer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17868,7 +22380,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } ] @@ -17882,16 +22394,16 @@ "type": "object", "properties": { "first": { - "example": "/mail-template?limit=25" + "example": "/mail-header-footer?limit=25" }, "last": { - "example": "/mail-template?limit=25&page=11" + "example": "/mail-header-footer?limit=25&page=11" }, "next": { - "example": "/mail-template?limit=25&page=4" + "example": "/mail-header-footer?limit=25&page=4" }, "prev": { - "example": "/mail-template?limit=25&page=2" + "example": "/mail-header-footer?limit=25&page=2" } } } @@ -17912,7 +22424,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17927,11 +22439,11 @@ }, "post": { "tags": [ - "Mail Template" + "Mail Header Footer" ], - "summary": "Create a new Mail Template resources.", + "summary": "Create a new Mail Header Footer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMailTemplate", + "operationId": "createMailHeaderFooter", "parameters": [ { "name": "_response", @@ -17953,7 +22465,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" }, "included": { "type": "array", @@ -17967,14 +22479,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } } }, "responses": { "200": { - "description": "Detail of MailTemplate", + "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -17986,7 +22498,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -17995,7 +22507,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } } } } @@ -18009,19 +22529,93 @@ } } }, - "/mail-template/{id}": { + "/search/mail-header-footer": { + "post": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Search for the Mail Header Footer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMailHeaderFooter", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-header-footer/{id}": { "get": { "tags": [ - "Mail Template" + "Mail Header Footer" ], - "summary": "Detailed information about a Mail Template resource.", + "summary": "Detailed information about a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplate", + "operationId": "getMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template", + "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", @@ -18031,7 +22625,7 @@ ], "responses": { "200": { - "description": "Detail of MailTemplate", + "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -18043,7 +22637,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -18052,7 +22646,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } } } } @@ -18067,16 +22669,16 @@ }, "delete": { "tags": [ - "Mail Template" + "Mail Header Footer" ], - "summary": "Delete a Mail Template resource.", + "summary": "Delete a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMailTemplate", + "operationId": "deleteMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template", + "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", @@ -18107,16 +22709,16 @@ }, "patch": { "tags": [ - "Mail Template" + "Mail Header Footer" ], - "summary": "Partially update information about a Mail Template resource.", + "summary": "Partially update information about a Mail Header Footer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMailTemplate", + "operationId": "updateMailHeaderFooter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template", + "description": "Identifier for the mail_header_footer", "required": true, "schema": { "type": "string", @@ -18134,14 +22736,14 @@ } ], "requestBody": { - "description": "Partially update information about a Mail Template resource.", + "description": "Partially update information about a Mail Header Footer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" }, "included": { "type": "array", @@ -18155,14 +22757,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } } }, "responses": { "200": { - "description": "Detail of MailTemplate", + "description": "Detail of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -18174,7 +22776,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MailHeaderFooter" } } } @@ -18183,7 +22785,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } } } } @@ -18200,14 +22810,14 @@ } } }, - "/mail-template-type": { + "/mail-template": { "get": { "tags": [ - "Mail Template Type" + "Mail Template" ], - "summary": "List with basic information of Mail Template Type resources.", + "summary": "List with basic information of Mail Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateTypeList", + "operationId": "getMailTemplateList", "parameters": [ { "name": "limit", @@ -18236,7 +22846,7 @@ ], "responses": { "200": { - "description": "List of Mail Template Type resources.", + "description": "List of Mail Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18255,7 +22865,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } ] @@ -18269,16 +22879,16 @@ "type": "object", "properties": { "first": { - "example": "/mail-template-type?limit=25" + "example": "/mail-template?limit=25" }, "last": { - "example": "/mail-template-type?limit=25&page=11" + "example": "/mail-template?limit=25&page=11" }, "next": { - "example": "/mail-template-type?limit=25&page=4" + "example": "/mail-template?limit=25&page=4" }, "prev": { - "example": "/mail-template-type?limit=25&page=2" + "example": "/mail-template?limit=25&page=2" } } } @@ -18299,7 +22909,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18314,11 +22924,11 @@ }, "post": { "tags": [ - "Mail Template Type" + "Mail Template" ], - "summary": "Create a new Mail Template Type resources.", + "summary": "Create a new Mail Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMailTemplateType", + "operationId": "createMailTemplate", "parameters": [ { "name": "_response", @@ -18340,7 +22950,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" }, "included": { "type": "array", @@ -18354,14 +22964,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { - "description": "Detail of MailTemplateType", + "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -18373,7 +22983,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18382,7 +22992,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + } + } } } } @@ -18396,19 +23014,93 @@ } } }, - "/mail-template-type/{id}": { + "/search/mail-template": { + "post": { + "tags": [ + "Mail Template" + ], + "summary": "Search for the Mail Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-template/{id}": { "get": { "tags": [ - "Mail Template Type" + "Mail Template" ], - "summary": "Detailed information about a Mail Template Type resource.", + "summary": "Detailed information about a Mail Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMailTemplateType", + "operationId": "getMailTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template_type", + "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", @@ -18418,7 +23110,7 @@ ], "responses": { "200": { - "description": "Detail of MailTemplateType", + "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -18430,7 +23122,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18439,7 +23131,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + } + } } } } @@ -18454,16 +23154,16 @@ }, "delete": { "tags": [ - "Mail Template Type" + "Mail Template" ], - "summary": "Delete a Mail Template Type resource.", + "summary": "Delete a Mail Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMailTemplateType", + "operationId": "deleteMailTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template_type", + "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", @@ -18494,16 +23194,16 @@ }, "patch": { "tags": [ - "Mail Template Type" + "Mail Template" ], - "summary": "Partially update information about a Mail Template Type resource.", + "summary": "Partially update information about a Mail Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMailTemplateType", + "operationId": "updateMailTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the mail_template_type", + "description": "Identifier for the mail_template", "required": true, "schema": { "type": "string", @@ -18521,14 +23221,14 @@ } ], "requestBody": { - "description": "Partially update information about a Mail Template Type resource.", + "description": "Partially update information about a Mail Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" }, "included": { "type": "array", @@ -18542,14 +23242,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } } }, "responses": { "200": { - "description": "Detail of MailTemplateType", + "description": "Detail of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -18561,7 +23261,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MailTemplateType" + "$ref": "#/components/schemas/MailTemplate" } } } @@ -18570,7 +23270,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MailTemplateType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplate" + } + } } } } @@ -18587,14 +23295,14 @@ } } }, - "/main-category": { + "/mail-template-type": { "get": { "tags": [ - "Main Category" + "Mail Template Type" ], - "summary": "List with basic information of Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getMainCategoryList", + "summary": "List with basic information of Mail Template Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailTemplateTypeList", "parameters": [ { "name": "limit", @@ -18623,7 +23331,7 @@ ], "responses": { "200": { - "description": "List of Main Category resources.", + "description": "List of Mail Template Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18642,7 +23350,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } ] @@ -18656,16 +23364,16 @@ "type": "object", "properties": { "first": { - "example": "/main-category?limit=25" + "example": "/mail-template-type?limit=25" }, "last": { - "example": "/main-category?limit=25&page=11" + "example": "/mail-template-type?limit=25&page=11" }, "next": { - "example": "/main-category?limit=25&page=4" + "example": "/mail-template-type?limit=25&page=4" }, "prev": { - "example": "/main-category?limit=25&page=2" + "example": "/mail-template-type?limit=25&page=2" } } } @@ -18686,7 +23394,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18701,11 +23409,11 @@ }, "post": { "tags": [ - "Main Category" + "Mail Template Type" ], - "summary": "Create a new Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createMainCategory", + "summary": "Create a new Mail Template Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMailTemplateType", "parameters": [ { "name": "_response", @@ -18727,7 +23435,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" }, "included": { "type": "array", @@ -18741,14 +23449,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } } }, "responses": { "200": { - "description": "Detail of MainCategory", + "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -18760,7 +23468,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18769,7 +23477,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + } + } } } } @@ -18783,19 +23499,93 @@ } } }, - "/main-category/{id}": { + "/search/mail-template-type": { + "post": { + "tags": [ + "Mail Template Type" + ], + "summary": "Search for the Mail Template Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMailTemplateType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/mail-template-type/{id}": { "get": { "tags": [ - "Main Category" + "Mail Template Type" ], - "summary": "Detailed information about a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getMainCategory", + "summary": "Detailed information about a Mail Template Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMailTemplateType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the main_category", + "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", @@ -18805,7 +23595,7 @@ ], "responses": { "200": { - "description": "Detail of MainCategory", + "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -18817,7 +23607,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18826,7 +23616,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + } + } } } } @@ -18841,16 +23639,16 @@ }, "delete": { "tags": [ - "Main Category" + "Mail Template Type" ], - "summary": "Delete a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteMainCategory", + "summary": "Delete a Mail Template Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMailTemplateType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the main_category", + "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", @@ -18881,16 +23679,16 @@ }, "patch": { "tags": [ - "Main Category" + "Mail Template Type" ], - "summary": "Partially update information about a Main Category resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateMainCategory", + "summary": "Partially update information about a Mail Template Type resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMailTemplateType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the main_category", + "description": "Identifier for the mail_template_type", "required": true, "schema": { "type": "string", @@ -18908,14 +23706,14 @@ } ], "requestBody": { - "description": "Partially update information about a Main Category resource.", + "description": "Partially update information about a Mail Template Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" }, "included": { "type": "array", @@ -18929,14 +23727,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } } }, "responses": { "200": { - "description": "Detail of MainCategory", + "description": "Detail of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -18948,7 +23746,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -18957,7 +23755,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MainCategory" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MailTemplateType" + } + } } } } @@ -18974,14 +23780,14 @@ } } }, - "/media": { + "/main-category": { "get": { "tags": [ - "Media" + "Main Category" ], - "summary": "List with basic information of Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaList", + "summary": "List with basic information of Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getMainCategoryList", "parameters": [ { "name": "limit", @@ -19010,7 +23816,7 @@ ], "responses": { "200": { - "description": "List of Media resources.", + "description": "List of Main Category resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19029,7 +23835,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } ] @@ -19043,16 +23849,16 @@ "type": "object", "properties": { "first": { - "example": "/media?limit=25" + "example": "/main-category?limit=25" }, "last": { - "example": "/media?limit=25&page=11" + "example": "/main-category?limit=25&page=11" }, "next": { - "example": "/media?limit=25&page=4" + "example": "/main-category?limit=25&page=4" }, "prev": { - "example": "/media?limit=25&page=2" + "example": "/main-category?limit=25&page=2" } } } @@ -19073,7 +23879,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } } @@ -19088,11 +23894,11 @@ }, "post": { "tags": [ - "Media" + "Main Category" ], - "summary": "Create a new Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMedia", + "summary": "Create a new Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createMainCategory", "parameters": [ { "name": "_response", @@ -19114,7 +23920,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" }, "included": { "type": "array", @@ -19128,14 +23934,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } } }, "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -19147,7 +23953,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } } @@ -19156,7 +23962,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + } + } } } } @@ -19170,19 +23984,93 @@ } } }, - "/media/{id}": { + "/search/main-category": { + "post": { + "tags": [ + "Main Category" + ], + "summary": "Search for the Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchMainCategory", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/main-category/{id}": { "get": { "tags": [ - "Media" + "Main Category" ], - "summary": "Detailed information about a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMedia", + "summary": "Detailed information about a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getMainCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", @@ -19192,7 +24080,7 @@ ], "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -19204,7 +24092,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } } @@ -19213,7 +24101,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + } + } } } } @@ -19228,16 +24124,16 @@ }, "delete": { "tags": [ - "Media" + "Main Category" ], - "summary": "Delete a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMedia", + "summary": "Delete a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteMainCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", @@ -19268,16 +24164,16 @@ }, "patch": { "tags": [ - "Media" + "Main Category" ], - "summary": "Partially update information about a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMedia", + "summary": "Partially update information about a Main Category resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateMainCategory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the main_category", "required": true, "schema": { "type": "string", @@ -19295,14 +24191,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media resource.", + "description": "Partially update information about a Main Category resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" }, "included": { "type": "array", @@ -19316,14 +24212,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } } }, "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -19335,7 +24231,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MainCategory" } } } @@ -19344,7 +24240,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MainCategory" + } + } } } } @@ -19361,14 +24265,14 @@ } } }, - "/media-default-folder": { + "/media": { "get": { "tags": [ - "Media Default Folder" + "Media" ], - "summary": "List with basic information of Media Default Folder resources.", + "summary": "List with basic information of Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolderList", + "operationId": "getMediaList", "parameters": [ { "name": "limit", @@ -19397,7 +24301,7 @@ ], "responses": { "200": { - "description": "List of Media Default Folder resources.", + "description": "List of Media resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19416,7 +24320,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } ] @@ -19430,16 +24334,16 @@ "type": "object", "properties": { "first": { - "example": "/media-default-folder?limit=25" + "example": "/media?limit=25" }, "last": { - "example": "/media-default-folder?limit=25&page=11" + "example": "/media?limit=25&page=11" }, "next": { - "example": "/media-default-folder?limit=25&page=4" + "example": "/media?limit=25&page=4" }, "prev": { - "example": "/media-default-folder?limit=25&page=2" + "example": "/media?limit=25&page=2" } } } @@ -19460,7 +24364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } } @@ -19475,11 +24379,11 @@ }, "post": { "tags": [ - "Media Default Folder" + "Media" ], - "summary": "Create a new Media Default Folder resources.", + "summary": "Create a new Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaDefaultFolder", + "operationId": "createMedia", "parameters": [ { "name": "_response", @@ -19501,7 +24405,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" }, "included": { "type": "array", @@ -19515,14 +24419,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -19534,7 +24438,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } } @@ -19543,7 +24447,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + } + } } } } @@ -19557,19 +24469,93 @@ } } }, - "/media-default-folder/{id}": { + "/search/media": { + "post": { + "tags": [ + "Media" + ], + "summary": "Search for the Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMedia", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media/{id}": { "get": { "tags": [ - "Media Default Folder" + "Media" ], - "summary": "Detailed information about a Media Default Folder resource.", + "summary": "Detailed information about a Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolder", + "operationId": "getMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -19579,7 +24565,7 @@ ], "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -19591,7 +24577,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } } @@ -19600,7 +24586,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + } + } } } } @@ -19615,16 +24609,16 @@ }, "delete": { "tags": [ - "Media Default Folder" + "Media" ], - "summary": "Delete a Media Default Folder resource.", + "summary": "Delete a Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaDefaultFolder", + "operationId": "deleteMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -19655,16 +24649,16 @@ }, "patch": { "tags": [ - "Media Default Folder" + "Media" ], - "summary": "Partially update information about a Media Default Folder resource.", + "summary": "Partially update information about a Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaDefaultFolder", + "operationId": "updateMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -19682,14 +24676,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Default Folder resource.", + "description": "Partially update information about a Media resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" }, "included": { "type": "array", @@ -19703,14 +24697,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -19722,7 +24716,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/Media" } } } @@ -19731,7 +24725,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Media" + } + } } } } @@ -19748,14 +24750,14 @@ } } }, - "/media-folder": { + "/media-default-folder": { "get": { "tags": [ - "Media Folder" + "Media Default Folder" ], - "summary": "List with basic information of Media Folder resources.", + "summary": "List with basic information of Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderList", + "operationId": "getMediaDefaultFolderList", "parameters": [ { "name": "limit", @@ -19784,7 +24786,7 @@ ], "responses": { "200": { - "description": "List of Media Folder resources.", + "description": "List of Media Default Folder resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19803,7 +24805,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } ] @@ -19817,16 +24819,16 @@ "type": "object", "properties": { "first": { - "example": "/media-folder?limit=25" + "example": "/media-default-folder?limit=25" }, "last": { - "example": "/media-folder?limit=25&page=11" + "example": "/media-default-folder?limit=25&page=11" }, "next": { - "example": "/media-folder?limit=25&page=4" + "example": "/media-default-folder?limit=25&page=4" }, "prev": { - "example": "/media-folder?limit=25&page=2" + "example": "/media-default-folder?limit=25&page=2" } } } @@ -19847,7 +24849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19862,11 +24864,11 @@ }, "post": { "tags": [ - "Media Folder" + "Media Default Folder" ], - "summary": "Create a new Media Folder resources.", + "summary": "Create a new Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolder", + "operationId": "createMediaDefaultFolder", "parameters": [ { "name": "_response", @@ -19888,7 +24890,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" }, "included": { "type": "array", @@ -19902,14 +24904,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19921,7 +24923,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19930,7 +24932,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } } } } @@ -19944,19 +24954,93 @@ } } }, - "/media-folder/{id}": { + "/search/media-default-folder": { + "post": { + "tags": [ + "Media Default Folder" + ], + "summary": "Search for the Media Default Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaDefaultFolder", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-default-folder/{id}": { "get": { "tags": [ - "Media Folder" + "Media Default Folder" ], - "summary": "Detailed information about a Media Folder resource.", + "summary": "Detailed information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolder", + "operationId": "getMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -19966,7 +25050,7 @@ ], "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -19978,7 +25062,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -19987,7 +25071,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } } } } @@ -20002,16 +25094,16 @@ }, "delete": { "tags": [ - "Media Folder" + "Media Default Folder" ], - "summary": "Delete a Media Folder resource.", + "summary": "Delete a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolder", + "operationId": "deleteMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -20042,16 +25134,16 @@ }, "patch": { "tags": [ - "Media Folder" + "Media Default Folder" ], - "summary": "Partially update information about a Media Folder resource.", + "summary": "Partially update information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolder", + "operationId": "updateMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -20069,14 +25161,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Folder resource.", + "description": "Partially update information about a Media Default Folder resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" }, "included": { "type": "array", @@ -20090,14 +25182,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -20109,7 +25201,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -20118,7 +25210,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } } } } @@ -20135,14 +25235,14 @@ } } }, - "/media-folder-configuration": { + "/media-folder": { "get": { "tags": [ - "Media Folder Configuration" + "Media Folder" ], - "summary": "List with basic information of Media Folder Configuration resources.", + "summary": "List with basic information of Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfigurationList", + "operationId": "getMediaFolderList", "parameters": [ { "name": "limit", @@ -20171,7 +25271,7 @@ ], "responses": { "200": { - "description": "List of Media Folder Configuration resources.", + "description": "List of Media Folder resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20190,7 +25290,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } ] @@ -20204,16 +25304,16 @@ "type": "object", "properties": { "first": { - "example": "/media-folder-configuration?limit=25" + "example": "/media-folder?limit=25" }, "last": { - "example": "/media-folder-configuration?limit=25&page=11" + "example": "/media-folder?limit=25&page=11" }, "next": { - "example": "/media-folder-configuration?limit=25&page=4" + "example": "/media-folder?limit=25&page=4" }, "prev": { - "example": "/media-folder-configuration?limit=25&page=2" + "example": "/media-folder?limit=25&page=2" } } } @@ -20234,7 +25334,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20249,11 +25349,11 @@ }, "post": { "tags": [ - "Media Folder Configuration" + "Media Folder" ], - "summary": "Create a new Media Folder Configuration resources.", + "summary": "Create a new Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolderConfiguration", + "operationId": "createMediaFolder", "parameters": [ { "name": "_response", @@ -20275,7 +25375,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" }, "included": { "type": "array", @@ -20289,14 +25389,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -20308,7 +25408,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20317,7 +25417,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } } } } @@ -20331,19 +25439,93 @@ } } }, - "/media-folder-configuration/{id}": { + "/search/media-folder": { + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Search for the Media Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaFolder", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder/{id}": { "get": { "tags": [ - "Media Folder Configuration" + "Media Folder" ], - "summary": "Detailed information about a Media Folder Configuration resource.", + "summary": "Detailed information about a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfiguration", + "operationId": "getMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -20353,7 +25535,7 @@ ], "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -20365,7 +25547,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20374,7 +25556,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } } } } @@ -20389,16 +25579,16 @@ }, "delete": { "tags": [ - "Media Folder Configuration" + "Media Folder" ], - "summary": "Delete a Media Folder Configuration resource.", + "summary": "Delete a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolderConfiguration", + "operationId": "deleteMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -20429,16 +25619,16 @@ }, "patch": { "tags": [ - "Media Folder Configuration" + "Media Folder" ], - "summary": "Partially update information about a Media Folder Configuration resource.", + "summary": "Partially update information about a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolderConfiguration", + "operationId": "updateMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -20456,14 +25646,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Folder Configuration resource.", + "description": "Partially update information about a Media Folder resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" }, "included": { "type": "array", @@ -20477,14 +25667,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -20496,7 +25686,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -20505,7 +25695,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } } } } @@ -20522,14 +25720,14 @@ } } }, - "/media-thumbnail": { + "/media-folder-configuration": { "get": { "tags": [ - "Media Thumbnail" + "Media Folder Configuration" ], - "summary": "List with basic information of Media Thumbnail resources.", + "summary": "List with basic information of Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailList", + "operationId": "getMediaFolderConfigurationList", "parameters": [ { "name": "limit", @@ -20558,7 +25756,7 @@ ], "responses": { "200": { - "description": "List of Media Thumbnail resources.", + "description": "List of Media Folder Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20577,7 +25775,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } ] @@ -20591,16 +25789,16 @@ "type": "object", "properties": { "first": { - "example": "/media-thumbnail?limit=25" + "example": "/media-folder-configuration?limit=25" }, "last": { - "example": "/media-thumbnail?limit=25&page=11" + "example": "/media-folder-configuration?limit=25&page=11" }, "next": { - "example": "/media-thumbnail?limit=25&page=4" + "example": "/media-folder-configuration?limit=25&page=4" }, "prev": { - "example": "/media-thumbnail?limit=25&page=2" + "example": "/media-folder-configuration?limit=25&page=2" } } } @@ -20621,7 +25819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20636,11 +25834,11 @@ }, "post": { "tags": [ - "Media Thumbnail" + "Media Folder Configuration" ], - "summary": "Create a new Media Thumbnail resources.", + "summary": "Create a new Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnail", + "operationId": "createMediaFolderConfiguration", "parameters": [ { "name": "_response", @@ -20662,7 +25860,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" }, "included": { "type": "array", @@ -20676,14 +25874,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -20695,7 +25893,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20704,7 +25902,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } } } } @@ -20718,19 +25924,93 @@ } } }, - "/media-thumbnail/{id}": { + "/search/media-folder-configuration": { + "post": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Search for the Media Folder Configuration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaFolderConfiguration", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder-configuration/{id}": { "get": { "tags": [ - "Media Thumbnail" + "Media Folder Configuration" ], - "summary": "Detailed information about a Media Thumbnail resource.", + "summary": "Detailed information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnail", + "operationId": "getMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -20740,7 +26020,7 @@ ], "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -20752,7 +26032,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20761,7 +26041,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } } } } @@ -20776,16 +26064,16 @@ }, "delete": { "tags": [ - "Media Thumbnail" + "Media Folder Configuration" ], - "summary": "Delete a Media Thumbnail resource.", + "summary": "Delete a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnail", + "operationId": "deleteMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -20816,16 +26104,16 @@ }, "patch": { "tags": [ - "Media Thumbnail" + "Media Folder Configuration" ], - "summary": "Partially update information about a Media Thumbnail resource.", + "summary": "Partially update information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnail", + "operationId": "updateMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -20843,14 +26131,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Thumbnail resource.", + "description": "Partially update information about a Media Folder Configuration resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" }, "included": { "type": "array", @@ -20864,14 +26152,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -20883,7 +26171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -20892,7 +26180,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } } } } @@ -20909,14 +26205,14 @@ } } }, - "/media-thumbnail-size": { + "/media-thumbnail": { "get": { "tags": [ - "Media Thumbnail Size" + "Media Thumbnail" ], - "summary": "List with basic information of Media Thumbnail Size resources.", + "summary": "List with basic information of Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSizeList", + "operationId": "getMediaThumbnailList", "parameters": [ { "name": "limit", @@ -20945,7 +26241,7 @@ ], "responses": { "200": { - "description": "List of Media Thumbnail Size resources.", + "description": "List of Media Thumbnail resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20964,7 +26260,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } ] @@ -20978,16 +26274,16 @@ "type": "object", "properties": { "first": { - "example": "/media-thumbnail-size?limit=25" + "example": "/media-thumbnail?limit=25" }, "last": { - "example": "/media-thumbnail-size?limit=25&page=11" + "example": "/media-thumbnail?limit=25&page=11" }, "next": { - "example": "/media-thumbnail-size?limit=25&page=4" + "example": "/media-thumbnail?limit=25&page=4" }, "prev": { - "example": "/media-thumbnail-size?limit=25&page=2" + "example": "/media-thumbnail?limit=25&page=2" } } } @@ -21008,7 +26304,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -21023,11 +26319,11 @@ }, "post": { "tags": [ - "Media Thumbnail Size" + "Media Thumbnail" ], - "summary": "Create a new Media Thumbnail Size resources.", + "summary": "Create a new Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnailSize", + "operationId": "createMediaThumbnail", "parameters": [ { "name": "_response", @@ -21049,7 +26345,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" }, "included": { "type": "array", @@ -21063,14 +26359,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -21082,7 +26378,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -21091,7 +26387,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } } } } @@ -21105,19 +26409,93 @@ } } }, - "/media-thumbnail-size/{id}": { + "/search/media-thumbnail": { + "post": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Search for the Media Thumbnail resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaThumbnail", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-thumbnail/{id}": { "get": { "tags": [ - "Media Thumbnail Size" + "Media Thumbnail" ], - "summary": "Detailed information about a Media Thumbnail Size resource.", + "summary": "Detailed information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSize", + "operationId": "getMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -21127,7 +26505,7 @@ ], "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -21139,7 +26517,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -21148,7 +26526,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } } } } @@ -21163,16 +26549,16 @@ }, "delete": { "tags": [ - "Media Thumbnail Size" + "Media Thumbnail" ], - "summary": "Delete a Media Thumbnail Size resource.", + "summary": "Delete a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnailSize", + "operationId": "deleteMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -21203,16 +26589,16 @@ }, "patch": { "tags": [ - "Media Thumbnail Size" + "Media Thumbnail" ], - "summary": "Partially update information about a Media Thumbnail Size resource.", + "summary": "Partially update information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnailSize", + "operationId": "updateMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -21230,14 +26616,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Thumbnail Size resource.", + "description": "Partially update information about a Media Thumbnail resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" }, "included": { "type": "array", @@ -21251,14 +26637,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -21270,7 +26656,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -21279,7 +26665,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } } } } @@ -21296,14 +26690,14 @@ } } }, - "/newsletter-recipient": { + "/media-thumbnail-size": { "get": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail Size" ], - "summary": "List with basic information of Newsletter Recipient resources.", + "summary": "List with basic information of Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipientList", + "operationId": "getMediaThumbnailSizeList", "parameters": [ { "name": "limit", @@ -21332,7 +26726,7 @@ ], "responses": { "200": { - "description": "List of Newsletter Recipient resources.", + "description": "List of Media Thumbnail Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21351,7 +26745,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } ] @@ -21365,16 +26759,16 @@ "type": "object", "properties": { "first": { - "example": "/newsletter-recipient?limit=25" + "example": "/media-thumbnail-size?limit=25" }, "last": { - "example": "/newsletter-recipient?limit=25&page=11" + "example": "/media-thumbnail-size?limit=25&page=11" }, "next": { - "example": "/newsletter-recipient?limit=25&page=4" + "example": "/media-thumbnail-size?limit=25&page=4" }, "prev": { - "example": "/newsletter-recipient?limit=25&page=2" + "example": "/media-thumbnail-size?limit=25&page=2" } } } @@ -21395,7 +26789,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21410,11 +26804,11 @@ }, "post": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail Size" ], - "summary": "Create a new Newsletter Recipient resources.", + "summary": "Create a new Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNewsletterRecipient", + "operationId": "createMediaThumbnailSize", "parameters": [ { "name": "_response", @@ -21436,7 +26830,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" }, "included": { "type": "array", @@ -21450,14 +26844,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -21469,7 +26863,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21478,7 +26872,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } } } } @@ -21492,19 +26894,93 @@ } } }, - "/newsletter-recipient/{id}": { + "/search/media-thumbnail-size": { + "post": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Search for the Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaThumbnailSize", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-thumbnail-size/{id}": { "get": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail Size" ], - "summary": "Detailed information about a Newsletter Recipient resource.", + "summary": "Detailed information about a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipient", + "operationId": "getMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -21514,7 +26990,7 @@ ], "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -21526,7 +27002,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21535,7 +27011,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } } } } @@ -21550,16 +27034,16 @@ }, "delete": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail Size" ], - "summary": "Delete a Newsletter Recipient resource.", + "summary": "Delete a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNewsletterRecipient", + "operationId": "deleteMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -21590,16 +27074,16 @@ }, "patch": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail Size" ], - "summary": "Partially update information about a Newsletter Recipient resource.", + "summary": "Partially update information about a Media Thumbnail Size resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNewsletterRecipient", + "operationId": "updateMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -21617,14 +27101,14 @@ } ], "requestBody": { - "description": "Partially update information about a Newsletter Recipient resource.", + "description": "Partially update information about a Media Thumbnail Size resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" }, "included": { "type": "array", @@ -21638,14 +27122,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -21657,7 +27141,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -21666,7 +27150,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } } } } @@ -21683,14 +27175,14 @@ } } }, - "/notification": { + "/newsletter-recipient": { "get": { "tags": [ - "Notification" + "Newsletter Recipient" ], - "summary": "List with basic information of Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotificationList", + "summary": "List with basic information of Newsletter Recipient resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getNewsletterRecipientList", "parameters": [ { "name": "limit", @@ -21719,7 +27211,7 @@ ], "responses": { "200": { - "description": "List of Notification resources.", + "description": "List of Newsletter Recipient resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21738,7 +27230,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } ] @@ -21752,16 +27244,16 @@ "type": "object", "properties": { "first": { - "example": "/notification?limit=25" + "example": "/newsletter-recipient?limit=25" }, "last": { - "example": "/notification?limit=25&page=11" + "example": "/newsletter-recipient?limit=25&page=11" }, "next": { - "example": "/notification?limit=25&page=4" + "example": "/newsletter-recipient?limit=25&page=4" }, "prev": { - "example": "/notification?limit=25&page=2" + "example": "/newsletter-recipient?limit=25&page=2" } } } @@ -21782,7 +27274,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21797,11 +27289,11 @@ }, "post": { "tags": [ - "Notification" + "Newsletter Recipient" ], - "summary": "Create a new Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createNotification", + "summary": "Create a new Newsletter Recipient resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createNewsletterRecipient", "parameters": [ { "name": "_response", @@ -21823,7 +27315,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" }, "included": { "type": "array", @@ -21837,14 +27329,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -21856,7 +27348,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21865,7 +27357,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } } } } @@ -21879,19 +27379,93 @@ } } }, - "/notification/{id}": { + "/search/newsletter-recipient": { + "post": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Search for the Newsletter Recipient resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNewsletterRecipient", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/newsletter-recipient/{id}": { "get": { "tags": [ - "Notification" + "Newsletter Recipient" ], - "summary": "Detailed information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotification", + "summary": "Detailed information about a Newsletter Recipient resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -21901,7 +27475,7 @@ ], "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -21913,7 +27487,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -21922,7 +27496,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } } } } @@ -21937,16 +27519,16 @@ }, "delete": { "tags": [ - "Notification" + "Newsletter Recipient" ], - "summary": "Delete a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteNotification", + "summary": "Delete a Newsletter Recipient resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -21977,16 +27559,16 @@ }, "patch": { "tags": [ - "Notification" + "Newsletter Recipient" ], - "summary": "Partially update information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateNotification", + "summary": "Partially update information about a Newsletter Recipient resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -22004,14 +27586,14 @@ } ], "requestBody": { - "description": "Partially update information about a Notification resource.", + "description": "Partially update information about a Newsletter Recipient resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" }, "included": { "type": "array", @@ -22025,14 +27607,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -22044,7 +27626,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -22053,7 +27635,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } } } } @@ -22070,14 +27660,14 @@ } } }, - "/number-range": { + "/notification": { "get": { "tags": [ - "Number Range" + "Notification" ], - "summary": "List with basic information of Number Range resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeList", + "summary": "List with basic information of Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotificationList", "parameters": [ { "name": "limit", @@ -22106,7 +27696,7 @@ ], "responses": { "200": { - "description": "List of Number Range resources.", + "description": "List of Notification resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22125,7 +27715,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } ] @@ -22139,16 +27729,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range?limit=25" + "example": "/notification?limit=25" }, "last": { - "example": "/number-range?limit=25&page=11" + "example": "/notification?limit=25&page=11" }, "next": { - "example": "/number-range?limit=25&page=4" + "example": "/notification?limit=25&page=4" }, "prev": { - "example": "/number-range?limit=25&page=2" + "example": "/notification?limit=25&page=2" } } } @@ -22169,7 +27759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } } @@ -22184,11 +27774,11 @@ }, "post": { "tags": [ - "Number Range" + "Notification" ], - "summary": "Create a new Number Range resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNumberRange", + "summary": "Create a new Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createNotification", "parameters": [ { "name": "_response", @@ -22210,7 +27800,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" }, "included": { "type": "array", @@ -22224,14 +27814,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -22243,7 +27833,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } } @@ -22252,7 +27842,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + } + } } } } @@ -22266,19 +27864,93 @@ } } }, - "/number-range/{id}": { + "/search/notification": { + "post": { + "tags": [ + "Notification" + ], + "summary": "Search for the Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchNotification", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/notification/{id}": { "get": { "tags": [ - "Number Range" + "Notification" ], - "summary": "Detailed information about a Number Range resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRange", + "summary": "Detailed information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -22288,7 +27960,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -22300,7 +27972,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } } @@ -22309,7 +27981,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + } + } } } } @@ -22324,16 +28004,16 @@ }, "delete": { "tags": [ - "Number Range" + "Notification" ], - "summary": "Delete a Number Range resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRange", + "summary": "Delete a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -22364,16 +28044,16 @@ }, "patch": { "tags": [ - "Number Range" + "Notification" ], - "summary": "Partially update information about a Number Range resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRange", + "summary": "Partially update information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "updateNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -22391,14 +28071,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range resource.", + "description": "Partially update information about a Notification resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" }, "included": { "type": "array", @@ -22412,14 +28092,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -22431,7 +28111,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/Notification" } } } @@ -22440,7 +28120,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Notification" + } + } } } } @@ -22457,14 +28145,14 @@ } } }, - "/number-range-sales-channel": { + "/number-range": { "get": { "tags": [ - "Number Range Sales Channel" + "Number Range" ], - "summary": "List with basic information of Number Range Sales Channel resources.", + "summary": "List with basic information of Number Range resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannelList", + "operationId": "getNumberRangeList", "parameters": [ { "name": "limit", @@ -22493,7 +28181,7 @@ ], "responses": { "200": { - "description": "List of Number Range Sales Channel resources.", + "description": "List of Number Range resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22512,7 +28200,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } ] @@ -22526,16 +28214,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-sales-channel?limit=25" + "example": "/number-range?limit=25" }, "last": { - "example": "/number-range-sales-channel?limit=25&page=11" + "example": "/number-range?limit=25&page=11" }, "next": { - "example": "/number-range-sales-channel?limit=25&page=4" + "example": "/number-range?limit=25&page=4" }, "prev": { - "example": "/number-range-sales-channel?limit=25&page=2" + "example": "/number-range?limit=25&page=2" } } } @@ -22556,7 +28244,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22571,11 +28259,11 @@ }, "post": { "tags": [ - "Number Range Sales Channel" + "Number Range" ], - "summary": "Create a new Number Range Sales Channel resources.", + "summary": "Create a new Number Range resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeSalesChannel", + "operationId": "createNumberRange", "parameters": [ { "name": "_response", @@ -22597,7 +28285,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" }, "included": { "type": "array", @@ -22611,14 +28299,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -22630,7 +28318,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22639,7 +28327,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + } + } } } } @@ -22653,19 +28349,93 @@ } } }, - "/number-range-sales-channel/{id}": { + "/search/number-range": { + "post": { + "tags": [ + "Number Range" + ], + "summary": "Search for the Number Range resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRange", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range/{id}": { "get": { "tags": [ - "Number Range Sales Channel" + "Number Range" ], - "summary": "Detailed information about a Number Range Sales Channel resource.", + "summary": "Detailed information about a Number Range resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannel", + "operationId": "getNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -22675,7 +28445,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -22687,7 +28457,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22696,7 +28466,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + } + } } } } @@ -22711,16 +28489,16 @@ }, "delete": { "tags": [ - "Number Range Sales Channel" + "Number Range" ], - "summary": "Delete a Number Range Sales Channel resource.", + "summary": "Delete a Number Range resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeSalesChannel", + "operationId": "deleteNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -22751,16 +28529,16 @@ }, "patch": { "tags": [ - "Number Range Sales Channel" + "Number Range" ], - "summary": "Partially update information about a Number Range Sales Channel resource.", + "summary": "Partially update information about a Number Range resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeSalesChannel", + "operationId": "updateNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -22778,14 +28556,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range Sales Channel resource.", + "description": "Partially update information about a Number Range resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" }, "included": { "type": "array", @@ -22799,14 +28577,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -22818,7 +28596,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/NumberRange" } } } @@ -22827,7 +28605,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRange" + } + } } } } @@ -22844,14 +28630,14 @@ } } }, - "/number-range-state": { + "/number-range-sales-channel": { "get": { "tags": [ - "Number Range State" + "Number Range Sales Channel" ], - "summary": "List with basic information of Number Range State resources.", + "summary": "List with basic information of Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeStateList", + "operationId": "getNumberRangeSalesChannelList", "parameters": [ { "name": "limit", @@ -22880,7 +28666,7 @@ ], "responses": { "200": { - "description": "List of Number Range State resources.", + "description": "List of Number Range Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22899,7 +28685,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } ] @@ -22913,16 +28699,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-state?limit=25" + "example": "/number-range-sales-channel?limit=25" }, "last": { - "example": "/number-range-state?limit=25&page=11" + "example": "/number-range-sales-channel?limit=25&page=11" }, "next": { - "example": "/number-range-state?limit=25&page=4" + "example": "/number-range-sales-channel?limit=25&page=4" }, "prev": { - "example": "/number-range-state?limit=25&page=2" + "example": "/number-range-sales-channel?limit=25&page=2" } } } @@ -22943,7 +28729,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -22958,11 +28744,11 @@ }, "post": { "tags": [ - "Number Range State" + "Number Range Sales Channel" ], - "summary": "Create a new Number Range State resources.", + "summary": "Create a new Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeState", + "operationId": "createNumberRangeSalesChannel", "parameters": [ { "name": "_response", @@ -22984,7 +28770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" }, "included": { "type": "array", @@ -22998,14 +28784,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -23017,7 +28803,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -23026,7 +28812,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } } } } @@ -23040,19 +28834,93 @@ } } }, - "/number-range-state/{id}": { + "/search/number-range-sales-channel": { + "post": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Search for the Number Range Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRangeSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-sales-channel/{id}": { "get": { "tags": [ - "Number Range State" + "Number Range Sales Channel" ], - "summary": "Detailed information about a Number Range State resource.", + "summary": "Detailed information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeState", + "operationId": "getNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -23062,7 +28930,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -23074,7 +28942,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -23083,7 +28951,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } } } } @@ -23098,16 +28974,16 @@ }, "delete": { "tags": [ - "Number Range State" + "Number Range Sales Channel" ], - "summary": "Delete a Number Range State resource.", + "summary": "Delete a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeState", + "operationId": "deleteNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -23138,16 +29014,16 @@ }, "patch": { "tags": [ - "Number Range State" + "Number Range Sales Channel" ], - "summary": "Partially update information about a Number Range State resource.", + "summary": "Partially update information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeState", + "operationId": "updateNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -23165,14 +29041,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range State resource.", + "description": "Partially update information about a Number Range Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" }, "included": { "type": "array", @@ -23186,14 +29062,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -23205,7 +29081,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -23214,7 +29090,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } } } } @@ -23231,14 +29115,14 @@ } } }, - "/number-range-type": { + "/number-range-state": { "get": { "tags": [ - "Number Range Type" + "Number Range State" ], - "summary": "List with basic information of Number Range Type resources.", + "summary": "List with basic information of Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeTypeList", + "operationId": "getNumberRangeStateList", "parameters": [ { "name": "limit", @@ -23267,7 +29151,7 @@ ], "responses": { "200": { - "description": "List of Number Range Type resources.", + "description": "List of Number Range State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23286,7 +29170,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } ] @@ -23300,16 +29184,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-type?limit=25" + "example": "/number-range-state?limit=25" }, "last": { - "example": "/number-range-type?limit=25&page=11" + "example": "/number-range-state?limit=25&page=11" }, "next": { - "example": "/number-range-type?limit=25&page=4" + "example": "/number-range-state?limit=25&page=4" }, "prev": { - "example": "/number-range-type?limit=25&page=2" + "example": "/number-range-state?limit=25&page=2" } } } @@ -23330,7 +29214,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23345,11 +29229,11 @@ }, "post": { "tags": [ - "Number Range Type" + "Number Range State" ], - "summary": "Create a new Number Range Type resources.", + "summary": "Create a new Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeType", + "operationId": "createNumberRangeState", "parameters": [ { "name": "_response", @@ -23371,7 +29255,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" }, "included": { "type": "array", @@ -23385,14 +29269,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -23404,7 +29288,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23413,7 +29297,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + } + } } } } @@ -23427,19 +29319,93 @@ } } }, - "/number-range-type/{id}": { + "/search/number-range-state": { + "post": { + "tags": [ + "Number Range State" + ], + "summary": "Search for the Number Range State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRangeState", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-state/{id}": { "get": { "tags": [ - "Number Range Type" + "Number Range State" ], - "summary": "Detailed information about a Number Range Type resource.", + "summary": "Detailed information about a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeType", + "operationId": "getNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -23449,7 +29415,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -23461,7 +29427,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23470,7 +29436,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + } + } } } } @@ -23485,16 +29459,16 @@ }, "delete": { "tags": [ - "Number Range Type" + "Number Range State" ], - "summary": "Delete a Number Range Type resource.", + "summary": "Delete a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeType", + "operationId": "deleteNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -23525,16 +29499,16 @@ }, "patch": { "tags": [ - "Number Range Type" + "Number Range State" ], - "summary": "Partially update information about a Number Range Type resource.", + "summary": "Partially update information about a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeType", + "operationId": "updateNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -23552,14 +29526,14 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range Type resource.", + "description": "Partially update information about a Number Range State resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" }, "included": { "type": "array", @@ -23573,14 +29547,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -23592,7 +29566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -23601,7 +29575,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeState" + } + } } } } @@ -23618,14 +29600,14 @@ } } }, - "/order": { + "/number-range-type": { "get": { "tags": [ - "Order" + "Number Range Type" ], - "summary": "List with basic information of Order resources.", + "summary": "List with basic information of Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderList", + "operationId": "getNumberRangeTypeList", "parameters": [ { "name": "limit", @@ -23654,7 +29636,7 @@ ], "responses": { "200": { - "description": "List of Order resources.", + "description": "List of Number Range Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23673,7 +29655,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } ] @@ -23687,16 +29669,16 @@ "type": "object", "properties": { "first": { - "example": "/order?limit=25" + "example": "/number-range-type?limit=25" }, "last": { - "example": "/order?limit=25&page=11" + "example": "/number-range-type?limit=25&page=11" }, "next": { - "example": "/order?limit=25&page=4" + "example": "/number-range-type?limit=25&page=4" }, "prev": { - "example": "/order?limit=25&page=2" + "example": "/number-range-type?limit=25&page=2" } } } @@ -23717,7 +29699,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23732,11 +29714,11 @@ }, "post": { "tags": [ - "Order" + "Number Range Type" ], - "summary": "Create a new Order resources.", + "summary": "Create a new Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrder", + "operationId": "createNumberRangeType", "parameters": [ { "name": "_response", @@ -23758,7 +29740,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" }, "included": { "type": "array", @@ -23772,14 +29754,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -23791,7 +29773,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23800,7 +29782,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + } + } } } } @@ -23814,19 +29804,93 @@ } } }, - "/order/{id}": { + "/search/number-range-type": { + "post": { + "tags": [ + "Number Range Type" + ], + "summary": "Search for the Number Range Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRangeType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/number-range-type/{id}": { "get": { "tags": [ - "Order" + "Number Range Type" ], - "summary": "Detailed information about a Order resource.", + "summary": "Detailed information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrder", + "operationId": "getNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -23836,7 +29900,7 @@ ], "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -23848,7 +29912,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23857,7 +29921,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + } + } } } } @@ -23872,16 +29944,16 @@ }, "delete": { "tags": [ - "Order" + "Number Range Type" ], - "summary": "Delete a Order resource.", + "summary": "Delete a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrder", + "operationId": "deleteNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -23912,16 +29984,16 @@ }, "patch": { "tags": [ - "Order" + "Number Range Type" ], - "summary": "Partially update information about a Order resource.", + "summary": "Partially update information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrder", + "operationId": "updateNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -23939,14 +30011,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order resource.", + "description": "Partially update information about a Number Range Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" }, "included": { "type": "array", @@ -23960,14 +30032,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -23979,7 +30051,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -23988,7 +30060,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/NumberRangeType" + } + } } } } @@ -24005,14 +30085,14 @@ } } }, - "/order-address": { + "/order": { "get": { "tags": [ - "Order Address" + "Order" ], - "summary": "List with basic information of Order Address resources.", + "summary": "List with basic information of Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddressList", + "operationId": "getOrderList", "parameters": [ { "name": "limit", @@ -24041,7 +30121,7 @@ ], "responses": { "200": { - "description": "List of Order Address resources.", + "description": "List of Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24060,7 +30140,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } ] @@ -24074,16 +30154,16 @@ "type": "object", "properties": { "first": { - "example": "/order-address?limit=25" + "example": "/order?limit=25" }, "last": { - "example": "/order-address?limit=25&page=11" + "example": "/order?limit=25&page=11" }, "next": { - "example": "/order-address?limit=25&page=4" + "example": "/order?limit=25&page=4" }, "prev": { - "example": "/order-address?limit=25&page=2" + "example": "/order?limit=25&page=2" } } } @@ -24104,7 +30184,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } } @@ -24119,11 +30199,11 @@ }, "post": { "tags": [ - "Order Address" + "Order" ], - "summary": "Create a new Order Address resources.", + "summary": "Create a new Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderAddress", + "operationId": "createOrder", "parameters": [ { "name": "_response", @@ -24145,7 +30225,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" }, "included": { "type": "array", @@ -24159,14 +30239,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -24178,7 +30258,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } } @@ -24187,7 +30267,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + } + } } } } @@ -24201,19 +30289,93 @@ } } }, - "/order-address/{id}": { + "/search/order": { + "post": { + "tags": [ + "Order" + ], + "summary": "Search for the Order resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrder", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order/{id}": { "get": { "tags": [ - "Order Address" + "Order" ], - "summary": "Detailed information about a Order Address resource.", + "summary": "Detailed information about a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddress", + "operationId": "getOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -24223,7 +30385,7 @@ ], "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -24235,7 +30397,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } } @@ -24244,7 +30406,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + } + } } } } @@ -24259,16 +30429,16 @@ }, "delete": { "tags": [ - "Order Address" + "Order" ], - "summary": "Delete a Order Address resource.", + "summary": "Delete a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderAddress", + "operationId": "deleteOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -24299,16 +30469,16 @@ }, "patch": { "tags": [ - "Order Address" + "Order" ], - "summary": "Partially update information about a Order Address resource.", + "summary": "Partially update information about a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderAddress", + "operationId": "updateOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -24326,14 +30496,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Address resource.", + "description": "Partially update information about a Order resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" }, "included": { "type": "array", @@ -24347,14 +30517,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -24366,7 +30536,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/Order" } } } @@ -24375,7 +30545,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Order" + } + } } } } @@ -24392,14 +30570,14 @@ } } }, - "/order-customer": { + "/order-address": { "get": { "tags": [ - "Order Customer" + "Order Address" ], - "summary": "List with basic information of Order Customer resources.", + "summary": "List with basic information of Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomerList", + "operationId": "getOrderAddressList", "parameters": [ { "name": "limit", @@ -24428,7 +30606,7 @@ ], "responses": { "200": { - "description": "List of Order Customer resources.", + "description": "List of Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24447,7 +30625,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } ] @@ -24461,16 +30639,16 @@ "type": "object", "properties": { "first": { - "example": "/order-customer?limit=25" + "example": "/order-address?limit=25" }, "last": { - "example": "/order-customer?limit=25&page=11" + "example": "/order-address?limit=25&page=11" }, "next": { - "example": "/order-customer?limit=25&page=4" + "example": "/order-address?limit=25&page=4" }, "prev": { - "example": "/order-customer?limit=25&page=2" + "example": "/order-address?limit=25&page=2" } } } @@ -24491,7 +30669,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24506,11 +30684,11 @@ }, "post": { "tags": [ - "Order Customer" + "Order Address" ], - "summary": "Create a new Order Customer resources.", + "summary": "Create a new Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderCustomer", + "operationId": "createOrderAddress", "parameters": [ { "name": "_response", @@ -24532,7 +30710,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" }, "included": { "type": "array", @@ -24546,14 +30724,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -24565,7 +30743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24574,7 +30752,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + } + } } } } @@ -24588,19 +30774,93 @@ } } }, - "/order-customer/{id}": { + "/search/order-address": { + "post": { + "tags": [ + "Order Address" + ], + "summary": "Search for the Order Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-address/{id}": { "get": { "tags": [ - "Order Customer" + "Order Address" ], - "summary": "Detailed information about a Order Customer resource.", + "summary": "Detailed information about a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomer", + "operationId": "getOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -24610,7 +30870,7 @@ ], "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -24622,7 +30882,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24631,7 +30891,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + } + } } } } @@ -24646,16 +30914,16 @@ }, "delete": { "tags": [ - "Order Customer" + "Order Address" ], - "summary": "Delete a Order Customer resource.", + "summary": "Delete a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderCustomer", + "operationId": "deleteOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -24686,16 +30954,16 @@ }, "patch": { "tags": [ - "Order Customer" + "Order Address" ], - "summary": "Partially update information about a Order Customer resource.", + "summary": "Partially update information about a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderCustomer", + "operationId": "updateOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -24713,14 +30981,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Customer resource.", + "description": "Partially update information about a Order Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" }, "included": { "type": "array", @@ -24734,14 +31002,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -24753,7 +31021,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -24762,7 +31030,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderAddress" + } + } } } } @@ -24779,14 +31055,14 @@ } } }, - "/order-delivery": { + "/order-customer": { "get": { "tags": [ - "Order Delivery" + "Order Customer" ], - "summary": "List with basic information of Order Delivery resources.", + "summary": "List with basic information of Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryList", + "operationId": "getOrderCustomerList", "parameters": [ { "name": "limit", @@ -24815,7 +31091,7 @@ ], "responses": { "200": { - "description": "List of Order Delivery resources.", + "description": "List of Order Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24834,7 +31110,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } ] @@ -24848,16 +31124,16 @@ "type": "object", "properties": { "first": { - "example": "/order-delivery?limit=25" + "example": "/order-customer?limit=25" }, "last": { - "example": "/order-delivery?limit=25&page=11" + "example": "/order-customer?limit=25&page=11" }, "next": { - "example": "/order-delivery?limit=25&page=4" + "example": "/order-customer?limit=25&page=4" }, "prev": { - "example": "/order-delivery?limit=25&page=2" + "example": "/order-customer?limit=25&page=2" } } } @@ -24878,7 +31154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24893,11 +31169,11 @@ }, "post": { "tags": [ - "Order Delivery" + "Order Customer" ], - "summary": "Create a new Order Delivery resources.", + "summary": "Create a new Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderDelivery", + "operationId": "createOrderCustomer", "parameters": [ { "name": "_response", @@ -24919,7 +31195,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" }, "included": { "type": "array", @@ -24933,14 +31209,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -24952,7 +31228,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -24961,7 +31237,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + } + } } } } @@ -24975,19 +31259,93 @@ } } }, - "/order-delivery/{id}": { + "/search/order-customer": { + "post": { + "tags": [ + "Order Customer" + ], + "summary": "Search for the Order Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderCustomer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-customer/{id}": { "get": { "tags": [ - "Order Delivery" + "Order Customer" ], - "summary": "Detailed information about a Order Delivery resource.", + "summary": "Detailed information about a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDelivery", + "operationId": "getOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -24997,7 +31355,7 @@ ], "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -25009,7 +31367,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -25018,7 +31376,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + } + } } } } @@ -25033,16 +31399,16 @@ }, "delete": { "tags": [ - "Order Delivery" + "Order Customer" ], - "summary": "Delete a Order Delivery resource.", + "summary": "Delete a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDelivery", + "operationId": "deleteOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -25073,16 +31439,16 @@ }, "patch": { "tags": [ - "Order Delivery" + "Order Customer" ], - "summary": "Partially update information about a Order Delivery resource.", + "summary": "Partially update information about a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDelivery", + "operationId": "updateOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -25100,14 +31466,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Delivery resource.", + "description": "Partially update information about a Order Customer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" }, "included": { "type": "array", @@ -25121,14 +31487,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -25140,7 +31506,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -25149,7 +31515,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderCustomer" + } + } } } } @@ -25166,14 +31540,14 @@ } } }, - "/order-delivery-position": { + "/order-delivery": { "get": { "tags": [ - "Order Delivery Position" + "Order Delivery" ], - "summary": "List with basic information of Order Delivery Position resources.", + "summary": "List with basic information of Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPositionList", + "operationId": "getOrderDeliveryList", "parameters": [ { "name": "limit", @@ -25202,7 +31576,7 @@ ], "responses": { "200": { - "description": "List of Order Delivery Position resources.", + "description": "List of Order Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25221,7 +31595,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } ] @@ -25235,16 +31609,16 @@ "type": "object", "properties": { "first": { - "example": "/order-delivery-position?limit=25" + "example": "/order-delivery?limit=25" }, "last": { - "example": "/order-delivery-position?limit=25&page=11" + "example": "/order-delivery?limit=25&page=11" }, "next": { - "example": "/order-delivery-position?limit=25&page=4" + "example": "/order-delivery?limit=25&page=4" }, "prev": { - "example": "/order-delivery-position?limit=25&page=2" + "example": "/order-delivery?limit=25&page=2" } } } @@ -25265,7 +31639,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25280,11 +31654,11 @@ }, "post": { "tags": [ - "Order Delivery Position" + "Order Delivery" ], - "summary": "Create a new Order Delivery Position resources.", + "summary": "Create a new Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderDeliveryPosition", + "operationId": "createOrderDelivery", "parameters": [ { "name": "_response", @@ -25306,7 +31680,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" }, "included": { "type": "array", @@ -25320,14 +31694,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25339,7 +31713,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25348,7 +31722,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + } + } } } } @@ -25362,19 +31744,93 @@ } } }, - "/order-delivery-position/{id}": { + "/search/order-delivery": { + "post": { + "tags": [ + "Order Delivery" + ], + "summary": "Search for the Order Delivery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderDelivery", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-delivery/{id}": { "get": { "tags": [ - "Order Delivery Position" + "Order Delivery" ], - "summary": "Detailed information about a Order Delivery Position resource.", + "summary": "Detailed information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPosition", + "operationId": "getOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -25384,7 +31840,7 @@ ], "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25396,7 +31852,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25405,7 +31861,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + } + } } } } @@ -25420,16 +31884,16 @@ }, "delete": { "tags": [ - "Order Delivery Position" + "Order Delivery" ], - "summary": "Delete a Order Delivery Position resource.", + "summary": "Delete a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDeliveryPosition", + "operationId": "deleteOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -25460,16 +31924,16 @@ }, "patch": { "tags": [ - "Order Delivery Position" + "Order Delivery" ], - "summary": "Partially update information about a Order Delivery Position resource.", + "summary": "Partially update information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDeliveryPosition", + "operationId": "updateOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -25487,14 +31951,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Delivery Position resource.", + "description": "Partially update information about a Order Delivery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" }, "included": { "type": "array", @@ -25508,14 +31972,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25527,7 +31991,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -25536,7 +32000,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDelivery" + } + } } } } @@ -25553,14 +32025,14 @@ } } }, - "/order-line-item": { + "/order-delivery-position": { "get": { "tags": [ - "Order Line Item" + "Order Delivery Position" ], - "summary": "List with basic information of Order Line Item resources.", + "summary": "List with basic information of Order Delivery Position resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItemList", + "operationId": "getOrderDeliveryPositionList", "parameters": [ { "name": "limit", @@ -25589,7 +32061,7 @@ ], "responses": { "200": { - "description": "List of Order Line Item resources.", + "description": "List of Order Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25608,7 +32080,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } ] @@ -25622,16 +32094,16 @@ "type": "object", "properties": { "first": { - "example": "/order-line-item?limit=25" + "example": "/order-delivery-position?limit=25" }, "last": { - "example": "/order-line-item?limit=25&page=11" + "example": "/order-delivery-position?limit=25&page=11" }, "next": { - "example": "/order-line-item?limit=25&page=4" + "example": "/order-delivery-position?limit=25&page=4" }, "prev": { - "example": "/order-line-item?limit=25&page=2" + "example": "/order-delivery-position?limit=25&page=2" } } } @@ -25652,7 +32124,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25667,11 +32139,11 @@ }, "post": { "tags": [ - "Order Line Item" + "Order Delivery Position" ], - "summary": "Create a new Order Line Item resources.", + "summary": "Create a new Order Delivery Position resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderLineItem", + "operationId": "createOrderDeliveryPosition", "parameters": [ { "name": "_response", @@ -25693,7 +32165,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" }, "included": { "type": "array", @@ -25707,14 +32179,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25726,7 +32198,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25735,7 +32207,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } } } } @@ -25749,19 +32229,93 @@ } } }, - "/order-line-item/{id}": { + "/search/order-delivery-position": { + "post": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Search for the Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderDeliveryPosition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-delivery-position/{id}": { "get": { "tags": [ - "Order Line Item" + "Order Delivery Position" ], - "summary": "Detailed information about a Order Line Item resource.", + "summary": "Detailed information about a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItem", + "operationId": "getOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -25771,7 +32325,7 @@ ], "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25783,7 +32337,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25792,7 +32346,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } } } } @@ -25807,16 +32369,16 @@ }, "delete": { "tags": [ - "Order Line Item" + "Order Delivery Position" ], - "summary": "Delete a Order Line Item resource.", + "summary": "Delete a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderLineItem", + "operationId": "deleteOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -25847,16 +32409,16 @@ }, "patch": { "tags": [ - "Order Line Item" + "Order Delivery Position" ], - "summary": "Partially update information about a Order Line Item resource.", + "summary": "Partially update information about a Order Delivery Position resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderLineItem", + "operationId": "updateOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -25874,14 +32436,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Line Item resource.", + "description": "Partially update information about a Order Delivery Position resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" }, "included": { "type": "array", @@ -25895,14 +32457,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25914,7 +32476,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -25923,7 +32485,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } } } } @@ -25940,14 +32510,14 @@ } } }, - "/order-line-item-download": { + "/order-line-item": { "get": { "tags": [ - "Order Line Item Download" + "Order Line Item" ], - "summary": "List with basic information of Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownloadList", + "summary": "List with basic information of Order Line Item resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderLineItemList", "parameters": [ { "name": "limit", @@ -25976,7 +32546,7 @@ ], "responses": { "200": { - "description": "List of Order Line Item Download resources.", + "description": "List of Order Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25995,7 +32565,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } ] @@ -26009,16 +32579,16 @@ "type": "object", "properties": { "first": { - "example": "/order-line-item-download?limit=25" + "example": "/order-line-item?limit=25" }, "last": { - "example": "/order-line-item-download?limit=25&page=11" + "example": "/order-line-item?limit=25&page=11" }, "next": { - "example": "/order-line-item-download?limit=25&page=4" + "example": "/order-line-item?limit=25&page=4" }, "prev": { - "example": "/order-line-item-download?limit=25&page=2" + "example": "/order-line-item?limit=25&page=2" } } } @@ -26039,7 +32609,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -26054,11 +32624,11 @@ }, "post": { "tags": [ - "Order Line Item Download" + "Order Line Item" ], - "summary": "Create a new Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createOrderLineItemDownload", + "summary": "Create a new Order Line Item resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderLineItem", "parameters": [ { "name": "_response", @@ -26080,7 +32650,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" }, "included": { "type": "array", @@ -26094,14 +32664,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26113,7 +32683,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -26122,7 +32692,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + } + } } } } @@ -26136,19 +32714,93 @@ } } }, - "/order-line-item-download/{id}": { + "/search/order-line-item": { + "post": { + "tags": [ + "Order Line Item" + ], + "summary": "Search for the Order Line Item resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderLineItem", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-line-item/{id}": { "get": { "tags": [ - "Order Line Item Download" + "Order Line Item" ], - "summary": "Detailed information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownload", + "summary": "Detailed information about a Order Line Item resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -26158,7 +32810,7 @@ ], "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26170,7 +32822,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -26179,7 +32831,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + } + } } } } @@ -26194,16 +32854,16 @@ }, "delete": { "tags": [ - "Order Line Item Download" + "Order Line Item" ], - "summary": "Delete a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteOrderLineItemDownload", + "summary": "Delete a Order Line Item resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -26234,16 +32894,16 @@ }, "patch": { "tags": [ - "Order Line Item Download" + "Order Line Item" ], - "summary": "Partially update information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateOrderLineItemDownload", + "summary": "Partially update information about a Order Line Item resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -26261,14 +32921,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Line Item Download resource.", + "description": "Partially update information about a Order Line Item resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" }, "included": { "type": "array", @@ -26282,14 +32942,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26301,7 +32961,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -26310,7 +32970,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItem" + } + } } } } @@ -26327,14 +32995,14 @@ } } }, - "/order-transaction": { + "/order-line-item-download": { "get": { "tags": [ - "Order Transaction" + "Order Line Item Download" ], - "summary": "List with basic information of Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransactionList", + "summary": "List with basic information of Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownloadList", "parameters": [ { "name": "limit", @@ -26363,7 +33031,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction resources.", + "description": "List of Order Line Item Download resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26382,7 +33050,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } ] @@ -26396,16 +33064,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction?limit=25" + "example": "/order-line-item-download?limit=25" }, "last": { - "example": "/order-transaction?limit=25&page=11" + "example": "/order-line-item-download?limit=25&page=11" }, "next": { - "example": "/order-transaction?limit=25&page=4" + "example": "/order-line-item-download?limit=25&page=4" }, "prev": { - "example": "/order-transaction?limit=25&page=2" + "example": "/order-line-item-download?limit=25&page=2" } } } @@ -26426,7 +33094,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26441,11 +33109,11 @@ }, "post": { "tags": [ - "Order Transaction" + "Order Line Item Download" ], - "summary": "Create a new Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createOrderTransaction", + "summary": "Create a new Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createOrderLineItemDownload", "parameters": [ { "name": "_response", @@ -26467,7 +33135,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" }, "included": { "type": "array", @@ -26481,14 +33149,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -26500,7 +33168,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26509,7 +33177,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } } } } @@ -26523,19 +33199,93 @@ } } }, - "/order-transaction/{id}": { + "/search/order-line-item-download": { + "post": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Search for the Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "searchOrderLineItemDownload", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-line-item-download/{id}": { "get": { "tags": [ - "Order Transaction" + "Order Line Item Download" ], - "summary": "Detailed information about a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransaction", + "summary": "Detailed information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -26545,7 +33295,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -26557,7 +33307,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26566,7 +33316,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } } } } @@ -26581,16 +33339,16 @@ }, "delete": { "tags": [ - "Order Transaction" + "Order Line Item Download" ], - "summary": "Delete a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderTransaction", + "summary": "Delete a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -26621,16 +33379,16 @@ }, "patch": { "tags": [ - "Order Transaction" + "Order Line Item Download" ], - "summary": "Partially update information about a Order Transaction resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateOrderTransaction", + "summary": "Partially update information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -26648,14 +33406,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction resource.", + "description": "Partially update information about a Order Line Item Download resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" }, "included": { "type": "array", @@ -26669,14 +33427,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -26688,7 +33446,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -26697,7 +33455,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } } } } @@ -26714,14 +33480,14 @@ } } }, - "/order-transaction-capture": { + "/order-transaction": { "get": { "tags": [ - "Order Transaction Capture" + "Order Transaction" ], - "summary": "List with basic information of Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureList", + "summary": "List with basic information of Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransactionList", "parameters": [ { "name": "limit", @@ -26750,7 +33516,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture resources.", + "description": "List of Order Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26769,7 +33535,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } ] @@ -26783,16 +33549,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture?limit=25" + "example": "/order-transaction?limit=25" }, "last": { - "example": "/order-transaction-capture?limit=25&page=11" + "example": "/order-transaction?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture?limit=25&page=4" + "example": "/order-transaction?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture?limit=25&page=2" + "example": "/order-transaction?limit=25&page=2" } } } @@ -26813,7 +33579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26828,11 +33594,11 @@ }, "post": { "tags": [ - "Order Transaction Capture" + "Order Transaction" ], - "summary": "Create a new Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCapture", + "summary": "Create a new Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderTransaction", "parameters": [ { "name": "_response", @@ -26854,7 +33620,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" }, "included": { "type": "array", @@ -26868,14 +33634,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26887,7 +33653,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26896,7 +33662,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + } + } } } } @@ -26910,19 +33684,93 @@ } } }, - "/order-transaction-capture/{id}": { + "/search/order-transaction": { + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Search for the Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderTransaction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction/{id}": { "get": { "tags": [ - "Order Transaction Capture" + "Order Transaction" ], - "summary": "Detailed information about a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCapture", + "summary": "Detailed information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -26932,7 +33780,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -26944,7 +33792,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -26953,7 +33801,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + } + } } } } @@ -26968,16 +33824,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture" + "Order Transaction" ], - "summary": "Delete a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCapture", + "summary": "Delete a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -27008,16 +33864,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture" + "Order Transaction" ], - "summary": "Partially update information about a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCapture", + "summary": "Partially update information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -27035,14 +33891,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture resource.", + "description": "Partially update information about a Order Transaction resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" }, "included": { "type": "array", @@ -27056,14 +33912,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27075,7 +33931,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -27084,7 +33940,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransaction" + } + } } } } @@ -27101,14 +33965,14 @@ } } }, - "/order-transaction-capture-refund": { + "/order-transaction-capture": { "get": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture" ], - "summary": "List with basic information of Order Transaction Capture Refund resources.", + "summary": "List with basic information of Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundList", + "operationId": "getOrderTransactionCaptureList", "parameters": [ { "name": "limit", @@ -27137,7 +34001,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture Refund resources.", + "description": "List of Order Transaction Capture resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27156,7 +34020,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } ] @@ -27170,16 +34034,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture-refund?limit=25" + "example": "/order-transaction-capture?limit=25" }, "last": { - "example": "/order-transaction-capture-refund?limit=25&page=11" + "example": "/order-transaction-capture?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture-refund?limit=25&page=4" + "example": "/order-transaction-capture?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture-refund?limit=25&page=2" + "example": "/order-transaction-capture?limit=25&page=2" } } } @@ -27200,7 +34064,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -27215,11 +34079,11 @@ }, "post": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture" ], - "summary": "Create a new Order Transaction Capture Refund resources.", + "summary": "Create a new Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefund", + "operationId": "createOrderTransactionCapture", "parameters": [ { "name": "_response", @@ -27241,7 +34105,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" }, "included": { "type": "array", @@ -27255,14 +34119,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -27274,7 +34138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -27283,7 +34147,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } } } } @@ -27297,19 +34169,93 @@ } } }, - "/order-transaction-capture-refund/{id}": { + "/search/order-transaction-capture": { + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Search for the Order Transaction Capture resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCapture", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture/{id}": { "get": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture" ], - "summary": "Detailed information about a Order Transaction Capture Refund resource.", + "summary": "Detailed information about a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefund", + "operationId": "getOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -27319,7 +34265,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -27331,7 +34277,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -27340,7 +34286,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } } } } @@ -27355,16 +34309,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture" ], - "summary": "Delete a Order Transaction Capture Refund resource.", + "summary": "Delete a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefund", + "operationId": "deleteOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -27395,16 +34349,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction Capture" ], - "summary": "Partially update information about a Order Transaction Capture Refund resource.", + "summary": "Partially update information about a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefund", + "operationId": "updateOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -27422,14 +34376,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture Refund resource.", + "description": "Partially update information about a Order Transaction Capture resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" }, "included": { "type": "array", @@ -27443,14 +34397,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -27462,7 +34416,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -27471,7 +34425,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } } } } @@ -27488,14 +34450,14 @@ } } }, - "/order-transaction-capture-refund-position": { + "/order-transaction-capture-refund": { "get": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture Refund" ], - "summary": "List with basic information of Order Transaction Capture Refund Position resources.", + "summary": "List with basic information of Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPositionList", + "operationId": "getOrderTransactionCaptureRefundList", "parameters": [ { "name": "limit", @@ -27524,7 +34486,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture Refund Position resources.", + "description": "List of Order Transaction Capture Refund resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27543,7 +34505,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } ] @@ -27557,16 +34519,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture-refund-position?limit=25" + "example": "/order-transaction-capture-refund?limit=25" }, "last": { - "example": "/order-transaction-capture-refund-position?limit=25&page=11" + "example": "/order-transaction-capture-refund?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture-refund-position?limit=25&page=4" + "example": "/order-transaction-capture-refund?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture-refund-position?limit=25&page=2" + "example": "/order-transaction-capture-refund?limit=25&page=2" } } } @@ -27587,7 +34549,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27602,11 +34564,11 @@ }, "post": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture Refund" ], - "summary": "Create a new Order Transaction Capture Refund Position resources.", + "summary": "Create a new Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefundPosition", + "operationId": "createOrderTransactionCaptureRefund", "parameters": [ { "name": "_response", @@ -27628,7 +34590,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" }, "included": { "type": "array", @@ -27642,14 +34604,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -27661,7 +34623,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27670,7 +34632,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } } } } @@ -27684,19 +34654,93 @@ } } }, - "/order-transaction-capture-refund-position/{id}": { + "/search/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Search for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund/{id}": { "get": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture Refund" ], - "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", + "summary": "Detailed information about a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPosition", + "operationId": "getOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -27706,7 +34750,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -27718,7 +34762,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27727,7 +34771,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } } } } @@ -27742,16 +34794,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture Refund" ], - "summary": "Delete a Order Transaction Capture Refund Position resource.", + "summary": "Delete a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefundPosition", + "operationId": "deleteOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -27782,16 +34834,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture Refund" ], - "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", + "summary": "Partially update information about a Order Transaction Capture Refund resource.", "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefundPosition", + "operationId": "updateOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -27809,14 +34861,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture Refund Position resource.", + "description": "Partially update information about a Order Transaction Capture Refund resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" }, "included": { "type": "array", @@ -27830,14 +34882,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -27849,7 +34901,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -27858,7 +34910,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } } } } @@ -27875,14 +34935,14 @@ } } }, - "/payment-method": { + "/order-transaction-capture-refund-position": { "get": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund Position" ], - "summary": "List with basic information of Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethodList", + "summary": "List with basic information of Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundPositionList", "parameters": [ { "name": "limit", @@ -27911,7 +34971,7 @@ ], "responses": { "200": { - "description": "List of Payment Method resources.", + "description": "List of Order Transaction Capture Refund Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27930,7 +34990,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } ] @@ -27944,16 +35004,16 @@ "type": "object", "properties": { "first": { - "example": "/payment-method?limit=25" + "example": "/order-transaction-capture-refund-position?limit=25" }, "last": { - "example": "/payment-method?limit=25&page=11" + "example": "/order-transaction-capture-refund-position?limit=25&page=11" }, "next": { - "example": "/payment-method?limit=25&page=4" + "example": "/order-transaction-capture-refund-position?limit=25&page=4" }, "prev": { - "example": "/payment-method?limit=25&page=2" + "example": "/order-transaction-capture-refund-position?limit=25&page=2" } } } @@ -27974,7 +35034,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -27989,11 +35049,11 @@ }, "post": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund Position" ], - "summary": "Create a new Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPaymentMethod", + "summary": "Create a new Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "_response", @@ -28015,7 +35075,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" }, "included": { "type": "array", @@ -28029,14 +35089,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -28048,7 +35108,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -28057,7 +35117,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } } } } @@ -28071,19 +35139,93 @@ } } }, - "/payment-method/{id}": { + "/search/order-transaction-capture-refund-position": { + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Search for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefundPosition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund-position/{id}": { "get": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund Position" ], - "summary": "Detailed information about a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethod", + "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -28093,7 +35235,7 @@ ], "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -28105,7 +35247,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -28114,7 +35256,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } } } } @@ -28129,16 +35279,16 @@ }, "delete": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund Position" ], - "summary": "Delete a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePaymentMethod", + "summary": "Delete a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -28169,16 +35319,16 @@ }, "patch": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund Position" ], - "summary": "Partially update information about a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePaymentMethod", + "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -28196,14 +35346,14 @@ } ], "requestBody": { - "description": "Partially update information about a Payment Method resource.", + "description": "Partially update information about a Order Transaction Capture Refund Position resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" }, "included": { "type": "array", @@ -28217,14 +35367,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -28236,7 +35386,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -28245,7 +35395,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } } } } @@ -28262,14 +35420,14 @@ } } }, - "/plugin": { + "/payment-method": { "get": { "tags": [ - "Plugin" + "Payment Method" ], - "summary": "List with basic information of Plugin resources.", + "summary": "List with basic information of Payment Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPluginList", + "operationId": "getPaymentMethodList", "parameters": [ { "name": "limit", @@ -28298,7 +35456,7 @@ ], "responses": { "200": { - "description": "List of Plugin resources.", + "description": "List of Payment Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28317,7 +35475,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } ] @@ -28331,16 +35489,16 @@ "type": "object", "properties": { "first": { - "example": "/plugin?limit=25" + "example": "/payment-method?limit=25" }, "last": { - "example": "/plugin?limit=25&page=11" + "example": "/payment-method?limit=25&page=11" }, "next": { - "example": "/plugin?limit=25&page=4" + "example": "/payment-method?limit=25&page=4" }, "prev": { - "example": "/plugin?limit=25&page=2" + "example": "/payment-method?limit=25&page=2" } } } @@ -28361,7 +35519,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28376,11 +35534,11 @@ }, "post": { "tags": [ - "Plugin" + "Payment Method" ], - "summary": "Create a new Plugin resources.", + "summary": "Create a new Payment Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPlugin", + "operationId": "createPaymentMethod", "parameters": [ { "name": "_response", @@ -28402,7 +35560,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" }, "included": { "type": "array", @@ -28416,14 +35574,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -28435,7 +35593,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28444,7 +35602,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + } + } } } } @@ -28458,19 +35624,93 @@ } } }, - "/plugin/{id}": { + "/search/payment-method": { + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Search for the Payment Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/payment-method/{id}": { "get": { "tags": [ - "Plugin" + "Payment Method" ], - "summary": "Detailed information about a Plugin resource.", + "summary": "Detailed information about a Payment Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPlugin", + "operationId": "getPaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -28480,7 +35720,7 @@ ], "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -28492,7 +35732,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28501,7 +35741,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + } + } } } } @@ -28516,16 +35764,16 @@ }, "delete": { "tags": [ - "Plugin" + "Payment Method" ], - "summary": "Delete a Plugin resource.", + "summary": "Delete a Payment Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePlugin", + "operationId": "deletePaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -28556,16 +35804,16 @@ }, "patch": { "tags": [ - "Plugin" + "Payment Method" ], - "summary": "Partially update information about a Plugin resource.", + "summary": "Partially update information about a Payment Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePlugin", + "operationId": "updatePaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -28583,14 +35831,14 @@ } ], "requestBody": { - "description": "Partially update information about a Plugin resource.", + "description": "Partially update information about a Payment Method resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" }, "included": { "type": "array", @@ -28604,14 +35852,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -28623,7 +35871,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -28632,7 +35880,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PaymentMethod" + } + } } } } @@ -28649,14 +35905,14 @@ } } }, - "/product": { + "/plugin": { "get": { "tags": [ - "Product" + "Plugin" ], - "summary": "List with basic information of Product resources.", + "summary": "List with basic information of Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductList", + "operationId": "getPluginList", "parameters": [ { "name": "limit", @@ -28685,7 +35941,7 @@ ], "responses": { "200": { - "description": "List of Product resources.", + "description": "List of Plugin resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28704,7 +35960,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } ] @@ -28718,16 +35974,16 @@ "type": "object", "properties": { "first": { - "example": "/product?limit=25" + "example": "/plugin?limit=25" }, "last": { - "example": "/product?limit=25&page=11" + "example": "/plugin?limit=25&page=11" }, "next": { - "example": "/product?limit=25&page=4" + "example": "/plugin?limit=25&page=4" }, "prev": { - "example": "/product?limit=25&page=2" + "example": "/plugin?limit=25&page=2" } } } @@ -28748,7 +36004,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } } @@ -28763,11 +36019,11 @@ }, "post": { "tags": [ - "Product" + "Plugin" ], - "summary": "Create a new Product resources.", + "summary": "Create a new Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProduct", + "operationId": "createPlugin", "parameters": [ { "name": "_response", @@ -28789,7 +36045,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" }, "included": { "type": "array", @@ -28803,14 +36059,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -28822,7 +36078,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } } @@ -28831,7 +36087,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + } + } } } } @@ -28845,19 +36109,93 @@ } } }, - "/product/{id}": { + "/search/plugin": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Search for the Plugin resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPlugin", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/plugin/{id}": { "get": { "tags": [ - "Product" + "Plugin" ], - "summary": "Detailed information about a Product resource.", + "summary": "Detailed information about a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProduct", + "operationId": "getPlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -28867,7 +36205,7 @@ ], "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -28879,7 +36217,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } } @@ -28888,7 +36226,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + } + } } } } @@ -28903,16 +36249,16 @@ }, "delete": { "tags": [ - "Product" + "Plugin" ], - "summary": "Delete a Product resource.", + "summary": "Delete a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProduct", + "operationId": "deletePlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -28943,16 +36289,16 @@ }, "patch": { "tags": [ - "Product" + "Plugin" ], - "summary": "Partially update information about a Product resource.", + "summary": "Partially update information about a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProduct", + "operationId": "updatePlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -28970,14 +36316,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product resource.", + "description": "Partially update information about a Plugin resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" }, "included": { "type": "array", @@ -28991,14 +36337,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -29010,7 +36356,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Plugin" } } } @@ -29019,7 +36365,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Plugin" + } + } } } } @@ -29036,14 +36390,14 @@ } } }, - "/product-configurator-setting": { + "/product": { "get": { "tags": [ - "Product Configurator Setting" + "Product" ], - "summary": "List with basic information of Product Configurator Setting resources.", + "summary": "List with basic information of Product resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSettingList", + "operationId": "getProductList", "parameters": [ { "name": "limit", @@ -29072,7 +36426,7 @@ ], "responses": { "200": { - "description": "List of Product Configurator Setting resources.", + "description": "List of Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29091,7 +36445,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } ] @@ -29105,16 +36459,16 @@ "type": "object", "properties": { "first": { - "example": "/product-configurator-setting?limit=25" + "example": "/product?limit=25" }, "last": { - "example": "/product-configurator-setting?limit=25&page=11" + "example": "/product?limit=25&page=11" }, "next": { - "example": "/product-configurator-setting?limit=25&page=4" + "example": "/product?limit=25&page=4" }, "prev": { - "example": "/product-configurator-setting?limit=25&page=2" + "example": "/product?limit=25&page=2" } } } @@ -29135,7 +36489,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } } @@ -29150,11 +36504,11 @@ }, "post": { "tags": [ - "Product Configurator Setting" + "Product" ], - "summary": "Create a new Product Configurator Setting resources.", + "summary": "Create a new Product resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductConfiguratorSetting", + "operationId": "createProduct", "parameters": [ { "name": "_response", @@ -29176,7 +36530,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" }, "included": { "type": "array", @@ -29190,14 +36544,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -29209,7 +36563,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } } @@ -29218,7 +36572,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + } + } } } } @@ -29232,19 +36594,93 @@ } } }, - "/product-configurator-setting/{id}": { + "/search/product": { + "post": { + "tags": [ + "Product" + ], + "summary": "Search for the Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProduct", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product/{id}": { "get": { "tags": [ - "Product Configurator Setting" + "Product" ], - "summary": "Detailed information about a Product Configurator Setting resource.", + "summary": "Detailed information about a Product resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSetting", + "operationId": "getProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -29254,7 +36690,7 @@ ], "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -29266,7 +36702,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } } @@ -29275,7 +36711,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + } + } } } } @@ -29290,16 +36734,16 @@ }, "delete": { "tags": [ - "Product Configurator Setting" + "Product" ], - "summary": "Delete a Product Configurator Setting resource.", + "summary": "Delete a Product resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductConfiguratorSetting", + "operationId": "deleteProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -29330,16 +36774,16 @@ }, "patch": { "tags": [ - "Product Configurator Setting" + "Product" ], - "summary": "Partially update information about a Product Configurator Setting resource.", + "summary": "Partially update information about a Product resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductConfiguratorSetting", + "operationId": "updateProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -29357,14 +36801,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Configurator Setting resource.", + "description": "Partially update information about a Product resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" }, "included": { "type": "array", @@ -29378,14 +36822,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -29397,7 +36841,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Product" } } } @@ -29406,7 +36850,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Product" + } + } } } } @@ -29423,14 +36875,14 @@ } } }, - "/product-cross-selling": { + "/product-configurator-setting": { "get": { "tags": [ - "Product Cross Selling" + "Product Configurator Setting" ], - "summary": "List with basic information of Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSellingList", + "summary": "List with basic information of Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductConfiguratorSettingList", "parameters": [ { "name": "limit", @@ -29459,7 +36911,7 @@ ], "responses": { "200": { - "description": "List of Product Cross Selling resources.", + "description": "List of Product Configurator Setting resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29478,7 +36930,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } ] @@ -29492,16 +36944,16 @@ "type": "object", "properties": { "first": { - "example": "/product-cross-selling?limit=25" + "example": "/product-configurator-setting?limit=25" }, "last": { - "example": "/product-cross-selling?limit=25&page=11" + "example": "/product-configurator-setting?limit=25&page=11" }, "next": { - "example": "/product-cross-selling?limit=25&page=4" + "example": "/product-configurator-setting?limit=25&page=4" }, "prev": { - "example": "/product-cross-selling?limit=25&page=2" + "example": "/product-configurator-setting?limit=25&page=2" } } } @@ -29522,7 +36974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29537,11 +36989,11 @@ }, "post": { "tags": [ - "Product Cross Selling" + "Product Configurator Setting" ], - "summary": "Create a new Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductCrossSelling", + "summary": "Create a new Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductConfiguratorSetting", "parameters": [ { "name": "_response", @@ -29563,7 +37015,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" }, "included": { "type": "array", @@ -29577,14 +37029,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -29596,7 +37048,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29605,7 +37057,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } } } } @@ -29619,19 +37079,93 @@ } } }, - "/product-cross-selling/{id}": { + "/search/product-configurator-setting": { + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Search for the Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductConfiguratorSetting", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-configurator-setting/{id}": { "get": { "tags": [ - "Product Cross Selling" + "Product Configurator Setting" ], - "summary": "Detailed information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSelling", + "summary": "Detailed information about a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -29641,7 +37175,7 @@ ], "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -29653,7 +37187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29662,7 +37196,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } } } } @@ -29677,16 +37219,16 @@ }, "delete": { "tags": [ - "Product Cross Selling" + "Product Configurator Setting" ], - "summary": "Delete a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductCrossSelling", + "summary": "Delete a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -29717,16 +37259,16 @@ }, "patch": { "tags": [ - "Product Cross Selling" + "Product Configurator Setting" ], - "summary": "Partially update information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductCrossSelling", + "summary": "Partially update information about a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -29744,14 +37286,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Cross Selling resource.", + "description": "Partially update information about a Product Configurator Setting resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" }, "included": { "type": "array", @@ -29765,14 +37307,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -29784,7 +37326,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -29793,7 +37335,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } } } } @@ -29810,14 +37360,14 @@ } } }, - "/product-cross-selling-assigned-products": { + "/product-cross-selling": { "get": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Cross Selling" ], - "summary": "List with basic information of Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProductsList", + "summary": "List with basic information of Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSellingList", "parameters": [ { "name": "limit", @@ -29846,7 +37396,7 @@ ], "responses": { "200": { - "description": "List of Product Cross Selling Assigned Products resources.", + "description": "List of Product Cross Selling resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29865,7 +37415,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } ] @@ -29879,16 +37429,16 @@ "type": "object", "properties": { "first": { - "example": "/product-cross-selling-assigned-products?limit=25" + "example": "/product-cross-selling?limit=25" }, "last": { - "example": "/product-cross-selling-assigned-products?limit=25&page=11" + "example": "/product-cross-selling?limit=25&page=11" }, "next": { - "example": "/product-cross-selling-assigned-products?limit=25&page=4" + "example": "/product-cross-selling?limit=25&page=4" }, "prev": { - "example": "/product-cross-selling-assigned-products?limit=25&page=2" + "example": "/product-cross-selling?limit=25&page=2" } } } @@ -29909,7 +37459,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29924,11 +37474,11 @@ }, "post": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Cross Selling" ], - "summary": "Create a new Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createProductCrossSellingAssignedProducts", + "summary": "Create a new Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductCrossSelling", "parameters": [ { "name": "_response", @@ -29950,7 +37500,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" }, "included": { "type": "array", @@ -29964,14 +37514,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -29983,7 +37533,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -29992,7 +37542,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } } } } @@ -30006,19 +37564,93 @@ } } }, - "/product-cross-selling-assigned-products/{id}": { + "/search/product-cross-selling": { + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Search for the Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchProductCrossSelling", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-cross-selling/{id}": { "get": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Cross Selling" ], - "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProducts", + "summary": "Detailed information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -30028,7 +37660,7 @@ ], "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -30040,7 +37672,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -30049,7 +37681,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } } } } @@ -30064,16 +37704,16 @@ }, "delete": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Cross Selling" ], - "summary": "Delete a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteProductCrossSellingAssignedProducts", + "summary": "Delete a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -30104,16 +37744,16 @@ }, "patch": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Cross Selling" ], - "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateProductCrossSellingAssignedProducts", + "summary": "Partially update information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -30131,14 +37771,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Partially update information about a Product Cross Selling resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" }, "included": { "type": "array", @@ -30152,14 +37792,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -30171,7 +37811,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -30180,7 +37820,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } } } } @@ -30197,14 +37845,14 @@ } } }, - "/product-download": { + "/product-cross-selling-assigned-products": { "get": { "tags": [ - "Product Download" + "Product Cross Selling Assigned Products" ], - "summary": "List with basic information of Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownloadList", + "summary": "List with basic information of Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProductsList", "parameters": [ { "name": "limit", @@ -30233,7 +37881,7 @@ ], "responses": { "200": { - "description": "List of Product Download resources.", + "description": "List of Product Cross Selling Assigned Products resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30252,7 +37900,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } ] @@ -30266,16 +37914,16 @@ "type": "object", "properties": { "first": { - "example": "/product-download?limit=25" + "example": "/product-cross-selling-assigned-products?limit=25" }, "last": { - "example": "/product-download?limit=25&page=11" + "example": "/product-cross-selling-assigned-products?limit=25&page=11" }, "next": { - "example": "/product-download?limit=25&page=4" + "example": "/product-cross-selling-assigned-products?limit=25&page=4" }, "prev": { - "example": "/product-download?limit=25&page=2" + "example": "/product-cross-selling-assigned-products?limit=25&page=2" } } } @@ -30296,7 +37944,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30311,11 +37959,11 @@ }, "post": { "tags": [ - "Product Download" + "Product Cross Selling Assigned Products" ], - "summary": "Create a new Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createProductDownload", + "summary": "Create a new Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createProductCrossSellingAssignedProducts", "parameters": [ { "name": "_response", @@ -30337,7 +37985,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" }, "included": { "type": "array", @@ -30351,14 +37999,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -30370,7 +38018,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30379,7 +38027,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } } } } @@ -30393,19 +38049,93 @@ } } }, - "/product-download/{id}": { + "/search/product-cross-selling-assigned-products": { + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Search for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "searchProductCrossSellingAssignedProducts", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-cross-selling-assigned-products/{id}": { "get": { "tags": [ - "Product Download" + "Product Cross Selling Assigned Products" ], - "summary": "Detailed information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownload", + "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -30415,7 +38145,7 @@ ], "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -30427,7 +38157,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30436,7 +38166,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } } } } @@ -30451,16 +38189,16 @@ }, "delete": { "tags": [ - "Product Download" + "Product Cross Selling Assigned Products" ], - "summary": "Delete a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteProductDownload", + "summary": "Delete a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -30491,16 +38229,16 @@ }, "patch": { "tags": [ - "Product Download" + "Product Cross Selling Assigned Products" ], - "summary": "Partially update information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateProductDownload", + "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -30518,14 +38256,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Download resource.", + "description": "Partially update information about a Product Cross Selling Assigned Products resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" }, "included": { "type": "array", @@ -30539,14 +38277,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -30558,7 +38296,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -30567,7 +38305,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } } } } @@ -30584,14 +38330,14 @@ } } }, - "/product-export": { + "/product-download": { "get": { "tags": [ - "Product Export" + "Product Download" ], - "summary": "List with basic information of Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExportList", + "summary": "List with basic information of Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownloadList", "parameters": [ { "name": "limit", @@ -30620,7 +38366,7 @@ ], "responses": { "200": { - "description": "List of Product Export resources.", + "description": "List of Product Download resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30639,7 +38385,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } ] @@ -30653,16 +38399,16 @@ "type": "object", "properties": { "first": { - "example": "/product-export?limit=25" + "example": "/product-download?limit=25" }, "last": { - "example": "/product-export?limit=25&page=11" + "example": "/product-download?limit=25&page=11" }, "next": { - "example": "/product-export?limit=25&page=4" + "example": "/product-download?limit=25&page=4" }, "prev": { - "example": "/product-export?limit=25&page=2" + "example": "/product-download?limit=25&page=2" } } } @@ -30683,7 +38429,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30698,11 +38444,11 @@ }, "post": { "tags": [ - "Product Export" + "Product Download" ], - "summary": "Create a new Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductExport", + "summary": "Create a new Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createProductDownload", "parameters": [ { "name": "_response", @@ -30724,7 +38470,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" }, "included": { "type": "array", @@ -30738,14 +38484,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -30757,7 +38503,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30766,7 +38512,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + } + } } } } @@ -30780,19 +38534,93 @@ } } }, - "/product-export/{id}": { + "/search/product-download": { + "post": { + "tags": [ + "Product Download" + ], + "summary": "Search for the Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "searchProductDownload", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-download/{id}": { "get": { "tags": [ - "Product Export" + "Product Download" ], - "summary": "Detailed information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExport", + "summary": "Detailed information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -30802,7 +38630,7 @@ ], "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -30814,7 +38642,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30823,7 +38651,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + } + } } } } @@ -30838,16 +38674,16 @@ }, "delete": { "tags": [ - "Product Export" + "Product Download" ], - "summary": "Delete a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductExport", + "summary": "Delete a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -30878,16 +38714,16 @@ }, "patch": { "tags": [ - "Product Export" + "Product Download" ], - "summary": "Partially update information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductExport", + "summary": "Partially update information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -30905,14 +38741,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Export resource.", + "description": "Partially update information about a Product Download resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" }, "included": { "type": "array", @@ -30926,14 +38762,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -30945,7 +38781,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -30954,7 +38790,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductDownload" + } + } } } } @@ -30971,14 +38815,14 @@ } } }, - "/product-feature-set": { + "/product-export": { "get": { "tags": [ - "Product Feature Set" + "Product Export" ], - "summary": "List with basic information of Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSetList", + "summary": "List with basic information of Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExportList", "parameters": [ { "name": "limit", @@ -31007,7 +38851,7 @@ ], "responses": { "200": { - "description": "List of Product Feature Set resources.", + "description": "List of Product Export resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31026,7 +38870,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } ] @@ -31040,16 +38884,16 @@ "type": "object", "properties": { "first": { - "example": "/product-feature-set?limit=25" + "example": "/product-export?limit=25" }, "last": { - "example": "/product-feature-set?limit=25&page=11" + "example": "/product-export?limit=25&page=11" }, "next": { - "example": "/product-feature-set?limit=25&page=4" + "example": "/product-export?limit=25&page=4" }, "prev": { - "example": "/product-feature-set?limit=25&page=2" + "example": "/product-export?limit=25&page=2" } } } @@ -31070,7 +38914,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } } @@ -31085,11 +38929,11 @@ }, "post": { "tags": [ - "Product Feature Set" + "Product Export" ], - "summary": "Create a new Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "createProductFeatureSet", + "summary": "Create a new Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductExport", "parameters": [ { "name": "_response", @@ -31111,7 +38955,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" }, "included": { "type": "array", @@ -31125,14 +38969,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -31144,7 +38988,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } } @@ -31153,7 +38997,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + } + } } } } @@ -31167,19 +39019,93 @@ } } }, - "/product-feature-set/{id}": { + "/search/product-export": { + "post": { + "tags": [ + "Product Export" + ], + "summary": "Search for the Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchProductExport", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-export/{id}": { "get": { "tags": [ - "Product Feature Set" + "Product Export" ], - "summary": "Detailed information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSet", + "summary": "Detailed information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -31189,7 +39115,7 @@ ], "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -31201,7 +39127,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } } @@ -31210,7 +39136,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + } + } } } } @@ -31225,16 +39159,16 @@ }, "delete": { "tags": [ - "Product Feature Set" + "Product Export" ], - "summary": "Delete a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "deleteProductFeatureSet", + "summary": "Delete a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -31265,16 +39199,16 @@ }, "patch": { "tags": [ - "Product Feature Set" + "Product Export" ], - "summary": "Partially update information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "updateProductFeatureSet", + "summary": "Partially update information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -31292,14 +39226,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Feature Set resource.", + "description": "Partially update information about a Product Export resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" }, "included": { "type": "array", @@ -31313,14 +39247,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -31332,7 +39266,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductExport" } } } @@ -31341,7 +39275,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductExport" + } + } } } } @@ -31358,14 +39300,14 @@ } } }, - "/product-keyword-dictionary": { + "/product-feature-set": { "get": { "tags": [ - "Product Keyword Dictionary" + "Product Feature Set" ], - "summary": "List with basic information of Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionaryList", + "summary": "List with basic information of Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSetList", "parameters": [ { "name": "limit", @@ -31394,7 +39336,7 @@ ], "responses": { "200": { - "description": "List of Product Keyword Dictionary resources.", + "description": "List of Product Feature Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31413,7 +39355,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } ] @@ -31427,16 +39369,16 @@ "type": "object", "properties": { "first": { - "example": "/product-keyword-dictionary?limit=25" + "example": "/product-feature-set?limit=25" }, "last": { - "example": "/product-keyword-dictionary?limit=25&page=11" + "example": "/product-feature-set?limit=25&page=11" }, "next": { - "example": "/product-keyword-dictionary?limit=25&page=4" + "example": "/product-feature-set?limit=25&page=4" }, "prev": { - "example": "/product-keyword-dictionary?limit=25&page=2" + "example": "/product-feature-set?limit=25&page=2" } } } @@ -31457,7 +39399,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31472,11 +39414,11 @@ }, "post": { "tags": [ - "Product Keyword Dictionary" + "Product Feature Set" ], - "summary": "Create a new Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductKeywordDictionary", + "summary": "Create a new Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "createProductFeatureSet", "parameters": [ { "name": "_response", @@ -31498,7 +39440,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" }, "included": { "type": "array", @@ -31512,14 +39454,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -31531,7 +39473,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31540,7 +39482,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } } } } @@ -31554,19 +39504,93 @@ } } }, - "/product-keyword-dictionary/{id}": { + "/search/product-feature-set": { + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Search for the Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "searchProductFeatureSet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-feature-set/{id}": { "get": { "tags": [ - "Product Keyword Dictionary" + "Product Feature Set" ], - "summary": "Detailed information about a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionary", + "summary": "Detailed information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -31576,7 +39600,7 @@ ], "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -31588,7 +39612,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31597,7 +39621,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } } } } @@ -31612,16 +39644,16 @@ }, "delete": { "tags": [ - "Product Keyword Dictionary" + "Product Feature Set" ], - "summary": "Delete a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductKeywordDictionary", + "summary": "Delete a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "deleteProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -31652,16 +39684,16 @@ }, "patch": { "tags": [ - "Product Keyword Dictionary" + "Product Feature Set" ], - "summary": "Partially update information about a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductKeywordDictionary", + "summary": "Partially update information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "updateProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -31679,14 +39711,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Keyword Dictionary resource.", + "description": "Partially update information about a Product Feature Set resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" }, "included": { "type": "array", @@ -31700,14 +39732,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -31719,7 +39751,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -31728,7 +39760,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } } } } @@ -31745,14 +39785,14 @@ } } }, - "/product-manufacturer": { + "/product-keyword-dictionary": { "get": { "tags": [ - "Product Manufacturer" + "Product Keyword Dictionary" ], - "summary": "List with basic information of Product Manufacturer resources.", + "summary": "List with basic information of Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturerList", + "operationId": "getProductKeywordDictionaryList", "parameters": [ { "name": "limit", @@ -31781,7 +39821,7 @@ ], "responses": { "200": { - "description": "List of Product Manufacturer resources.", + "description": "List of Product Keyword Dictionary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31800,7 +39840,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } ] @@ -31814,16 +39854,16 @@ "type": "object", "properties": { "first": { - "example": "/product-manufacturer?limit=25" + "example": "/product-keyword-dictionary?limit=25" }, "last": { - "example": "/product-manufacturer?limit=25&page=11" + "example": "/product-keyword-dictionary?limit=25&page=11" }, "next": { - "example": "/product-manufacturer?limit=25&page=4" + "example": "/product-keyword-dictionary?limit=25&page=4" }, "prev": { - "example": "/product-manufacturer?limit=25&page=2" + "example": "/product-keyword-dictionary?limit=25&page=2" } } } @@ -31844,7 +39884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31859,11 +39899,11 @@ }, "post": { "tags": [ - "Product Manufacturer" + "Product Keyword Dictionary" ], - "summary": "Create a new Product Manufacturer resources.", + "summary": "Create a new Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductManufacturer", + "operationId": "createProductKeywordDictionary", "parameters": [ { "name": "_response", @@ -31885,7 +39925,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" }, "included": { "type": "array", @@ -31899,14 +39939,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -31918,7 +39958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31927,7 +39967,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } } } } @@ -31941,19 +39989,93 @@ } } }, - "/product-manufacturer/{id}": { + "/search/product-keyword-dictionary": { + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Search for the Product Keyword Dictionary resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductKeywordDictionary", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-keyword-dictionary/{id}": { "get": { "tags": [ - "Product Manufacturer" + "Product Keyword Dictionary" ], - "summary": "Detailed information about a Product Manufacturer resource.", + "summary": "Detailed information about a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturer", + "operationId": "getProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -31963,7 +40085,7 @@ ], "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -31975,7 +40097,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -31984,7 +40106,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } } } } @@ -31999,16 +40129,16 @@ }, "delete": { "tags": [ - "Product Manufacturer" + "Product Keyword Dictionary" ], - "summary": "Delete a Product Manufacturer resource.", + "summary": "Delete a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductManufacturer", + "operationId": "deleteProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -32039,16 +40169,16 @@ }, "patch": { "tags": [ - "Product Manufacturer" + "Product Keyword Dictionary" ], - "summary": "Partially update information about a Product Manufacturer resource.", + "summary": "Partially update information about a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductManufacturer", + "operationId": "updateProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -32066,14 +40196,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Manufacturer resource.", + "description": "Partially update information about a Product Keyword Dictionary resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" }, "included": { "type": "array", @@ -32087,14 +40217,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -32106,7 +40236,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -32115,7 +40245,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } } } } @@ -32132,14 +40270,14 @@ } } }, - "/product-media": { + "/product-manufacturer": { "get": { "tags": [ - "Product Media" + "Product Manufacturer" ], - "summary": "List with basic information of Product Media resources.", + "summary": "List with basic information of Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductMediaList", + "operationId": "getProductManufacturerList", "parameters": [ { "name": "limit", @@ -32168,7 +40306,7 @@ ], "responses": { "200": { - "description": "List of Product Media resources.", + "description": "List of Product Manufacturer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32187,7 +40325,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } ] @@ -32201,16 +40339,16 @@ "type": "object", "properties": { "first": { - "example": "/product-media?limit=25" + "example": "/product-manufacturer?limit=25" }, "last": { - "example": "/product-media?limit=25&page=11" + "example": "/product-manufacturer?limit=25&page=11" }, "next": { - "example": "/product-media?limit=25&page=4" + "example": "/product-manufacturer?limit=25&page=4" }, "prev": { - "example": "/product-media?limit=25&page=2" + "example": "/product-manufacturer?limit=25&page=2" } } } @@ -32231,7 +40369,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -32246,11 +40384,11 @@ }, "post": { "tags": [ - "Product Media" + "Product Manufacturer" ], - "summary": "Create a new Product Media resources.", + "summary": "Create a new Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductMedia", + "operationId": "createProductManufacturer", "parameters": [ { "name": "_response", @@ -32272,7 +40410,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" }, "included": { "type": "array", @@ -32286,14 +40424,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -32305,7 +40443,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -32314,7 +40452,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } } } } @@ -32328,19 +40474,93 @@ } } }, - "/product-media/{id}": { + "/search/product-manufacturer": { + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Search for the Product Manufacturer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductManufacturer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-manufacturer/{id}": { "get": { "tags": [ - "Product Media" + "Product Manufacturer" ], - "summary": "Detailed information about a Product Media resource.", + "summary": "Detailed information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductMedia", + "operationId": "getProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -32350,7 +40570,7 @@ ], "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -32362,7 +40582,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -32371,7 +40591,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } } } } @@ -32386,16 +40614,16 @@ }, "delete": { "tags": [ - "Product Media" + "Product Manufacturer" ], - "summary": "Delete a Product Media resource.", + "summary": "Delete a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductMedia", + "operationId": "deleteProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -32426,16 +40654,16 @@ }, "patch": { "tags": [ - "Product Media" + "Product Manufacturer" ], - "summary": "Partially update information about a Product Media resource.", + "summary": "Partially update information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductMedia", + "operationId": "updateProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -32453,14 +40681,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Media resource.", + "description": "Partially update information about a Product Manufacturer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" }, "included": { "type": "array", @@ -32474,14 +40702,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -32493,7 +40721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -32502,7 +40730,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } } } } @@ -32519,14 +40755,14 @@ } } }, - "/product-price": { + "/product-media": { "get": { "tags": [ - "Product Price" + "Product Media" ], - "summary": "List with basic information of Product Price resources.", + "summary": "List with basic information of Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductPriceList", + "operationId": "getProductMediaList", "parameters": [ { "name": "limit", @@ -32555,7 +40791,7 @@ ], "responses": { "200": { - "description": "List of Product Price resources.", + "description": "List of Product Media resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32574,7 +40810,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } ] @@ -32588,16 +40824,16 @@ "type": "object", "properties": { "first": { - "example": "/product-price?limit=25" + "example": "/product-media?limit=25" }, "last": { - "example": "/product-price?limit=25&page=11" + "example": "/product-media?limit=25&page=11" }, "next": { - "example": "/product-price?limit=25&page=4" + "example": "/product-media?limit=25&page=4" }, "prev": { - "example": "/product-price?limit=25&page=2" + "example": "/product-media?limit=25&page=2" } } } @@ -32618,7 +40854,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32633,11 +40869,11 @@ }, "post": { "tags": [ - "Product Price" + "Product Media" ], - "summary": "Create a new Product Price resources.", + "summary": "Create a new Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductPrice", + "operationId": "createProductMedia", "parameters": [ { "name": "_response", @@ -32659,7 +40895,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" }, "included": { "type": "array", @@ -32673,14 +40909,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -32692,7 +40928,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32701,7 +40937,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + } + } } } } @@ -32715,19 +40959,93 @@ } } }, - "/product-price/{id}": { + "/search/product-media": { + "post": { + "tags": [ + "Product Media" + ], + "summary": "Search for the Product Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductMedia", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-media/{id}": { "get": { "tags": [ - "Product Price" + "Product Media" ], - "summary": "Detailed information about a Product Price resource.", + "summary": "Detailed information about a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductPrice", + "operationId": "getProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -32737,7 +41055,7 @@ ], "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -32749,7 +41067,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32758,7 +41076,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + } + } } } } @@ -32773,16 +41099,16 @@ }, "delete": { "tags": [ - "Product Price" + "Product Media" ], - "summary": "Delete a Product Price resource.", + "summary": "Delete a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductPrice", + "operationId": "deleteProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -32813,16 +41139,16 @@ }, "patch": { "tags": [ - "Product Price" + "Product Media" ], - "summary": "Partially update information about a Product Price resource.", + "summary": "Partially update information about a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductPrice", + "operationId": "updateProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -32840,14 +41166,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Price resource.", + "description": "Partially update information about a Product Media resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" }, "included": { "type": "array", @@ -32861,14 +41187,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -32880,7 +41206,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -32889,7 +41215,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductMedia" + } + } } } } @@ -32906,14 +41240,14 @@ } } }, - "/product-review": { + "/product-price": { "get": { "tags": [ - "Product Review" + "Product Price" ], - "summary": "List with basic information of Product Review resources.", + "summary": "List with basic information of Product Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductReviewList", + "operationId": "getProductPriceList", "parameters": [ { "name": "limit", @@ -32942,7 +41276,7 @@ ], "responses": { "200": { - "description": "List of Product Review resources.", + "description": "List of Product Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32961,7 +41295,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } ] @@ -32975,16 +41309,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review?limit=25" + "example": "/product-price?limit=25" }, "last": { - "example": "/product-review?limit=25&page=11" + "example": "/product-price?limit=25&page=11" }, "next": { - "example": "/product-review?limit=25&page=4" + "example": "/product-price?limit=25&page=4" }, "prev": { - "example": "/product-review?limit=25&page=2" + "example": "/product-price?limit=25&page=2" } } } @@ -33005,7 +41339,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -33020,11 +41354,11 @@ }, "post": { "tags": [ - "Product Review" + "Product Price" ], - "summary": "Create a new Product Review resources.", + "summary": "Create a new Product Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductReview", + "operationId": "createProductPrice", "parameters": [ { "name": "_response", @@ -33046,7 +41380,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" }, "included": { "type": "array", @@ -33060,14 +41394,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -33079,7 +41413,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -33088,7 +41422,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + } + } } } } @@ -33102,19 +41444,93 @@ } } }, - "/product-review/{id}": { + "/search/product-price": { + "post": { + "tags": [ + "Product Price" + ], + "summary": "Search for the Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductPrice", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-price/{id}": { "get": { "tags": [ - "Product Review" + "Product Price" ], - "summary": "Detailed information about a Product Review resource.", + "summary": "Detailed information about a Product Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductReview", + "operationId": "getProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -33124,7 +41540,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -33136,7 +41552,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -33145,7 +41561,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + } + } } } } @@ -33160,16 +41584,16 @@ }, "delete": { "tags": [ - "Product Review" + "Product Price" ], - "summary": "Delete a Product Review resource.", + "summary": "Delete a Product Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductReview", + "operationId": "deleteProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -33200,16 +41624,16 @@ }, "patch": { "tags": [ - "Product Review" + "Product Price" ], - "summary": "Partially update information about a Product Review resource.", + "summary": "Partially update information about a Product Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductReview", + "operationId": "updateProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -33227,14 +41651,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review resource.", + "description": "Partially update information about a Product Price resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" }, "included": { "type": "array", @@ -33248,14 +41672,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -33267,7 +41691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -33276,7 +41700,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductPrice" + } + } } } } @@ -33293,14 +41725,14 @@ } } }, - "/product-search-config": { + "/product-review": { "get": { "tags": [ - "Product Search Config" + "Product Review" ], - "summary": "List with basic information of Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigList", + "summary": "List with basic information of Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductReviewList", "parameters": [ { "name": "limit", @@ -33329,7 +41761,7 @@ ], "responses": { "200": { - "description": "List of Product Search Config resources.", + "description": "List of Product Review resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33348,7 +41780,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } ] @@ -33362,16 +41794,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-config?limit=25" + "example": "/product-review?limit=25" }, "last": { - "example": "/product-search-config?limit=25&page=11" + "example": "/product-review?limit=25&page=11" }, "next": { - "example": "/product-search-config?limit=25&page=4" + "example": "/product-review?limit=25&page=4" }, "prev": { - "example": "/product-search-config?limit=25&page=2" + "example": "/product-review?limit=25&page=2" } } } @@ -33392,7 +41824,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33407,11 +41839,11 @@ }, "post": { "tags": [ - "Product Search Config" + "Product Review" ], - "summary": "Create a new Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfig", + "summary": "Create a new Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductReview", "parameters": [ { "name": "_response", @@ -33433,7 +41865,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" }, "included": { "type": "array", @@ -33447,14 +41879,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -33466,7 +41898,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33475,7 +41907,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + } + } } } } @@ -33489,19 +41929,93 @@ } } }, - "/product-search-config/{id}": { + "/search/product-review": { + "post": { + "tags": [ + "Product Review" + ], + "summary": "Search for the Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductReview", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review/{id}": { "get": { "tags": [ - "Product Search Config" + "Product Review" ], - "summary": "Detailed information about a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfig", + "summary": "Detailed information about a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -33511,7 +42025,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -33523,7 +42037,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33532,7 +42046,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + } + } } } } @@ -33547,16 +42069,16 @@ }, "delete": { "tags": [ - "Product Search Config" + "Product Review" ], - "summary": "Delete a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfig", + "summary": "Delete a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -33587,16 +42109,16 @@ }, "patch": { "tags": [ - "Product Search Config" + "Product Review" ], - "summary": "Partially update information about a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfig", + "summary": "Partially update information about a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -33614,14 +42136,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Config resource.", + "description": "Partially update information about a Product Review resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" }, "included": { "type": "array", @@ -33635,14 +42157,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -33654,7 +42176,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductReview" } } } @@ -33663,7 +42185,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReview" + } + } } } } @@ -33680,14 +42210,14 @@ } } }, - "/product-search-config-field": { + "/product-search-config": { "get": { "tags": [ - "Product Search Config Field" + "Product Search Config" ], - "summary": "List with basic information of Product Search Config Field resources.", + "summary": "List with basic information of Product Search Config resources.", "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigFieldList", + "operationId": "getProductSearchConfigList", "parameters": [ { "name": "limit", @@ -33716,7 +42246,7 @@ ], "responses": { "200": { - "description": "List of Product Search Config Field resources.", + "description": "List of Product Search Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33735,7 +42265,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } ] @@ -33749,16 +42279,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-config-field?limit=25" + "example": "/product-search-config?limit=25" }, "last": { - "example": "/product-search-config-field?limit=25&page=11" + "example": "/product-search-config?limit=25&page=11" }, "next": { - "example": "/product-search-config-field?limit=25&page=4" + "example": "/product-search-config?limit=25&page=4" }, "prev": { - "example": "/product-search-config-field?limit=25&page=2" + "example": "/product-search-config?limit=25&page=2" } } } @@ -33779,7 +42309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33794,11 +42324,11 @@ }, "post": { "tags": [ - "Product Search Config Field" + "Product Search Config" ], - "summary": "Create a new Product Search Config Field resources.", + "summary": "Create a new Product Search Config resources.", "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfigField", + "operationId": "createProductSearchConfig", "parameters": [ { "name": "_response", @@ -33820,7 +42350,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" }, "included": { "type": "array", @@ -33834,14 +42364,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -33853,7 +42383,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33862,7 +42392,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } } } } @@ -33876,19 +42414,93 @@ } } }, - "/product-search-config-field/{id}": { + "/search/product-search-config": { + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Search for the Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchProductSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-config/{id}": { "get": { "tags": [ - "Product Search Config Field" + "Product Search Config" ], - "summary": "Detailed information about a Product Search Config Field resource.", + "summary": "Detailed information about a Product Search Config resource.", "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigField", + "operationId": "getProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -33898,7 +42510,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -33910,7 +42522,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -33919,7 +42531,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } } } } @@ -33934,16 +42554,16 @@ }, "delete": { "tags": [ - "Product Search Config Field" + "Product Search Config" ], - "summary": "Delete a Product Search Config Field resource.", + "summary": "Delete a Product Search Config resource.", "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfigField", + "operationId": "deleteProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -33974,16 +42594,16 @@ }, "patch": { "tags": [ - "Product Search Config Field" + "Product Search Config" ], - "summary": "Partially update information about a Product Search Config Field resource.", + "summary": "Partially update information about a Product Search Config resource.", "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfigField", + "operationId": "updateProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -34001,14 +42621,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Config Field resource.", + "description": "Partially update information about a Product Search Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" }, "included": { "type": "array", @@ -34022,14 +42642,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -34041,7 +42661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -34050,7 +42670,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } } } } @@ -34067,14 +42695,14 @@ } } }, - "/product-search-keyword": { + "/product-search-config-field": { "get": { "tags": [ - "Product Search Keyword" + "Product Search Config Field" ], - "summary": "List with basic information of Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeywordList", + "summary": "List with basic information of Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigFieldList", "parameters": [ { "name": "limit", @@ -34103,7 +42731,7 @@ ], "responses": { "200": { - "description": "List of Product Search Keyword resources.", + "description": "List of Product Search Config Field resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34122,7 +42750,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } ] @@ -34136,16 +42764,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-keyword?limit=25" + "example": "/product-search-config-field?limit=25" }, "last": { - "example": "/product-search-keyword?limit=25&page=11" + "example": "/product-search-config-field?limit=25&page=11" }, "next": { - "example": "/product-search-keyword?limit=25&page=4" + "example": "/product-search-config-field?limit=25&page=4" }, "prev": { - "example": "/product-search-keyword?limit=25&page=2" + "example": "/product-search-config-field?limit=25&page=2" } } } @@ -34166,7 +42794,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -34181,11 +42809,11 @@ }, "post": { "tags": [ - "Product Search Keyword" + "Product Search Config Field" ], - "summary": "Create a new Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductSearchKeyword", + "summary": "Create a new Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createProductSearchConfigField", "parameters": [ { "name": "_response", @@ -34207,7 +42835,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" }, "included": { "type": "array", @@ -34221,14 +42849,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -34240,7 +42868,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -34249,7 +42877,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } } } } @@ -34263,19 +42899,93 @@ } } }, - "/product-search-keyword/{id}": { + "/search/product-search-config-field": { + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Search for the Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchProductSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-config-field/{id}": { "get": { "tags": [ - "Product Search Keyword" + "Product Search Config Field" ], - "summary": "Detailed information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeyword", + "summary": "Detailed information about a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -34285,7 +42995,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -34297,7 +43007,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -34306,7 +43016,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } } } } @@ -34321,16 +43039,16 @@ }, "delete": { "tags": [ - "Product Search Keyword" + "Product Search Config Field" ], - "summary": "Delete a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductSearchKeyword", + "summary": "Delete a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -34361,16 +43079,16 @@ }, "patch": { "tags": [ - "Product Search Keyword" + "Product Search Config Field" ], - "summary": "Partially update information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductSearchKeyword", + "summary": "Partially update information about a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -34388,14 +43106,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Keyword resource.", + "description": "Partially update information about a Product Search Config Field resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" }, "included": { "type": "array", @@ -34409,14 +43127,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -34428,7 +43146,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -34437,7 +43155,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } } } } @@ -34454,14 +43180,14 @@ } } }, - "/product-sorting": { + "/product-search-keyword": { "get": { "tags": [ - "Product Sorting" + "Product Search Keyword" ], - "summary": "List with basic information of Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSortingList", + "summary": "List with basic information of Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductSearchKeywordList", "parameters": [ { "name": "limit", @@ -34490,7 +43216,7 @@ ], "responses": { "200": { - "description": "List of Product Sorting resources.", + "description": "List of Product Search Keyword resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34509,7 +43235,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } ] @@ -34523,16 +43249,16 @@ "type": "object", "properties": { "first": { - "example": "/product-sorting?limit=25" + "example": "/product-search-keyword?limit=25" }, "last": { - "example": "/product-sorting?limit=25&page=11" + "example": "/product-search-keyword?limit=25&page=11" }, "next": { - "example": "/product-sorting?limit=25&page=4" + "example": "/product-search-keyword?limit=25&page=4" }, "prev": { - "example": "/product-sorting?limit=25&page=2" + "example": "/product-search-keyword?limit=25&page=2" } } } @@ -34553,7 +43279,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34568,11 +43294,11 @@ }, "post": { "tags": [ - "Product Sorting" + "Product Search Keyword" ], - "summary": "Create a new Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "createProductSorting", + "summary": "Create a new Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductSearchKeyword", "parameters": [ { "name": "_response", @@ -34594,7 +43320,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" }, "included": { "type": "array", @@ -34608,14 +43334,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -34627,7 +43353,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34636,7 +43362,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } } } } @@ -34650,19 +43384,93 @@ } } }, - "/product-sorting/{id}": { + "/search/product-search-keyword": { + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Search for the Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductSearchKeyword", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-search-keyword/{id}": { "get": { "tags": [ - "Product Sorting" + "Product Search Keyword" ], - "summary": "Detailed information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSorting", + "summary": "Detailed information about a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -34672,7 +43480,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -34684,7 +43492,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34693,7 +43501,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } } } } @@ -34708,16 +43524,16 @@ }, "delete": { "tags": [ - "Product Sorting" + "Product Search Keyword" ], - "summary": "Delete a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "deleteProductSorting", + "summary": "Delete a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -34748,16 +43564,16 @@ }, "patch": { "tags": [ - "Product Sorting" + "Product Search Keyword" ], - "summary": "Partially update information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "updateProductSorting", + "summary": "Partially update information about a Product Search Keyword resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -34775,14 +43591,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Sorting resource.", + "description": "Partially update information about a Product Search Keyword resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" }, "included": { "type": "array", @@ -34796,14 +43612,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -34815,7 +43631,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -34824,7 +43640,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } } } } @@ -34841,14 +43665,14 @@ } } }, - "/product-stream": { + "/product-sorting": { "get": { "tags": [ - "Product Stream" + "Product Sorting" ], - "summary": "List with basic information of Product Stream resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamList", + "summary": "List with basic information of Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSortingList", "parameters": [ { "name": "limit", @@ -34877,7 +43701,7 @@ ], "responses": { "200": { - "description": "List of Product Stream resources.", + "description": "List of Product Sorting resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34896,7 +43720,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } ] @@ -34910,16 +43734,16 @@ "type": "object", "properties": { "first": { - "example": "/product-stream?limit=25" + "example": "/product-sorting?limit=25" }, "last": { - "example": "/product-stream?limit=25&page=11" + "example": "/product-sorting?limit=25&page=11" }, "next": { - "example": "/product-stream?limit=25&page=4" + "example": "/product-sorting?limit=25&page=4" }, "prev": { - "example": "/product-stream?limit=25&page=2" + "example": "/product-sorting?limit=25&page=2" } } } @@ -34940,7 +43764,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -34955,11 +43779,11 @@ }, "post": { "tags": [ - "Product Stream" + "Product Sorting" ], - "summary": "Create a new Product Stream resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductStream", + "summary": "Create a new Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "createProductSorting", "parameters": [ { "name": "_response", @@ -34981,7 +43805,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" }, "included": { "type": "array", @@ -34995,14 +43819,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -35014,7 +43838,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -35023,7 +43847,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } } } } @@ -35037,19 +43869,93 @@ } } }, - "/product-stream/{id}": { + "/search/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Search for the Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "searchProductSorting", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-sorting/{id}": { "get": { "tags": [ - "Product Stream" + "Product Sorting" ], - "summary": "Detailed information about a Product Stream resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStream", + "summary": "Detailed information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -35059,7 +43965,7 @@ ], "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -35071,7 +43977,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -35080,7 +43986,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } } } } @@ -35095,16 +44009,16 @@ }, "delete": { "tags": [ - "Product Stream" + "Product Sorting" ], - "summary": "Delete a Product Stream resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStream", + "summary": "Delete a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "deleteProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -35135,16 +44049,16 @@ }, "patch": { "tags": [ - "Product Stream" + "Product Sorting" ], - "summary": "Partially update information about a Product Stream resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductStream", + "summary": "Partially update information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "updateProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -35162,14 +44076,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Stream resource.", + "description": "Partially update information about a Product Sorting resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" }, "included": { "type": "array", @@ -35183,14 +44097,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -35202,7 +44116,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -35211,7 +44125,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } } } } @@ -35228,14 +44150,14 @@ } } }, - "/product-stream-filter": { + "/product-stream": { "get": { "tags": [ - "Product Stream Filter" + "Product Stream" ], - "summary": "List with basic information of Product Stream Filter resources.", + "summary": "List with basic information of Product Stream resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilterList", + "operationId": "getProductStreamList", "parameters": [ { "name": "limit", @@ -35264,7 +44186,7 @@ ], "responses": { "200": { - "description": "List of Product Stream Filter resources.", + "description": "List of Product Stream resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35283,7 +44205,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } ] @@ -35297,16 +44219,16 @@ "type": "object", "properties": { "first": { - "example": "/product-stream-filter?limit=25" + "example": "/product-stream?limit=25" }, "last": { - "example": "/product-stream-filter?limit=25&page=11" + "example": "/product-stream?limit=25&page=11" }, "next": { - "example": "/product-stream-filter?limit=25&page=4" + "example": "/product-stream?limit=25&page=4" }, "prev": { - "example": "/product-stream-filter?limit=25&page=2" + "example": "/product-stream?limit=25&page=2" } } } @@ -35327,7 +44249,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35342,11 +44264,11 @@ }, "post": { "tags": [ - "Product Stream Filter" + "Product Stream" ], - "summary": "Create a new Product Stream Filter resources.", + "summary": "Create a new Product Stream resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductStreamFilter", + "operationId": "createProductStream", "parameters": [ { "name": "_response", @@ -35368,7 +44290,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" }, "included": { "type": "array", @@ -35382,14 +44304,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -35401,7 +44323,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35410,7 +44332,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + } + } } } } @@ -35424,19 +44354,93 @@ } } }, - "/product-stream-filter/{id}": { + "/search/product-stream": { + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Search for the Product Stream resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductStream", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-stream/{id}": { "get": { "tags": [ - "Product Stream Filter" + "Product Stream" ], - "summary": "Detailed information about a Product Stream Filter resource.", + "summary": "Detailed information about a Product Stream resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilter", + "operationId": "getProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -35446,7 +44450,7 @@ ], "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -35458,7 +44462,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35467,7 +44471,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + } + } } } } @@ -35482,16 +44494,16 @@ }, "delete": { "tags": [ - "Product Stream Filter" + "Product Stream" ], - "summary": "Delete a Product Stream Filter resource.", + "summary": "Delete a Product Stream resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStreamFilter", + "operationId": "deleteProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -35522,16 +44534,16 @@ }, "patch": { "tags": [ - "Product Stream Filter" + "Product Stream" ], - "summary": "Partially update information about a Product Stream Filter resource.", + "summary": "Partially update information about a Product Stream resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductStreamFilter", + "operationId": "updateProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -35549,14 +44561,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Stream Filter resource.", + "description": "Partially update information about a Product Stream resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" }, "included": { "type": "array", @@ -35570,14 +44582,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -35589,7 +44601,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStream" } } } @@ -35598,7 +44610,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStream" + } + } } } } @@ -35615,14 +44635,14 @@ } } }, - "/product-visibility": { + "/product-stream-filter": { "get": { "tags": [ - "Product Visibility" + "Product Stream Filter" ], - "summary": "List with basic information of Product Visibility resources.", + "summary": "List with basic information of Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibilityList", + "operationId": "getProductStreamFilterList", "parameters": [ { "name": "limit", @@ -35651,7 +44671,7 @@ ], "responses": { "200": { - "description": "List of Product Visibility resources.", + "description": "List of Product Stream Filter resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35670,7 +44690,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } ] @@ -35684,16 +44704,16 @@ "type": "object", "properties": { "first": { - "example": "/product-visibility?limit=25" + "example": "/product-stream-filter?limit=25" }, "last": { - "example": "/product-visibility?limit=25&page=11" + "example": "/product-stream-filter?limit=25&page=11" }, "next": { - "example": "/product-visibility?limit=25&page=4" + "example": "/product-stream-filter?limit=25&page=4" }, "prev": { - "example": "/product-visibility?limit=25&page=2" + "example": "/product-stream-filter?limit=25&page=2" } } } @@ -35714,7 +44734,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35729,11 +44749,11 @@ }, "post": { "tags": [ - "Product Visibility" + "Product Stream Filter" ], - "summary": "Create a new Product Visibility resources.", + "summary": "Create a new Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductVisibility", + "operationId": "createProductStreamFilter", "parameters": [ { "name": "_response", @@ -35755,7 +44775,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" }, "included": { "type": "array", @@ -35769,14 +44789,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -35788,7 +44808,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35797,7 +44817,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } } } } @@ -35811,19 +44839,93 @@ } } }, - "/product-visibility/{id}": { + "/search/product-stream-filter": { + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Search for the Product Stream Filter resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-stream-filter/{id}": { "get": { "tags": [ - "Product Visibility" + "Product Stream Filter" ], - "summary": "Detailed information about a Product Visibility resource.", + "summary": "Detailed information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibility", + "operationId": "getProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -35833,7 +44935,7 @@ ], "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -35845,7 +44947,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35854,7 +44956,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } } } } @@ -35869,16 +44979,16 @@ }, "delete": { "tags": [ - "Product Visibility" + "Product Stream Filter" ], - "summary": "Delete a Product Visibility resource.", + "summary": "Delete a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductVisibility", + "operationId": "deleteProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -35909,16 +45019,16 @@ }, "patch": { "tags": [ - "Product Visibility" + "Product Stream Filter" ], - "summary": "Partially update information about a Product Visibility resource.", + "summary": "Partially update information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductVisibility", + "operationId": "updateProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -35936,14 +45046,14 @@ } ], "requestBody": { - "description": "Partially update information about a Product Visibility resource.", + "description": "Partially update information about a Product Stream Filter resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" }, "included": { "type": "array", @@ -35957,14 +45067,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -35976,7 +45086,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -35985,7 +45095,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } } } } @@ -36002,14 +45120,14 @@ } } }, - "/promotion": { + "/product-visibility": { "get": { "tags": [ - "Promotion" + "Product Visibility" ], - "summary": "List with basic information of Promotion resources.", + "summary": "List with basic information of Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionList", + "operationId": "getProductVisibilityList", "parameters": [ { "name": "limit", @@ -36038,7 +45156,7 @@ ], "responses": { "200": { - "description": "List of Promotion resources.", + "description": "List of Product Visibility resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36057,7 +45175,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } ] @@ -36071,16 +45189,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion?limit=25" + "example": "/product-visibility?limit=25" }, "last": { - "example": "/promotion?limit=25&page=11" + "example": "/product-visibility?limit=25&page=11" }, "next": { - "example": "/promotion?limit=25&page=4" + "example": "/product-visibility?limit=25&page=4" }, "prev": { - "example": "/promotion?limit=25&page=2" + "example": "/product-visibility?limit=25&page=2" } } } @@ -36101,7 +45219,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -36116,11 +45234,11 @@ }, "post": { "tags": [ - "Promotion" + "Product Visibility" ], - "summary": "Create a new Promotion resources.", + "summary": "Create a new Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotion", + "operationId": "createProductVisibility", "parameters": [ { "name": "_response", @@ -36142,7 +45260,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" }, "included": { "type": "array", @@ -36156,14 +45274,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -36175,7 +45293,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -36184,7 +45302,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + } + } } } } @@ -36198,19 +45324,93 @@ } } }, - "/promotion/{id}": { + "/search/product-visibility": { + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Search for the Product Visibility resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductVisibility", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-visibility/{id}": { "get": { "tags": [ - "Promotion" + "Product Visibility" ], - "summary": "Detailed information about a Promotion resource.", + "summary": "Detailed information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotion", + "operationId": "getProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -36220,7 +45420,7 @@ ], "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -36232,7 +45432,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -36241,7 +45441,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + } + } } } } @@ -36256,16 +45464,16 @@ }, "delete": { "tags": [ - "Promotion" + "Product Visibility" ], - "summary": "Delete a Promotion resource.", + "summary": "Delete a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotion", + "operationId": "deleteProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -36296,16 +45504,16 @@ }, "patch": { "tags": [ - "Promotion" + "Product Visibility" ], - "summary": "Partially update information about a Promotion resource.", + "summary": "Partially update information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotion", + "operationId": "updateProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -36323,14 +45531,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion resource.", + "description": "Partially update information about a Product Visibility resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" }, "included": { "type": "array", @@ -36344,14 +45552,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -36363,7 +45571,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -36372,7 +45580,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductVisibility" + } + } } } } @@ -36389,14 +45605,14 @@ } } }, - "/promotion-discount": { + "/promotion": { "get": { "tags": [ - "Promotion Discount" + "Promotion" ], - "summary": "List with basic information of Promotion Discount resources.", + "summary": "List with basic information of Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountList", + "operationId": "getPromotionList", "parameters": [ { "name": "limit", @@ -36425,7 +45641,7 @@ ], "responses": { "200": { - "description": "List of Promotion Discount resources.", + "description": "List of Promotion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36444,7 +45660,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } ] @@ -36458,16 +45674,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-discount?limit=25" + "example": "/promotion?limit=25" }, "last": { - "example": "/promotion-discount?limit=25&page=11" + "example": "/promotion?limit=25&page=11" }, "next": { - "example": "/promotion-discount?limit=25&page=4" + "example": "/promotion?limit=25&page=4" }, "prev": { - "example": "/promotion-discount?limit=25&page=2" + "example": "/promotion?limit=25&page=2" } } } @@ -36488,7 +45704,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } } @@ -36503,11 +45719,11 @@ }, "post": { "tags": [ - "Promotion Discount" + "Promotion" ], - "summary": "Create a new Promotion Discount resources.", + "summary": "Create a new Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscount", + "operationId": "createPromotion", "parameters": [ { "name": "_response", @@ -36529,7 +45745,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" }, "included": { "type": "array", @@ -36543,14 +45759,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -36562,7 +45778,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } } @@ -36571,7 +45787,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + } + } } } } @@ -36585,19 +45809,93 @@ } } }, - "/promotion-discount/{id}": { + "/search/promotion": { + "post": { + "tags": [ + "Promotion" + ], + "summary": "Search for the Promotion resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotion", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion/{id}": { "get": { "tags": [ - "Promotion Discount" + "Promotion" ], - "summary": "Detailed information about a Promotion Discount resource.", + "summary": "Detailed information about a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscount", + "operationId": "getPromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -36607,7 +45905,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -36619,7 +45917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } } @@ -36628,7 +45926,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + } + } } } } @@ -36643,16 +45949,16 @@ }, "delete": { "tags": [ - "Promotion Discount" + "Promotion" ], - "summary": "Delete a Promotion Discount resource.", + "summary": "Delete a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscount", + "operationId": "deletePromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -36683,16 +45989,16 @@ }, "patch": { "tags": [ - "Promotion Discount" + "Promotion" ], - "summary": "Partially update information about a Promotion Discount resource.", + "summary": "Partially update information about a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscount", + "operationId": "updatePromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -36710,14 +46016,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Discount resource.", + "description": "Partially update information about a Promotion resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" }, "included": { "type": "array", @@ -36731,14 +46037,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -36750,7 +46056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/Promotion" } } } @@ -36759,7 +46065,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Promotion" + } + } } } } @@ -36776,14 +46090,14 @@ } } }, - "/promotion-discount-prices": { + "/promotion-discount": { "get": { "tags": [ - "Promotion Discount Prices" + "Promotion Discount" ], - "summary": "List with basic information of Promotion Discount Prices resources.", + "summary": "List with basic information of Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPricesList", + "operationId": "getPromotionDiscountList", "parameters": [ { "name": "limit", @@ -36812,7 +46126,7 @@ ], "responses": { "200": { - "description": "List of Promotion Discount Prices resources.", + "description": "List of Promotion Discount resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36831,7 +46145,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } ] @@ -36845,16 +46159,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-discount-prices?limit=25" + "example": "/promotion-discount?limit=25" }, "last": { - "example": "/promotion-discount-prices?limit=25&page=11" + "example": "/promotion-discount?limit=25&page=11" }, "next": { - "example": "/promotion-discount-prices?limit=25&page=4" + "example": "/promotion-discount?limit=25&page=4" }, "prev": { - "example": "/promotion-discount-prices?limit=25&page=2" + "example": "/promotion-discount?limit=25&page=2" } } } @@ -36875,7 +46189,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36890,11 +46204,11 @@ }, "post": { "tags": [ - "Promotion Discount Prices" + "Promotion Discount" ], - "summary": "Create a new Promotion Discount Prices resources.", + "summary": "Create a new Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscountPrices", + "operationId": "createPromotionDiscount", "parameters": [ { "name": "_response", @@ -36916,7 +46230,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" }, "included": { "type": "array", @@ -36930,14 +46244,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -36949,7 +46263,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -36958,7 +46272,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } } } } @@ -36972,19 +46294,93 @@ } } }, - "/promotion-discount-prices/{id}": { + "/search/promotion-discount": { + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Search for the Promotion Discount resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionDiscount", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-discount/{id}": { "get": { "tags": [ - "Promotion Discount Prices" + "Promotion Discount" ], - "summary": "Detailed information about a Promotion Discount Prices resource.", + "summary": "Detailed information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPrices", + "operationId": "getPromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -36994,7 +46390,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -37006,7 +46402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -37015,7 +46411,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } } } } @@ -37030,16 +46434,16 @@ }, "delete": { "tags": [ - "Promotion Discount Prices" + "Promotion Discount" ], - "summary": "Delete a Promotion Discount Prices resource.", + "summary": "Delete a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscountPrices", + "operationId": "deletePromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -37070,16 +46474,16 @@ }, "patch": { "tags": [ - "Promotion Discount Prices" + "Promotion Discount" ], - "summary": "Partially update information about a Promotion Discount Prices resource.", + "summary": "Partially update information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscountPrices", + "operationId": "updatePromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -37097,14 +46501,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Discount Prices resource.", + "description": "Partially update information about a Promotion Discount resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" }, "included": { "type": "array", @@ -37118,14 +46522,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -37137,7 +46541,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -37146,7 +46550,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } } } } @@ -37163,14 +46575,14 @@ } } }, - "/promotion-individual-code": { + "/promotion-discount-prices": { "get": { "tags": [ - "Promotion Individual Code" + "Promotion Discount Prices" ], - "summary": "List with basic information of Promotion Individual Code resources.", + "summary": "List with basic information of Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCodeList", + "operationId": "getPromotionDiscountPricesList", "parameters": [ { "name": "limit", @@ -37199,7 +46611,7 @@ ], "responses": { "200": { - "description": "List of Promotion Individual Code resources.", + "description": "List of Promotion Discount Prices resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37218,7 +46630,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } ] @@ -37232,16 +46644,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-individual-code?limit=25" + "example": "/promotion-discount-prices?limit=25" }, "last": { - "example": "/promotion-individual-code?limit=25&page=11" + "example": "/promotion-discount-prices?limit=25&page=11" }, "next": { - "example": "/promotion-individual-code?limit=25&page=4" + "example": "/promotion-discount-prices?limit=25&page=4" }, "prev": { - "example": "/promotion-individual-code?limit=25&page=2" + "example": "/promotion-discount-prices?limit=25&page=2" } } } @@ -37262,7 +46674,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37277,11 +46689,11 @@ }, "post": { "tags": [ - "Promotion Individual Code" + "Promotion Discount Prices" ], - "summary": "Create a new Promotion Individual Code resources.", + "summary": "Create a new Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionIndividualCode", + "operationId": "createPromotionDiscountPrices", "parameters": [ { "name": "_response", @@ -37303,7 +46715,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" }, "included": { "type": "array", @@ -37317,14 +46729,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -37336,7 +46748,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37345,7 +46757,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } } } } @@ -37359,19 +46779,93 @@ } } }, - "/promotion-individual-code/{id}": { + "/search/promotion-discount-prices": { + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Search for the Promotion Discount Prices resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionDiscountPrices", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-discount-prices/{id}": { "get": { "tags": [ - "Promotion Individual Code" + "Promotion Discount Prices" ], - "summary": "Detailed information about a Promotion Individual Code resource.", + "summary": "Detailed information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCode", + "operationId": "getPromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -37381,7 +46875,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -37393,7 +46887,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37402,7 +46896,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } } } } @@ -37417,16 +46919,16 @@ }, "delete": { "tags": [ - "Promotion Individual Code" + "Promotion Discount Prices" ], - "summary": "Delete a Promotion Individual Code resource.", + "summary": "Delete a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionIndividualCode", + "operationId": "deletePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -37457,16 +46959,16 @@ }, "patch": { "tags": [ - "Promotion Individual Code" + "Promotion Discount Prices" ], - "summary": "Partially update information about a Promotion Individual Code resource.", + "summary": "Partially update information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionIndividualCode", + "operationId": "updatePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -37484,14 +46986,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Individual Code resource.", + "description": "Partially update information about a Promotion Discount Prices resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" }, "included": { "type": "array", @@ -37505,14 +47007,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -37524,7 +47026,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -37533,7 +47035,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } } } } @@ -37550,14 +47060,14 @@ } } }, - "/promotion-sales-channel": { + "/promotion-individual-code": { "get": { "tags": [ - "Promotion Sales Channel" + "Promotion Individual Code" ], - "summary": "List with basic information of Promotion Sales Channel resources.", + "summary": "List with basic information of Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannelList", + "operationId": "getPromotionIndividualCodeList", "parameters": [ { "name": "limit", @@ -37586,7 +47096,7 @@ ], "responses": { "200": { - "description": "List of Promotion Sales Channel resources.", + "description": "List of Promotion Individual Code resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37605,7 +47115,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } ] @@ -37619,16 +47129,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-sales-channel?limit=25" + "example": "/promotion-individual-code?limit=25" }, "last": { - "example": "/promotion-sales-channel?limit=25&page=11" + "example": "/promotion-individual-code?limit=25&page=11" }, "next": { - "example": "/promotion-sales-channel?limit=25&page=4" + "example": "/promotion-individual-code?limit=25&page=4" }, "prev": { - "example": "/promotion-sales-channel?limit=25&page=2" + "example": "/promotion-individual-code?limit=25&page=2" } } } @@ -37649,7 +47159,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37664,11 +47174,11 @@ }, "post": { "tags": [ - "Promotion Sales Channel" + "Promotion Individual Code" ], - "summary": "Create a new Promotion Sales Channel resources.", + "summary": "Create a new Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSalesChannel", + "operationId": "createPromotionIndividualCode", "parameters": [ { "name": "_response", @@ -37690,7 +47200,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" }, "included": { "type": "array", @@ -37704,14 +47214,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -37723,7 +47233,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37732,7 +47242,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } } } } @@ -37746,19 +47264,93 @@ } } }, - "/promotion-sales-channel/{id}": { + "/search/promotion-individual-code": { + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Search for the Promotion Individual Code resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionIndividualCode", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-individual-code/{id}": { "get": { "tags": [ - "Promotion Sales Channel" + "Promotion Individual Code" ], - "summary": "Detailed information about a Promotion Sales Channel resource.", + "summary": "Detailed information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannel", + "operationId": "getPromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -37768,7 +47360,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -37780,7 +47372,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37789,7 +47381,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } } } } @@ -37804,16 +47404,16 @@ }, "delete": { "tags": [ - "Promotion Sales Channel" + "Promotion Individual Code" ], - "summary": "Delete a Promotion Sales Channel resource.", + "summary": "Delete a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSalesChannel", + "operationId": "deletePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -37844,16 +47444,16 @@ }, "patch": { "tags": [ - "Promotion Sales Channel" + "Promotion Individual Code" ], - "summary": "Partially update information about a Promotion Sales Channel resource.", + "summary": "Partially update information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSalesChannel", + "operationId": "updatePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -37871,14 +47471,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Sales Channel resource.", + "description": "Partially update information about a Promotion Individual Code resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" }, "included": { "type": "array", @@ -37892,14 +47492,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -37911,7 +47511,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -37920,7 +47520,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } } } } @@ -37937,14 +47545,14 @@ } } }, - "/promotion-setgroup": { + "/promotion-sales-channel": { "get": { "tags": [ - "Promotion Setgroup" + "Promotion Sales Channel" ], - "summary": "List with basic information of Promotion Setgroup resources.", + "summary": "List with basic information of Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroupList", + "operationId": "getPromotionSalesChannelList", "parameters": [ { "name": "limit", @@ -37973,7 +47581,7 @@ ], "responses": { "200": { - "description": "List of Promotion Setgroup resources.", + "description": "List of Promotion Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37992,7 +47600,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } ] @@ -38006,16 +47614,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-setgroup?limit=25" + "example": "/promotion-sales-channel?limit=25" }, "last": { - "example": "/promotion-setgroup?limit=25&page=11" + "example": "/promotion-sales-channel?limit=25&page=11" }, "next": { - "example": "/promotion-setgroup?limit=25&page=4" + "example": "/promotion-sales-channel?limit=25&page=4" }, "prev": { - "example": "/promotion-setgroup?limit=25&page=2" + "example": "/promotion-sales-channel?limit=25&page=2" } } } @@ -38036,7 +47644,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -38051,11 +47659,11 @@ }, "post": { "tags": [ - "Promotion Setgroup" + "Promotion Sales Channel" ], - "summary": "Create a new Promotion Setgroup resources.", + "summary": "Create a new Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSetgroup", + "operationId": "createPromotionSalesChannel", "parameters": [ { "name": "_response", @@ -38077,7 +47685,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" }, "included": { "type": "array", @@ -38091,14 +47699,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -38110,7 +47718,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -38119,7 +47727,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } } } } @@ -38133,19 +47749,93 @@ } } }, - "/promotion-setgroup/{id}": { + "/search/promotion-sales-channel": { + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Search for the Promotion Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-sales-channel/{id}": { "get": { "tags": [ - "Promotion Setgroup" + "Promotion Sales Channel" ], - "summary": "Detailed information about a Promotion Setgroup resource.", + "summary": "Detailed information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroup", + "operationId": "getPromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -38155,7 +47845,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -38167,7 +47857,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -38176,7 +47866,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } } } } @@ -38191,16 +47889,16 @@ }, "delete": { "tags": [ - "Promotion Setgroup" + "Promotion Sales Channel" ], - "summary": "Delete a Promotion Setgroup resource.", + "summary": "Delete a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSetgroup", + "operationId": "deletePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -38231,16 +47929,16 @@ }, "patch": { "tags": [ - "Promotion Setgroup" + "Promotion Sales Channel" ], - "summary": "Partially update information about a Promotion Setgroup resource.", + "summary": "Partially update information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSetgroup", + "operationId": "updatePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -38258,14 +47956,14 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Setgroup resource.", + "description": "Partially update information about a Promotion Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" }, "included": { "type": "array", @@ -38279,14 +47977,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -38298,7 +47996,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -38307,7 +48005,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } } } } @@ -38324,14 +48030,14 @@ } } }, - "/property-group": { + "/promotion-setgroup": { "get": { "tags": [ - "Property Group" + "Promotion Setgroup" ], - "summary": "List with basic information of Property Group resources.", + "summary": "List with basic information of Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupList", + "operationId": "getPromotionSetgroupList", "parameters": [ { "name": "limit", @@ -38360,7 +48066,7 @@ ], "responses": { "200": { - "description": "List of Property Group resources.", + "description": "List of Promotion Setgroup resources.", "content": { "application/vnd.api+json": { "schema": { @@ -38379,7 +48085,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } ] @@ -38393,16 +48099,16 @@ "type": "object", "properties": { "first": { - "example": "/property-group?limit=25" + "example": "/promotion-setgroup?limit=25" }, "last": { - "example": "/property-group?limit=25&page=11" + "example": "/promotion-setgroup?limit=25&page=11" }, "next": { - "example": "/property-group?limit=25&page=4" + "example": "/promotion-setgroup?limit=25&page=4" }, "prev": { - "example": "/property-group?limit=25&page=2" + "example": "/promotion-setgroup?limit=25&page=2" } } } @@ -38423,7 +48129,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38438,11 +48144,11 @@ }, "post": { "tags": [ - "Property Group" + "Promotion Setgroup" ], - "summary": "Create a new Property Group resources.", + "summary": "Create a new Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroup", + "operationId": "createPromotionSetgroup", "parameters": [ { "name": "_response", @@ -38464,7 +48170,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" }, "included": { "type": "array", @@ -38478,14 +48184,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -38497,7 +48203,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38506,7 +48212,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } } } } @@ -38520,19 +48234,93 @@ } } }, - "/property-group/{id}": { + "/search/promotion-setgroup": { + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Search for the Promotion Setgroup resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionSetgroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/promotion-setgroup/{id}": { "get": { "tags": [ - "Property Group" + "Promotion Setgroup" ], - "summary": "Detailed information about a Property Group resource.", + "summary": "Detailed information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroup", + "operationId": "getPromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -38542,7 +48330,7 @@ ], "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -38554,7 +48342,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38563,7 +48351,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } } } } @@ -38578,16 +48374,16 @@ }, "delete": { "tags": [ - "Property Group" + "Promotion Setgroup" ], - "summary": "Delete a Property Group resource.", + "summary": "Delete a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroup", + "operationId": "deletePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -38618,16 +48414,16 @@ }, "patch": { "tags": [ - "Property Group" + "Promotion Setgroup" ], - "summary": "Partially update information about a Property Group resource.", + "summary": "Partially update information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroup", + "operationId": "updatePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -38645,14 +48441,14 @@ } ], "requestBody": { - "description": "Partially update information about a Property Group resource.", + "description": "Partially update information about a Promotion Setgroup resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" }, "included": { "type": "array", @@ -38666,14 +48462,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -38685,7 +48481,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -38694,7 +48490,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } } } } @@ -38711,14 +48515,14 @@ } } }, - "/property-group-option": { + "/property-group": { "get": { "tags": [ - "Property Group Option" + "Property Group" ], - "summary": "List with basic information of Property Group Option resources.", + "summary": "List with basic information of Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOptionList", + "operationId": "getPropertyGroupList", "parameters": [ { "name": "limit", @@ -38747,7 +48551,7 @@ ], "responses": { "200": { - "description": "List of Property Group Option resources.", + "description": "List of Property Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -38766,7 +48570,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } ] @@ -38780,16 +48584,16 @@ "type": "object", "properties": { "first": { - "example": "/property-group-option?limit=25" + "example": "/property-group?limit=25" }, "last": { - "example": "/property-group-option?limit=25&page=11" + "example": "/property-group?limit=25&page=11" }, "next": { - "example": "/property-group-option?limit=25&page=4" + "example": "/property-group?limit=25&page=4" }, "prev": { - "example": "/property-group-option?limit=25&page=2" + "example": "/property-group?limit=25&page=2" } } } @@ -38810,7 +48614,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38825,11 +48629,11 @@ }, "post": { "tags": [ - "Property Group Option" + "Property Group" ], - "summary": "Create a new Property Group Option resources.", + "summary": "Create a new Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroupOption", + "operationId": "createPropertyGroup", "parameters": [ { "name": "_response", @@ -38851,7 +48655,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" }, "included": { "type": "array", @@ -38865,14 +48669,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -38884,7 +48688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38893,7 +48697,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + } + } } } } @@ -38907,19 +48719,93 @@ } } }, - "/property-group-option/{id}": { + "/search/property-group": { + "post": { + "tags": [ + "Property Group" + ], + "summary": "Search for the Property Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPropertyGroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/property-group/{id}": { "get": { "tags": [ - "Property Group Option" + "Property Group" ], - "summary": "Detailed information about a Property Group Option resource.", + "summary": "Detailed information about a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOption", + "operationId": "getPropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -38929,7 +48815,7 @@ ], "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -38941,7 +48827,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -38950,7 +48836,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + } + } } } } @@ -38965,16 +48859,16 @@ }, "delete": { "tags": [ - "Property Group Option" + "Property Group" ], - "summary": "Delete a Property Group Option resource.", + "summary": "Delete a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroupOption", + "operationId": "deletePropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -39005,16 +48899,16 @@ }, "patch": { "tags": [ - "Property Group Option" + "Property Group" ], - "summary": "Partially update information about a Property Group Option resource.", + "summary": "Partially update information about a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroupOption", + "operationId": "updatePropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -39032,14 +48926,14 @@ } ], "requestBody": { - "description": "Partially update information about a Property Group Option resource.", + "description": "Partially update information about a Property Group resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" }, "included": { "type": "array", @@ -39053,14 +48947,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -39072,7 +48966,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -39081,7 +48975,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroup" + } + } } } } @@ -39098,14 +49000,14 @@ } } }, - "/rule": { + "/property-group-option": { "get": { "tags": [ - "Rule" + "Property Group Option" ], - "summary": "List with basic information of Rule resources.", + "summary": "List with basic information of Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleList", + "operationId": "getPropertyGroupOptionList", "parameters": [ { "name": "limit", @@ -39134,7 +49036,7 @@ ], "responses": { "200": { - "description": "List of Rule resources.", + "description": "List of Property Group Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39153,7 +49055,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } ] @@ -39167,16 +49069,16 @@ "type": "object", "properties": { "first": { - "example": "/rule?limit=25" + "example": "/property-group-option?limit=25" }, "last": { - "example": "/rule?limit=25&page=11" + "example": "/property-group-option?limit=25&page=11" }, "next": { - "example": "/rule?limit=25&page=4" + "example": "/property-group-option?limit=25&page=4" }, "prev": { - "example": "/rule?limit=25&page=2" + "example": "/property-group-option?limit=25&page=2" } } } @@ -39197,7 +49099,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -39212,11 +49114,11 @@ }, "post": { "tags": [ - "Rule" + "Property Group Option" ], - "summary": "Create a new Rule resources.", + "summary": "Create a new Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "createRule", + "operationId": "createPropertyGroupOption", "parameters": [ { "name": "_response", @@ -39238,7 +49140,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" }, "included": { "type": "array", @@ -39252,14 +49154,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -39271,7 +49173,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -39280,7 +49182,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } } } } @@ -39294,19 +49204,93 @@ } } }, - "/rule/{id}": { + "/search/property-group-option": { + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Search for the Property Group Option resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPropertyGroupOption", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/property-group-option/{id}": { "get": { "tags": [ - "Rule" + "Property Group Option" ], - "summary": "Detailed information about a Rule resource.", + "summary": "Detailed information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "getRule", + "operationId": "getPropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -39316,7 +49300,7 @@ ], "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -39328,7 +49312,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -39337,7 +49321,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } } } } @@ -39352,16 +49344,16 @@ }, "delete": { "tags": [ - "Rule" + "Property Group Option" ], - "summary": "Delete a Rule resource.", + "summary": "Delete a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteRule", + "operationId": "deletePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -39392,16 +49384,16 @@ }, "patch": { "tags": [ - "Rule" + "Property Group Option" ], - "summary": "Partially update information about a Rule resource.", + "summary": "Partially update information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateRule", + "operationId": "updatePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -39419,14 +49411,14 @@ } ], "requestBody": { - "description": "Partially update information about a Rule resource.", + "description": "Partially update information about a Property Group Option resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" }, "included": { "type": "array", @@ -39440,14 +49432,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -39459,7 +49451,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -39468,7 +49460,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } } } } @@ -39485,14 +49485,14 @@ } } }, - "/rule-condition": { + "/rule": { "get": { "tags": [ - "Rule Condition" + "Rule" ], - "summary": "List with basic information of Rule Condition resources.", + "summary": "List with basic information of Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleConditionList", + "operationId": "getRuleList", "parameters": [ { "name": "limit", @@ -39521,7 +49521,7 @@ ], "responses": { "200": { - "description": "List of Rule Condition resources.", + "description": "List of Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39540,7 +49540,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } ] @@ -39554,16 +49554,16 @@ "type": "object", "properties": { "first": { - "example": "/rule-condition?limit=25" + "example": "/rule?limit=25" }, "last": { - "example": "/rule-condition?limit=25&page=11" + "example": "/rule?limit=25&page=11" }, "next": { - "example": "/rule-condition?limit=25&page=4" + "example": "/rule?limit=25&page=4" }, "prev": { - "example": "/rule-condition?limit=25&page=2" + "example": "/rule?limit=25&page=2" } } } @@ -39584,7 +49584,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } } @@ -39599,11 +49599,11 @@ }, "post": { "tags": [ - "Rule Condition" + "Rule" ], - "summary": "Create a new Rule Condition resources.", + "summary": "Create a new Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "createRuleCondition", + "operationId": "createRule", "parameters": [ { "name": "_response", @@ -39625,7 +49625,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" }, "included": { "type": "array", @@ -39639,14 +49639,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -39658,7 +49658,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } } @@ -39667,7 +49667,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + } + } } } } @@ -39681,19 +49689,93 @@ } } }, - "/rule-condition/{id}": { + "/search/rule": { + "post": { + "tags": [ + "Rule" + ], + "summary": "Search for the Rule resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchRule", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/rule/{id}": { "get": { "tags": [ - "Rule Condition" + "Rule" ], - "summary": "Detailed information about a Rule Condition resource.", + "summary": "Detailed information about a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleCondition", + "operationId": "getRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -39703,7 +49785,7 @@ ], "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -39715,7 +49797,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } } @@ -39724,7 +49806,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + } + } } } } @@ -39739,16 +49829,16 @@ }, "delete": { "tags": [ - "Rule Condition" + "Rule" ], - "summary": "Delete a Rule Condition resource.", + "summary": "Delete a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteRuleCondition", + "operationId": "deleteRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -39779,16 +49869,16 @@ }, "patch": { "tags": [ - "Rule Condition" + "Rule" ], - "summary": "Partially update information about a Rule Condition resource.", + "summary": "Partially update information about a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateRuleCondition", + "operationId": "updateRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -39806,14 +49896,14 @@ } ], "requestBody": { - "description": "Partially update information about a Rule Condition resource.", + "description": "Partially update information about a Rule resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" }, "included": { "type": "array", @@ -39827,14 +49917,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -39846,7 +49936,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/Rule" } } } @@ -39855,7 +49945,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Rule" + } + } } } } @@ -39872,14 +49970,14 @@ } } }, - "/sales-channel": { + "/rule-condition": { "get": { "tags": [ - "Sales Channel" + "Rule Condition" ], - "summary": "List with basic information of Sales Channel resources.", + "summary": "List with basic information of Rule Condition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelList", + "operationId": "getRuleConditionList", "parameters": [ { "name": "limit", @@ -39908,7 +50006,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel resources.", + "description": "List of Rule Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39927,7 +50025,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } ] @@ -39941,16 +50039,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel?limit=25" + "example": "/rule-condition?limit=25" }, "last": { - "example": "/sales-channel?limit=25&page=11" + "example": "/rule-condition?limit=25&page=11" }, "next": { - "example": "/sales-channel?limit=25&page=4" + "example": "/rule-condition?limit=25&page=4" }, "prev": { - "example": "/sales-channel?limit=25&page=2" + "example": "/rule-condition?limit=25&page=2" } } } @@ -39971,7 +50069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -39986,11 +50084,11 @@ }, "post": { "tags": [ - "Sales Channel" + "Rule Condition" ], - "summary": "Create a new Sales Channel resources.", + "summary": "Create a new Rule Condition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannel", + "operationId": "createRuleCondition", "parameters": [ { "name": "_response", @@ -40012,7 +50110,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" }, "included": { "type": "array", @@ -40026,14 +50124,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -40045,7 +50143,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -40054,7 +50152,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + } + } } } } @@ -40068,19 +50174,93 @@ } } }, - "/sales-channel/{id}": { + "/search/rule-condition": { + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Search for the Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchRuleCondition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/rule-condition/{id}": { "get": { "tags": [ - "Sales Channel" + "Rule Condition" ], - "summary": "Detailed information about a Sales Channel resource.", + "summary": "Detailed information about a Rule Condition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannel", + "operationId": "getRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -40090,7 +50270,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -40102,7 +50282,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -40111,7 +50291,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + } + } } } } @@ -40126,16 +50314,16 @@ }, "delete": { "tags": [ - "Sales Channel" + "Rule Condition" ], - "summary": "Delete a Sales Channel resource.", + "summary": "Delete a Rule Condition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannel", + "operationId": "deleteRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -40166,16 +50354,16 @@ }, "patch": { "tags": [ - "Sales Channel" + "Rule Condition" ], - "summary": "Partially update information about a Sales Channel resource.", + "summary": "Partially update information about a Rule Condition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannel", + "operationId": "updateRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -40193,14 +50381,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel resource.", + "description": "Partially update information about a Rule Condition resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" }, "included": { "type": "array", @@ -40214,14 +50402,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -40233,7 +50421,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -40242,7 +50430,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/RuleCondition" + } + } } } } @@ -40259,14 +50455,14 @@ } } }, - "/sales-channel-analytics": { + "/sales-channel": { "get": { "tags": [ - "Sales Channel Analytics" + "Sales Channel" ], - "summary": "List with basic information of Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalyticsList", + "summary": "List with basic information of Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannelList", "parameters": [ { "name": "limit", @@ -40295,7 +50491,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Analytics resources.", + "description": "List of Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -40314,7 +50510,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } ] @@ -40328,16 +50524,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-analytics?limit=25" + "example": "/sales-channel?limit=25" }, "last": { - "example": "/sales-channel-analytics?limit=25&page=11" + "example": "/sales-channel?limit=25&page=11" }, "next": { - "example": "/sales-channel-analytics?limit=25&page=4" + "example": "/sales-channel?limit=25&page=4" }, "prev": { - "example": "/sales-channel-analytics?limit=25&page=2" + "example": "/sales-channel?limit=25&page=2" } } } @@ -40358,7 +50554,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40373,11 +50569,11 @@ }, "post": { "tags": [ - "Sales Channel Analytics" + "Sales Channel" ], - "summary": "Create a new Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createSalesChannelAnalytics", + "summary": "Create a new Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannel", "parameters": [ { "name": "_response", @@ -40399,7 +50595,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" }, "included": { "type": "array", @@ -40413,14 +50609,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -40432,7 +50628,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40441,7 +50637,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + } + } } } } @@ -40455,19 +50659,93 @@ } } }, - "/sales-channel-analytics/{id}": { + "/search/sales-channel": { + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Search for the Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel/{id}": { "get": { "tags": [ - "Sales Channel Analytics" + "Sales Channel" ], - "summary": "Detailed information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalytics", + "summary": "Detailed information about a Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -40477,7 +50755,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -40489,7 +50767,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40498,7 +50776,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + } + } } } } @@ -40513,16 +50799,16 @@ }, "delete": { "tags": [ - "Sales Channel Analytics" + "Sales Channel" ], - "summary": "Delete a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteSalesChannelAnalytics", + "summary": "Delete a Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -40553,16 +50839,16 @@ }, "patch": { "tags": [ - "Sales Channel Analytics" + "Sales Channel" ], - "summary": "Partially update information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateSalesChannelAnalytics", + "summary": "Partially update information about a Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -40580,14 +50866,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Analytics resource.", + "description": "Partially update information about a Sales Channel resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" }, "included": { "type": "array", @@ -40601,14 +50887,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -40620,7 +50906,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -40629,7 +50915,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannel" + } + } } } } @@ -40646,14 +50940,14 @@ } } }, - "/sales-channel-domain": { + "/sales-channel-analytics": { "get": { "tags": [ - "Sales Channel Domain" + "Sales Channel Analytics" ], - "summary": "List with basic information of Sales Channel Domain resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomainList", + "summary": "List with basic information of Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalyticsList", "parameters": [ { "name": "limit", @@ -40682,7 +50976,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Domain resources.", + "description": "List of Sales Channel Analytics resources.", "content": { "application/vnd.api+json": { "schema": { @@ -40701,7 +50995,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } ] @@ -40715,16 +51009,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-domain?limit=25" + "example": "/sales-channel-analytics?limit=25" }, "last": { - "example": "/sales-channel-domain?limit=25&page=11" + "example": "/sales-channel-analytics?limit=25&page=11" }, "next": { - "example": "/sales-channel-domain?limit=25&page=4" + "example": "/sales-channel-analytics?limit=25&page=4" }, "prev": { - "example": "/sales-channel-domain?limit=25&page=2" + "example": "/sales-channel-analytics?limit=25&page=2" } } } @@ -40745,7 +51039,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40760,11 +51054,11 @@ }, "post": { "tags": [ - "Sales Channel Domain" + "Sales Channel Analytics" ], - "summary": "Create a new Sales Channel Domain resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelDomain", + "summary": "Create a new Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createSalesChannelAnalytics", "parameters": [ { "name": "_response", @@ -40786,7 +51080,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" }, "included": { "type": "array", @@ -40800,14 +51094,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -40819,7 +51113,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40828,7 +51122,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } } } } @@ -40842,19 +51144,93 @@ } } }, - "/sales-channel-domain/{id}": { + "/search/sales-channel-analytics": { + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Search for the Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "searchSalesChannelAnalytics", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-analytics/{id}": { "get": { "tags": [ - "Sales Channel Domain" + "Sales Channel Analytics" ], - "summary": "Detailed information about a Sales Channel Domain resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomain", + "summary": "Detailed information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -40864,7 +51240,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -40876,7 +51252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -40885,7 +51261,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } } } } @@ -40900,16 +51284,16 @@ }, "delete": { "tags": [ - "Sales Channel Domain" + "Sales Channel Analytics" ], - "summary": "Delete a Sales Channel Domain resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelDomain", + "summary": "Delete a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -40940,16 +51324,16 @@ }, "patch": { "tags": [ - "Sales Channel Domain" + "Sales Channel Analytics" ], - "summary": "Partially update information about a Sales Channel Domain resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelDomain", + "summary": "Partially update information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -40967,14 +51351,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Domain resource.", + "description": "Partially update information about a Sales Channel Analytics resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" }, "included": { "type": "array", @@ -40988,14 +51372,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -41007,7 +51391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -41016,7 +51400,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } } } } @@ -41033,14 +51425,14 @@ } } }, - "/sales-channel-type": { + "/sales-channel-domain": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Domain" ], - "summary": "List with basic information of Sales Channel Type resources.", + "summary": "List with basic information of Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelTypeList", + "operationId": "getSalesChannelDomainList", "parameters": [ { "name": "limit", @@ -41069,7 +51461,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Type resources.", + "description": "List of Sales Channel Domain resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41088,7 +51480,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } ] @@ -41102,16 +51494,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-type?limit=25" + "example": "/sales-channel-domain?limit=25" }, "last": { - "example": "/sales-channel-type?limit=25&page=11" + "example": "/sales-channel-domain?limit=25&page=11" }, "next": { - "example": "/sales-channel-type?limit=25&page=4" + "example": "/sales-channel-domain?limit=25&page=4" }, "prev": { - "example": "/sales-channel-type?limit=25&page=2" + "example": "/sales-channel-domain?limit=25&page=2" } } } @@ -41132,7 +51524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -41147,11 +51539,11 @@ }, "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Domain" ], - "summary": "Create a new Sales Channel Type resources.", + "summary": "Create a new Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", + "operationId": "createSalesChannelDomain", "parameters": [ { "name": "_response", @@ -41173,7 +51565,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" }, "included": { "type": "array", @@ -41187,14 +51579,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -41206,7 +51598,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -41215,7 +51607,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } } } } @@ -41229,19 +51629,93 @@ } } }, - "/sales-channel-type/{id}": { + "/search/sales-channel-domain": { + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Search for the Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannelDomain", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-domain/{id}": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Domain" ], - "summary": "Detailed information about a Sales Channel Type resource.", + "summary": "Detailed information about a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelType", + "operationId": "getSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -41251,7 +51725,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -41263,7 +51737,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -41272,7 +51746,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } } } } @@ -41287,16 +51769,16 @@ }, "delete": { "tags": [ - "Sales Channel Type" + "Sales Channel Domain" ], - "summary": "Delete a Sales Channel Type resource.", + "summary": "Delete a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelType", + "operationId": "deleteSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -41327,16 +51809,16 @@ }, "patch": { "tags": [ - "Sales Channel Type" + "Sales Channel Domain" ], - "summary": "Partially update information about a Sales Channel Type resource.", + "summary": "Partially update information about a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelType", + "operationId": "updateSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -41354,14 +51836,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Type resource.", + "description": "Partially update information about a Sales Channel Domain resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" }, "included": { "type": "array", @@ -41375,14 +51857,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -41394,7 +51876,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -41403,7 +51885,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } } } } @@ -41420,14 +51910,14 @@ } } }, - "/salutation": { + "/sales-channel-type": { "get": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "List with basic information of Salutation resources.", + "summary": "List with basic information of Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", + "operationId": "getSalesChannelTypeList", "parameters": [ { "name": "limit", @@ -41456,7 +51946,7 @@ ], "responses": { "200": { - "description": "List of Salutation resources.", + "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41475,7 +51965,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } ] @@ -41489,16 +51979,16 @@ "type": "object", "properties": { "first": { - "example": "/salutation?limit=25" + "example": "/sales-channel-type?limit=25" }, "last": { - "example": "/salutation?limit=25&page=11" + "example": "/sales-channel-type?limit=25&page=11" }, "next": { - "example": "/salutation?limit=25&page=4" + "example": "/sales-channel-type?limit=25&page=4" }, "prev": { - "example": "/salutation?limit=25&page=2" + "example": "/sales-channel-type?limit=25&page=2" } } } @@ -41519,7 +52009,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41534,11 +52024,11 @@ }, "post": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Create a new Salutation resources.", - "description": "Fetches salutations with a criteria obj.", - "operationId": "createSalutation", + "summary": "Create a new Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelType", "parameters": [ { "name": "_response", @@ -41560,7 +52050,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" }, "included": { "type": "array", @@ -41574,14 +52064,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -41593,7 +52083,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41602,7 +52092,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + } + } } } } @@ -41616,19 +52114,93 @@ } } }, - "/salutation/{id}": { + "/search/sales-channel-type": { + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Search for the Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannelType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sales-channel-type/{id}": { "get": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Detailed information about a Salutation resource.", + "summary": "Detailed information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutation", + "operationId": "getSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -41638,7 +52210,7 @@ ], "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -41650,7 +52222,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41659,7 +52231,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + } + } } } } @@ -41674,16 +52254,16 @@ }, "delete": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Delete a Salutation resource.", + "summary": "Delete a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", + "operationId": "deleteSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -41714,16 +52294,16 @@ }, "patch": { "tags": [ - "Salutation" + "Sales Channel Type" ], - "summary": "Partially update information about a Salutation resource.", + "summary": "Partially update information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalutation", + "operationId": "updateSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -41741,14 +52321,14 @@ } ], "requestBody": { - "description": "Partially update information about a Salutation resource.", + "description": "Partially update information about a Sales Channel Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" }, "included": { "type": "array", @@ -41762,14 +52342,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -41781,7 +52361,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -41790,7 +52370,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SalesChannelType" + } + } } } } @@ -41807,14 +52395,14 @@ } } }, - "/scheduled-task": { + "/salutation": { "get": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "List with basic information of Scheduled Task resources.", + "summary": "List with basic information of Salutation resources.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTaskList", + "operationId": "getSalutationList", "parameters": [ { "name": "limit", @@ -41843,7 +52431,7 @@ ], "responses": { "200": { - "description": "List of Scheduled Task resources.", + "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41862,7 +52450,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } ] @@ -41876,16 +52464,16 @@ "type": "object", "properties": { "first": { - "example": "/scheduled-task?limit=25" + "example": "/salutation?limit=25" }, "last": { - "example": "/scheduled-task?limit=25&page=11" + "example": "/salutation?limit=25&page=11" }, "next": { - "example": "/scheduled-task?limit=25&page=4" + "example": "/salutation?limit=25&page=4" }, "prev": { - "example": "/scheduled-task?limit=25&page=2" + "example": "/salutation?limit=25&page=2" } } } @@ -41906,7 +52494,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -41921,11 +52509,11 @@ }, "post": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Create a new Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createScheduledTask", + "summary": "Create a new Salutation resources.", + "description": "Fetches salutations with a criteria obj.", + "operationId": "createSalutation", "parameters": [ { "name": "_response", @@ -41947,7 +52535,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" }, "included": { "type": "array", @@ -41961,14 +52549,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -41980,7 +52568,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -41989,7 +52577,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + } + } } } } @@ -42003,19 +52599,93 @@ } } }, - "/scheduled-task/{id}": { + "/search/salutation": { + "post": { + "tags": [ + "Salutation" + ], + "summary": "Search for the Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalutation", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/salutation/{id}": { "get": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Detailed information about a Scheduled Task resource.", + "summary": "Detailed information about a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", + "operationId": "getSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -42025,7 +52695,7 @@ ], "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -42037,7 +52707,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -42046,7 +52716,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + } + } } } } @@ -42061,16 +52739,16 @@ }, "delete": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Delete a Scheduled Task resource.", + "summary": "Delete a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteScheduledTask", + "operationId": "deleteSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -42101,16 +52779,16 @@ }, "patch": { "tags": [ - "Scheduled Task" + "Salutation" ], - "summary": "Partially update information about a Scheduled Task resource.", + "summary": "Partially update information about a Salutation resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateScheduledTask", + "operationId": "updateSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -42128,14 +52806,14 @@ } ], "requestBody": { - "description": "Partially update information about a Scheduled Task resource.", + "description": "Partially update information about a Salutation resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" }, "included": { "type": "array", @@ -42149,14 +52827,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -42168,7 +52846,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Salutation" } } } @@ -42177,7 +52855,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Salutation" + } + } } } } @@ -42194,14 +52880,14 @@ } } }, - "/script": { + "/scheduled-task": { "get": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "List with basic information of Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getScriptList", + "summary": "List with basic information of Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTaskList", "parameters": [ { "name": "limit", @@ -42230,7 +52916,7 @@ ], "responses": { "200": { - "description": "List of Script resources.", + "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { @@ -42249,7 +52935,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } ] @@ -42263,16 +52949,16 @@ "type": "object", "properties": { "first": { - "example": "/script?limit=25" + "example": "/scheduled-task?limit=25" }, "last": { - "example": "/script?limit=25&page=11" + "example": "/scheduled-task?limit=25&page=11" }, "next": { - "example": "/script?limit=25&page=4" + "example": "/scheduled-task?limit=25&page=4" }, "prev": { - "example": "/script?limit=25&page=2" + "example": "/scheduled-task?limit=25&page=2" } } } @@ -42293,7 +52979,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42308,11 +52994,11 @@ }, "post": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Create a new Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createScript", + "summary": "Create a new Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createScheduledTask", "parameters": [ { "name": "_response", @@ -42334,7 +53020,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" }, "included": { "type": "array", @@ -42348,14 +53034,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -42367,7 +53053,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42376,7 +53062,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } } } } @@ -42390,19 +53084,93 @@ } } }, - "/script/{id}": { + "/search/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Search for the Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchScheduledTask", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/scheduled-task/{id}": { "get": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Detailed information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getScript", + "summary": "Detailed information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -42412,7 +53180,7 @@ ], "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -42424,7 +53192,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42433,7 +53201,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } } } } @@ -42448,16 +53224,16 @@ }, "delete": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Delete a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteScript", + "summary": "Delete a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -42488,16 +53264,16 @@ }, "patch": { "tags": [ - "Script" + "Scheduled Task" ], - "summary": "Partially update information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateScript", + "summary": "Partially update information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -42515,14 +53291,14 @@ } ], "requestBody": { - "description": "Partially update information about a Script resource.", + "description": "Partially update information about a Scheduled Task resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" }, "included": { "type": "array", @@ -42536,14 +53312,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -42555,7 +53331,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -42564,7 +53340,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } } } } @@ -42581,14 +53365,14 @@ } } }, - "/seo-url": { + "/script": { "get": { "tags": [ - "Seo Url" + "Script" ], - "summary": "List with basic information of Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlList", + "summary": "List with basic information of Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getScriptList", "parameters": [ { "name": "limit", @@ -42617,7 +53401,7 @@ ], "responses": { "200": { - "description": "List of Seo Url resources.", + "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { @@ -42636,7 +53420,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } ] @@ -42650,16 +53434,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url?limit=25" + "example": "/script?limit=25" }, "last": { - "example": "/seo-url?limit=25&page=11" + "example": "/script?limit=25&page=11" }, "next": { - "example": "/seo-url?limit=25&page=4" + "example": "/script?limit=25&page=4" }, "prev": { - "example": "/seo-url?limit=25&page=2" + "example": "/script?limit=25&page=2" } } } @@ -42680,7 +53464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -42695,11 +53479,11 @@ }, "post": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Create a new Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrl", + "summary": "Create a new Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createScript", "parameters": [ { "name": "_response", @@ -42721,7 +53505,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" }, "included": { "type": "array", @@ -42735,14 +53519,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -42754,7 +53538,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -42763,7 +53547,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + } + } } } } @@ -42777,19 +53569,93 @@ } } }, - "/seo-url/{id}": { + "/search/script": { + "post": { + "tags": [ + "Script" + ], + "summary": "Search for the Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchScript", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/script/{id}": { "get": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Detailed information about a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrl", + "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 seo_url", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -42799,7 +53665,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -42811,7 +53677,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -42820,7 +53686,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + } + } } } } @@ -42835,16 +53709,16 @@ }, "delete": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Delete a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrl", + "summary": "Delete a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -42875,16 +53749,16 @@ }, "patch": { "tags": [ - "Seo Url" + "Script" ], - "summary": "Partially update information about a Seo Url resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrl", + "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 seo_url", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -42902,14 +53776,14 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url resource.", + "description": "Partially update information about a Script resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" }, "included": { "type": "array", @@ -42923,14 +53797,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -42942,7 +53816,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/Script" } } } @@ -42951,7 +53825,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Script" + } + } } } } @@ -42968,14 +53850,14 @@ } } }, - "/seo-url-template": { + "/seo-url": { "get": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "List with basic information of Seo Url Template resources.", + "summary": "List with basic information of Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplateList", + "operationId": "getSeoUrlList", "parameters": [ { "name": "limit", @@ -43004,7 +53886,7 @@ ], "responses": { "200": { - "description": "List of Seo Url Template resources.", + "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43023,7 +53905,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } ] @@ -43037,16 +53919,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url-template?limit=25" + "example": "/seo-url?limit=25" }, "last": { - "example": "/seo-url-template?limit=25&page=11" + "example": "/seo-url?limit=25&page=11" }, "next": { - "example": "/seo-url-template?limit=25&page=4" + "example": "/seo-url?limit=25&page=4" }, "prev": { - "example": "/seo-url-template?limit=25&page=2" + "example": "/seo-url?limit=25&page=2" } } } @@ -43067,7 +53949,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -43082,11 +53964,11 @@ }, "post": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Create a new Seo Url Template resources.", + "summary": "Create a new Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrlTemplate", + "operationId": "createSeoUrl", "parameters": [ { "name": "_response", @@ -43108,7 +53990,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" }, "included": { "type": "array", @@ -43122,14 +54004,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -43141,7 +54023,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -43150,7 +54032,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + } + } } } } @@ -43164,19 +54054,93 @@ } } }, - "/seo-url-template/{id}": { + "/search/seo-url": { + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Search for the Seo Url resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSeoUrl", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/seo-url/{id}": { "get": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Detailed information about a Seo Url Template resource.", + "summary": "Detailed information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplate", + "operationId": "getSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -43186,7 +54150,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -43198,7 +54162,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -43207,7 +54171,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + } + } } } } @@ -43222,16 +54194,16 @@ }, "delete": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Delete a Seo Url Template resource.", + "summary": "Delete a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrlTemplate", + "operationId": "deleteSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -43262,16 +54234,16 @@ }, "patch": { "tags": [ - "Seo Url Template" + "Seo Url" ], - "summary": "Partially update information about a Seo Url Template resource.", + "summary": "Partially update information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrlTemplate", + "operationId": "updateSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -43289,14 +54261,14 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url Template resource.", + "description": "Partially update information about a Seo Url resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" }, "included": { "type": "array", @@ -43310,14 +54282,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -43329,7 +54301,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -43338,7 +54310,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrl" + } + } } } } @@ -43355,14 +54335,14 @@ } } }, - "/shipping-method": { + "/seo-url-template": { "get": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "List with basic information of Shipping Method resources.", + "summary": "List with basic information of Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodList", + "operationId": "getSeoUrlTemplateList", "parameters": [ { "name": "limit", @@ -43391,7 +54371,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method resources.", + "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43410,7 +54390,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } ] @@ -43424,16 +54404,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method?limit=25" + "example": "/seo-url-template?limit=25" }, "last": { - "example": "/shipping-method?limit=25&page=11" + "example": "/seo-url-template?limit=25&page=11" }, "next": { - "example": "/shipping-method?limit=25&page=4" + "example": "/seo-url-template?limit=25&page=4" }, "prev": { - "example": "/shipping-method?limit=25&page=2" + "example": "/seo-url-template?limit=25&page=2" } } } @@ -43454,7 +54434,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43469,11 +54449,11 @@ }, "post": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Create a new Shipping Method resources.", + "summary": "Create a new Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethod", + "operationId": "createSeoUrlTemplate", "parameters": [ { "name": "_response", @@ -43495,7 +54475,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" }, "included": { "type": "array", @@ -43509,14 +54489,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -43528,7 +54508,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43537,7 +54517,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } } } } @@ -43551,19 +54539,93 @@ } } }, - "/shipping-method/{id}": { + "/search/seo-url-template": { + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Search for the Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSeoUrlTemplate", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/seo-url-template/{id}": { "get": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Detailed information about a Shipping Method resource.", + "summary": "Detailed information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethod", + "operationId": "getSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -43573,7 +54635,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -43585,7 +54647,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43594,7 +54656,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } } } } @@ -43609,16 +54679,16 @@ }, "delete": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Delete a Shipping Method resource.", + "summary": "Delete a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethod", + "operationId": "deleteSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -43649,16 +54719,16 @@ }, "patch": { "tags": [ - "Shipping Method" + "Seo Url Template" ], - "summary": "Partially update information about a Shipping Method resource.", + "summary": "Partially update information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethod", + "operationId": "updateSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -43676,14 +54746,14 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method resource.", + "description": "Partially update information about a Seo Url Template resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" }, "included": { "type": "array", @@ -43697,14 +54767,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -43716,7 +54786,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -43725,7 +54795,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } } } } @@ -43742,14 +54820,14 @@ } } }, - "/shipping-method-price": { + "/shipping-method": { "get": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "List with basic information of Shipping Method Price resources.", + "summary": "List with basic information of Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPriceList", + "operationId": "getShippingMethodList", "parameters": [ { "name": "limit", @@ -43778,7 +54856,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method Price resources.", + "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43797,7 +54875,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } ] @@ -43811,16 +54889,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method-price?limit=25" + "example": "/shipping-method?limit=25" }, "last": { - "example": "/shipping-method-price?limit=25&page=11" + "example": "/shipping-method?limit=25&page=11" }, "next": { - "example": "/shipping-method-price?limit=25&page=4" + "example": "/shipping-method?limit=25&page=4" }, "prev": { - "example": "/shipping-method-price?limit=25&page=2" + "example": "/shipping-method?limit=25&page=2" } } } @@ -43841,7 +54919,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43856,11 +54934,11 @@ }, "post": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Create a new Shipping Method Price resources.", + "summary": "Create a new Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethodPrice", + "operationId": "createShippingMethod", "parameters": [ { "name": "_response", @@ -43882,7 +54960,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" }, "included": { "type": "array", @@ -43896,14 +54974,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -43915,7 +54993,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43924,7 +55002,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + } + } } } } @@ -43938,19 +55024,93 @@ } } }, - "/shipping-method-price/{id}": { + "/search/shipping-method": { + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Search for the Shipping Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/shipping-method/{id}": { "get": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Detailed information about a Shipping Method Price resource.", + "summary": "Detailed information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPrice", + "operationId": "getShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -43960,7 +55120,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -43972,7 +55132,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -43981,7 +55141,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + } + } } } } @@ -43996,16 +55164,16 @@ }, "delete": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Delete a Shipping Method Price resource.", + "summary": "Delete a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethodPrice", + "operationId": "deleteShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -44036,16 +55204,16 @@ }, "patch": { "tags": [ - "Shipping Method Price" + "Shipping Method" ], - "summary": "Partially update information about a Shipping Method Price resource.", + "summary": "Partially update information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethodPrice", + "operationId": "updateShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -44063,14 +55231,14 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method Price resource.", + "description": "Partially update information about a Shipping Method resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" }, "included": { "type": "array", @@ -44084,14 +55252,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -44103,7 +55271,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -44112,7 +55280,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethod" + } + } } } } @@ -44129,14 +55305,14 @@ } } }, - "/snippet": { + "/shipping-method-price": { "get": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "List with basic information of Snippet resources.", + "summary": "List with basic information of Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetList", + "operationId": "getShippingMethodPriceList", "parameters": [ { "name": "limit", @@ -44165,7 +55341,7 @@ ], "responses": { "200": { - "description": "List of Snippet resources.", + "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44184,7 +55360,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } ] @@ -44198,16 +55374,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet?limit=25" + "example": "/shipping-method-price?limit=25" }, "last": { - "example": "/snippet?limit=25&page=11" + "example": "/shipping-method-price?limit=25&page=11" }, "next": { - "example": "/snippet?limit=25&page=4" + "example": "/shipping-method-price?limit=25&page=4" }, "prev": { - "example": "/snippet?limit=25&page=2" + "example": "/shipping-method-price?limit=25&page=2" } } } @@ -44228,7 +55404,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -44243,11 +55419,11 @@ }, "post": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Create a new Snippet resources.", + "summary": "Create a new Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippet", + "operationId": "createShippingMethodPrice", "parameters": [ { "name": "_response", @@ -44269,7 +55445,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" }, "included": { "type": "array", @@ -44283,14 +55459,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -44302,7 +55478,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -44311,7 +55487,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } } } } @@ -44325,19 +55509,93 @@ } } }, - "/snippet/{id}": { + "/search/shipping-method-price": { + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Search for the Shipping Method Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchShippingMethodPrice", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/shipping-method-price/{id}": { "get": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Detailed information about a Snippet resource.", + "summary": "Detailed information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", + "operationId": "getShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -44347,7 +55605,7 @@ ], "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -44359,7 +55617,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -44368,7 +55626,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } } } } @@ -44383,16 +55649,16 @@ }, "delete": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Delete a Snippet resource.", + "summary": "Delete a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", + "operationId": "deleteShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -44423,16 +55689,16 @@ }, "patch": { "tags": [ - "Snippet" + "Shipping Method Price" ], - "summary": "Partially update information about a Snippet resource.", + "summary": "Partially update information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", + "operationId": "updateShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -44450,14 +55716,14 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet resource.", + "description": "Partially update information about a Shipping Method Price resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" }, "included": { "type": "array", @@ -44471,14 +55737,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -44490,7 +55756,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -44499,7 +55765,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } } } } @@ -44516,14 +55790,14 @@ } } }, - "/snippet-set": { + "/snippet": { "get": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "List with basic information of Snippet Set resources.", + "summary": "List with basic information of Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSetList", + "operationId": "getSnippetList", "parameters": [ { "name": "limit", @@ -44552,7 +55826,7 @@ ], "responses": { "200": { - "description": "List of Snippet Set resources.", + "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44571,7 +55845,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } ] @@ -44585,16 +55859,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet-set?limit=25" + "example": "/snippet?limit=25" }, "last": { - "example": "/snippet-set?limit=25&page=11" + "example": "/snippet?limit=25&page=11" }, "next": { - "example": "/snippet-set?limit=25&page=4" + "example": "/snippet?limit=25&page=4" }, "prev": { - "example": "/snippet-set?limit=25&page=2" + "example": "/snippet?limit=25&page=2" } } } @@ -44615,7 +55889,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -44630,11 +55904,11 @@ }, "post": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Create a new Snippet Set resources.", + "summary": "Create a new Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippetSet", + "operationId": "createSnippet", "parameters": [ { "name": "_response", @@ -44656,7 +55930,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" }, "included": { "type": "array", @@ -44670,14 +55944,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -44689,7 +55963,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -44698,7 +55972,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } } } } @@ -44712,19 +55994,93 @@ } } }, - "/snippet-set/{id}": { + "/search/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Search for the Snippet resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSnippet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet/{id}": { "get": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Detailed information about a Snippet Set resource.", + "summary": "Detailed information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSet", + "operationId": "getSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -44734,7 +56090,7 @@ ], "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -44746,7 +56102,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -44755,7 +56111,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } } } } @@ -44770,16 +56134,16 @@ }, "delete": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Delete a Snippet Set resource.", + "summary": "Delete a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippetSet", + "operationId": "deleteSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -44810,16 +56174,16 @@ }, "patch": { "tags": [ - "Snippet Set" + "Snippet" ], - "summary": "Partially update information about a Snippet Set resource.", + "summary": "Partially update information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippetSet", + "operationId": "updateSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -44837,14 +56201,14 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet Set resource.", + "description": "Partially update information about a Snippet resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" }, "included": { "type": "array", @@ -44858,14 +56222,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -44877,7 +56241,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/Snippet" } } } @@ -44886,7 +56250,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } } } } @@ -44903,14 +56275,14 @@ } } }, - "/state-machine": { + "/snippet-set": { "get": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "List with basic information of State Machine resources.", + "summary": "List with basic information of Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineList", + "operationId": "getSnippetSetList", "parameters": [ { "name": "limit", @@ -44939,7 +56311,7 @@ ], "responses": { "200": { - "description": "List of State Machine resources.", + "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44958,7 +56330,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } ] @@ -44972,16 +56344,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine?limit=25" + "example": "/snippet-set?limit=25" }, "last": { - "example": "/state-machine?limit=25&page=11" + "example": "/snippet-set?limit=25&page=11" }, "next": { - "example": "/state-machine?limit=25&page=4" + "example": "/snippet-set?limit=25&page=4" }, "prev": { - "example": "/state-machine?limit=25&page=2" + "example": "/snippet-set?limit=25&page=2" } } } @@ -45002,7 +56374,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -45017,11 +56389,11 @@ }, "post": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Create a new State Machine resources.", + "summary": "Create a new Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachine", + "operationId": "createSnippetSet", "parameters": [ { "name": "_response", @@ -45043,7 +56415,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" }, "included": { "type": "array", @@ -45057,14 +56429,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -45076,7 +56448,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -45085,7 +56457,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + } + } } } } @@ -45099,19 +56479,93 @@ } } }, - "/state-machine/{id}": { + "/search/snippet-set": { + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Search for the Snippet Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSnippetSet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet-set/{id}": { "get": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Detailed information about a State Machine resource.", + "summary": "Detailed information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachine", + "operationId": "getSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -45121,7 +56575,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -45133,7 +56587,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -45142,7 +56596,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + } + } } } } @@ -45157,16 +56619,16 @@ }, "delete": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Delete a State Machine resource.", + "summary": "Delete a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachine", + "operationId": "deleteSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -45197,16 +56659,16 @@ }, "patch": { "tags": [ - "State Machine" + "Snippet Set" ], - "summary": "Partially update information about a State Machine resource.", + "summary": "Partially update information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachine", + "operationId": "updateSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -45224,14 +56686,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine resource.", + "description": "Partially update information about a Snippet Set resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" }, "included": { "type": "array", @@ -45245,14 +56707,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -45264,7 +56726,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -45273,7 +56735,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SnippetSet" + } + } } } } @@ -45290,14 +56760,14 @@ } } }, - "/state-machine-history": { + "/state-machine": { "get": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "List with basic information of State Machine History resources.", + "summary": "List with basic information of State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistoryList", + "operationId": "getStateMachineList", "parameters": [ { "name": "limit", @@ -45326,7 +56796,7 @@ ], "responses": { "200": { - "description": "List of State Machine History resources.", + "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { @@ -45345,7 +56815,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } ] @@ -45359,16 +56829,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-history?limit=25" + "example": "/state-machine?limit=25" }, "last": { - "example": "/state-machine-history?limit=25&page=11" + "example": "/state-machine?limit=25&page=11" }, "next": { - "example": "/state-machine-history?limit=25&page=4" + "example": "/state-machine?limit=25&page=4" }, "prev": { - "example": "/state-machine-history?limit=25&page=2" + "example": "/state-machine?limit=25&page=2" } } } @@ -45389,7 +56859,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45404,11 +56874,11 @@ }, "post": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Create a new State Machine History resources.", + "summary": "Create a new State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineHistory", + "operationId": "createStateMachine", "parameters": [ { "name": "_response", @@ -45430,7 +56900,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" }, "included": { "type": "array", @@ -45444,14 +56914,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -45463,7 +56933,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45472,7 +56942,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + } + } } } } @@ -45486,19 +56964,93 @@ } } }, - "/state-machine-history/{id}": { + "/search/state-machine": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Search for the State Machine resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachine", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine/{id}": { "get": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Detailed information about a State Machine History resource.", + "summary": "Detailed information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", + "operationId": "getStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -45508,7 +57060,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -45520,7 +57072,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45529,7 +57081,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + } + } } } } @@ -45544,16 +57104,16 @@ }, "delete": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Delete a State Machine History resource.", + "summary": "Delete a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", + "operationId": "deleteStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -45584,16 +57144,16 @@ }, "patch": { "tags": [ - "State Machine History" + "State Machine" ], - "summary": "Partially update information about a State Machine History resource.", + "summary": "Partially update information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", + "operationId": "updateStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -45611,14 +57171,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine History resource.", + "description": "Partially update information about a State Machine resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" }, "included": { "type": "array", @@ -45632,14 +57192,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -45651,7 +57211,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/StateMachine" } } } @@ -45660,7 +57220,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachine" + } + } } } } @@ -45677,14 +57245,14 @@ } } }, - "/state-machine-state": { + "/state-machine-history": { "get": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "List with basic information of State Machine State resources.", + "summary": "List with basic information of State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineStateList", + "operationId": "getStateMachineHistoryList", "parameters": [ { "name": "limit", @@ -45713,7 +57281,7 @@ ], "responses": { "200": { - "description": "List of State Machine State resources.", + "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { @@ -45732,7 +57300,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } ] @@ -45746,16 +57314,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-state?limit=25" + "example": "/state-machine-history?limit=25" }, "last": { - "example": "/state-machine-state?limit=25&page=11" + "example": "/state-machine-history?limit=25&page=11" }, "next": { - "example": "/state-machine-state?limit=25&page=4" + "example": "/state-machine-history?limit=25&page=4" }, "prev": { - "example": "/state-machine-state?limit=25&page=2" + "example": "/state-machine-history?limit=25&page=2" } } } @@ -45776,7 +57344,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45791,11 +57359,11 @@ }, "post": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Create a new State Machine State resources.", + "summary": "Create a new State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineState", + "operationId": "createStateMachineHistory", "parameters": [ { "name": "_response", @@ -45817,7 +57385,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" }, "included": { "type": "array", @@ -45831,14 +57399,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -45850,7 +57418,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45859,7 +57427,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } } } } @@ -45873,19 +57449,93 @@ } } }, - "/state-machine-state/{id}": { + "/search/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Search for the State Machine History resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-history/{id}": { "get": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Detailed information about a State Machine State resource.", + "summary": "Detailed information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineState", + "operationId": "getStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -45895,7 +57545,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -45907,7 +57557,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -45916,7 +57566,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } } } } @@ -45931,16 +57589,16 @@ }, "delete": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Delete a State Machine State resource.", + "summary": "Delete a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineState", + "operationId": "deleteStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -45971,16 +57629,16 @@ }, "patch": { "tags": [ - "State Machine State" + "State Machine History" ], - "summary": "Partially update information about a State Machine State resource.", + "summary": "Partially update information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineState", + "operationId": "updateStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -45998,14 +57656,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine State resource.", + "description": "Partially update information about a State Machine History resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" }, "included": { "type": "array", @@ -46019,14 +57677,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -46038,7 +57696,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -46047,7 +57705,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } } } } @@ -46064,14 +57730,14 @@ } } }, - "/state-machine-transition": { + "/state-machine-state": { "get": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "List with basic information of State Machine Transition resources.", + "summary": "List with basic information of State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransitionList", + "operationId": "getStateMachineStateList", "parameters": [ { "name": "limit", @@ -46100,7 +57766,7 @@ ], "responses": { "200": { - "description": "List of State Machine Transition resources.", + "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46119,7 +57785,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } ] @@ -46133,16 +57799,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-transition?limit=25" + "example": "/state-machine-state?limit=25" }, "last": { - "example": "/state-machine-transition?limit=25&page=11" + "example": "/state-machine-state?limit=25&page=11" }, "next": { - "example": "/state-machine-transition?limit=25&page=4" + "example": "/state-machine-state?limit=25&page=4" }, "prev": { - "example": "/state-machine-transition?limit=25&page=2" + "example": "/state-machine-state?limit=25&page=2" } } } @@ -46163,7 +57829,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -46178,11 +57844,11 @@ }, "post": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Create a new State Machine Transition resources.", + "summary": "Create a new State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineTransition", + "operationId": "createStateMachineState", "parameters": [ { "name": "_response", @@ -46204,7 +57870,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" }, "included": { "type": "array", @@ -46218,14 +57884,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -46237,7 +57903,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -46246,7 +57912,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + } + } } } } @@ -46260,19 +57934,93 @@ } } }, - "/state-machine-transition/{id}": { + "/search/state-machine-state": { + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Search for the State Machine State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachineState", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-state/{id}": { "get": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Detailed information about a State Machine Transition resource.", + "summary": "Detailed information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransition", + "operationId": "getStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -46282,7 +58030,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -46294,7 +58042,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -46303,7 +58051,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + } + } } } } @@ -46318,16 +58074,16 @@ }, "delete": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Delete a State Machine Transition resource.", + "summary": "Delete a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineTransition", + "operationId": "deleteStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -46358,16 +58114,16 @@ }, "patch": { "tags": [ - "State Machine Transition" + "State Machine State" ], - "summary": "Partially update information about a State Machine Transition resource.", + "summary": "Partially update information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineTransition", + "operationId": "updateStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -46385,14 +58141,14 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine Transition resource.", + "description": "Partially update information about a State Machine State resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" }, "included": { "type": "array", @@ -46406,14 +58162,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -46425,7 +58181,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -46434,7 +58190,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineState" + } + } } } } @@ -46451,14 +58215,14 @@ } } }, - "/system-config": { + "/state-machine-transition": { "get": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "List with basic information of System Config resources.", + "summary": "List with basic information of State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfigList", + "operationId": "getStateMachineTransitionList", "parameters": [ { "name": "limit", @@ -46487,7 +58251,7 @@ ], "responses": { "200": { - "description": "List of System Config resources.", + "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46506,7 +58270,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } ] @@ -46520,16 +58284,16 @@ "type": "object", "properties": { "first": { - "example": "/system-config?limit=25" + "example": "/state-machine-transition?limit=25" }, "last": { - "example": "/system-config?limit=25&page=11" + "example": "/state-machine-transition?limit=25&page=11" }, "next": { - "example": "/system-config?limit=25&page=4" + "example": "/state-machine-transition?limit=25&page=4" }, "prev": { - "example": "/system-config?limit=25&page=2" + "example": "/state-machine-transition?limit=25&page=2" } } } @@ -46550,7 +58314,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46565,11 +58329,11 @@ }, "post": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Create a new System Config resources.", + "summary": "Create a new State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSystemConfig", + "operationId": "createStateMachineTransition", "parameters": [ { "name": "_response", @@ -46591,7 +58355,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" }, "included": { "type": "array", @@ -46605,14 +58369,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -46624,7 +58388,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46633,7 +58397,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } } } } @@ -46647,19 +58419,93 @@ } } }, - "/system-config/{id}": { + "/search/state-machine-transition": { + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Search for the State Machine Transition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachineTransition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-transition/{id}": { "get": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Detailed information about a System Config resource.", + "summary": "Detailed information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", + "operationId": "getStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -46669,7 +58515,7 @@ ], "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -46681,7 +58527,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46690,7 +58536,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } } } } @@ -46705,16 +58559,16 @@ }, "delete": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Delete a System Config resource.", + "summary": "Delete a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", + "operationId": "deleteStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -46745,16 +58599,16 @@ }, "patch": { "tags": [ - "System Config" + "State Machine Transition" ], - "summary": "Partially update information about a System Config resource.", + "summary": "Partially update information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", + "operationId": "updateStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -46772,14 +58626,14 @@ } ], "requestBody": { - "description": "Partially update information about a System Config resource.", + "description": "Partially update information about a State Machine Transition resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" }, "included": { "type": "array", @@ -46793,14 +58647,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -46812,7 +58666,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -46821,7 +58675,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } } } } @@ -46838,14 +58700,14 @@ } } }, - "/tag": { + "/system-config": { "get": { "tags": [ - "Tag" + "System Config" ], - "summary": "List with basic information of Tag resources.", + "summary": "List with basic information of System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTagList", + "operationId": "getSystemConfigList", "parameters": [ { "name": "limit", @@ -46874,7 +58736,7 @@ ], "responses": { "200": { - "description": "List of Tag resources.", + "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46893,7 +58755,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } ] @@ -46907,16 +58769,16 @@ "type": "object", "properties": { "first": { - "example": "/tag?limit=25" + "example": "/system-config?limit=25" }, "last": { - "example": "/tag?limit=25&page=11" + "example": "/system-config?limit=25&page=11" }, "next": { - "example": "/tag?limit=25&page=4" + "example": "/system-config?limit=25&page=4" }, "prev": { - "example": "/tag?limit=25&page=2" + "example": "/system-config?limit=25&page=2" } } } @@ -46937,7 +58799,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -46952,11 +58814,11 @@ }, "post": { "tags": [ - "Tag" + "System Config" ], - "summary": "Create a new Tag resources.", + "summary": "Create a new System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTag", + "operationId": "createSystemConfig", "parameters": [ { "name": "_response", @@ -46978,7 +58840,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" }, "included": { "type": "array", @@ -46992,14 +58854,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47011,7 +58873,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -47020,7 +58882,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } } } } @@ -47034,19 +58904,93 @@ } } }, - "/tag/{id}": { + "/search/system-config": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Search for the System Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSystemConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/system-config/{id}": { "get": { "tags": [ - "Tag" + "System Config" ], - "summary": "Detailed information about a Tag resource.", + "summary": "Detailed information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTag", + "operationId": "getSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -47056,7 +59000,7 @@ ], "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47068,7 +59012,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -47077,7 +59021,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } } } } @@ -47092,16 +59044,16 @@ }, "delete": { "tags": [ - "Tag" + "System Config" ], - "summary": "Delete a Tag resource.", + "summary": "Delete a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTag", + "operationId": "deleteSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -47132,16 +59084,16 @@ }, "patch": { "tags": [ - "Tag" + "System Config" ], - "summary": "Partially update information about a Tag resource.", + "summary": "Partially update information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTag", + "operationId": "updateSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -47159,14 +59111,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tag resource.", + "description": "Partially update information about a System Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" }, "included": { "type": "array", @@ -47180,14 +59132,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47199,7 +59151,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -47208,7 +59160,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } } } } @@ -47225,14 +59185,14 @@ } } }, - "/tax": { + "/tag": { "get": { "tags": [ - "Tax" + "Tag" ], - "summary": "List with basic information of Tax resources.", + "summary": "List with basic information of Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTaxList", + "operationId": "getTagList", "parameters": [ { "name": "limit", @@ -47261,7 +59221,7 @@ ], "responses": { "200": { - "description": "List of Tax resources.", + "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -47280,7 +59240,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } ] @@ -47294,16 +59254,16 @@ "type": "object", "properties": { "first": { - "example": "/tax?limit=25" + "example": "/tag?limit=25" }, "last": { - "example": "/tax?limit=25&page=11" + "example": "/tag?limit=25&page=11" }, "next": { - "example": "/tax?limit=25&page=4" + "example": "/tag?limit=25&page=4" }, "prev": { - "example": "/tax?limit=25&page=2" + "example": "/tag?limit=25&page=2" } } } @@ -47324,7 +59284,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -47339,11 +59299,11 @@ }, "post": { "tags": [ - "Tax" + "Tag" ], - "summary": "Create a new Tax resources.", + "summary": "Create a new Tag resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTax", + "operationId": "createTag", "parameters": [ { "name": "_response", @@ -47365,7 +59325,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" }, "included": { "type": "array", @@ -47379,14 +59339,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -47398,7 +59358,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -47407,7 +59367,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + } + } } } } @@ -47421,19 +59389,93 @@ } } }, - "/tax/{id}": { + "/search/tag": { + "post": { + "tags": [ + "Tag" + ], + "summary": "Search for the Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTag", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tag/{id}": { "get": { "tags": [ - "Tax" + "Tag" ], - "summary": "Detailed information about a Tax resource.", + "summary": "Detailed information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTax", + "operationId": "getTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -47443,7 +59485,7 @@ ], "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -47455,7 +59497,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -47464,7 +59506,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + } + } } } } @@ -47479,16 +59529,16 @@ }, "delete": { "tags": [ - "Tax" + "Tag" ], - "summary": "Delete a Tax resource.", + "summary": "Delete a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTax", + "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -47519,16 +59569,16 @@ }, "patch": { "tags": [ - "Tax" + "Tag" ], - "summary": "Partially update information about a Tax resource.", + "summary": "Partially update information about a Tag resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTax", + "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -47546,14 +59596,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax resource.", + "description": "Partially update information about a Tag resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" }, "included": { "type": "array", @@ -47567,14 +59617,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -47586,7 +59636,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tag" } } } @@ -47595,7 +59645,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Tag" + } + } } } } @@ -47612,14 +59670,14 @@ } } }, - "/tax-provider": { + "/tax": { "get": { "tags": [ - "Tax Provider" + "Tax" ], - "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 resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getTaxList", "parameters": [ { "name": "limit", @@ -47648,7 +59706,7 @@ ], "responses": { "200": { - "description": "List of Tax Provider resources.", + "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { @@ -47667,7 +59725,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } ] @@ -47681,16 +59739,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-provider?limit=25" + "example": "/tax?limit=25" }, "last": { - "example": "/tax-provider?limit=25&page=11" + "example": "/tax?limit=25&page=11" }, "next": { - "example": "/tax-provider?limit=25&page=4" + "example": "/tax?limit=25&page=4" }, "prev": { - "example": "/tax-provider?limit=25&page=2" + "example": "/tax?limit=25&page=2" } } } @@ -47711,7 +59769,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -47726,11 +59784,11 @@ }, "post": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Create a new Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "createTaxProvider", + "summary": "Create a new Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTax", "parameters": [ { "name": "_response", @@ -47752,7 +59810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" }, "included": { "type": "array", @@ -47766,14 +59824,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -47785,7 +59843,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -47794,7 +59852,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + } + } } } } @@ -47808,19 +59874,93 @@ } } }, - "/tax-provider/{id}": { + "/search/tax": { + "post": { + "tags": [ + "Tax" + ], + "summary": "Search for the Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTax", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax/{id}": { "get": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Detailed information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProvider", + "summary": "Detailed information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -47830,7 +59970,7 @@ ], "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -47842,7 +59982,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -47851,7 +59991,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + } + } } } } @@ -47866,16 +60014,16 @@ }, "delete": { "tags": [ - "Tax Provider" + "Tax" ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", + "summary": "Delete a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -47906,16 +60054,16 @@ }, "patch": { "tags": [ - "Tax Provider" + "Tax" ], - "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 resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -47933,14 +60081,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Provider resource.", + "description": "Partially update information about a Tax resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" }, "included": { "type": "array", @@ -47954,14 +60102,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -47973,7 +60121,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tax" } } } @@ -47982,7 +60130,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Tax" + } + } } } } @@ -47999,14 +60155,14 @@ } } }, - "/tax-rule": { + "/tax-provider": { "get": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "List with basic information of Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleList", + "summary": "List with basic information of Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProviderList", "parameters": [ { "name": "limit", @@ -48035,7 +60191,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule resources.", + "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48054,7 +60210,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } ] @@ -48068,16 +60224,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule?limit=25" + "example": "/tax-provider?limit=25" }, "last": { - "example": "/tax-rule?limit=25&page=11" + "example": "/tax-provider?limit=25&page=11" }, "next": { - "example": "/tax-rule?limit=25&page=4" + "example": "/tax-provider?limit=25&page=4" }, "prev": { - "example": "/tax-rule?limit=25&page=2" + "example": "/tax-provider?limit=25&page=2" } } } @@ -48098,7 +60254,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -48113,11 +60269,11 @@ }, "post": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Create a new Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRule", + "summary": "Create a new Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "createTaxProvider", "parameters": [ { "name": "_response", @@ -48139,7 +60295,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" }, "included": { "type": "array", @@ -48153,14 +60309,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -48172,7 +60328,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -48181,7 +60337,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } } } } @@ -48195,19 +60359,93 @@ } } }, - "/tax-rule/{id}": { + "/search/tax-provider": { + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Search for the Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "searchTaxProvider", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-provider/{id}": { "get": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Detailed information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRule", + "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 tax_rule", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -48217,7 +60455,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -48229,7 +60467,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -48238,7 +60476,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } } } } @@ -48253,16 +60499,16 @@ }, "delete": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Delete a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRule", + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -48293,16 +60539,16 @@ }, "patch": { "tags": [ - "Tax Rule" + "Tax Provider" ], - "summary": "Partially update information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRule", + "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 tax_rule", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -48320,14 +60566,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule resource.", + "description": "Partially update information about a Tax Provider resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" }, "included": { "type": "array", @@ -48341,14 +60587,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -48360,7 +60606,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -48369,7 +60615,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } } } } @@ -48386,14 +60640,14 @@ } } }, - "/tax-rule-type": { + "/tax-rule": { "get": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "List with basic information of Tax Rule Type resources.", + "summary": "List with basic information of Tax Rule resources.", "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleTypeList", + "operationId": "getTaxRuleList", "parameters": [ { "name": "limit", @@ -48422,7 +60676,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule Type resources.", + "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48441,7 +60695,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } ] @@ -48455,16 +60709,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule-type?limit=25" + "example": "/tax-rule?limit=25" }, "last": { - "example": "/tax-rule-type?limit=25&page=11" + "example": "/tax-rule?limit=25&page=11" }, "next": { - "example": "/tax-rule-type?limit=25&page=4" + "example": "/tax-rule?limit=25&page=4" }, "prev": { - "example": "/tax-rule-type?limit=25&page=2" + "example": "/tax-rule?limit=25&page=2" } } } @@ -48485,7 +60739,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48500,11 +60754,11 @@ }, "post": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Create a new Tax Rule Type resources.", + "summary": "Create a new Tax Rule resources.", "description": "Available since: 6.1.0.0", - "operationId": "createTaxRuleType", + "operationId": "createTaxRule", "parameters": [ { "name": "_response", @@ -48526,7 +60780,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" }, "included": { "type": "array", @@ -48540,14 +60794,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -48559,7 +60813,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48568,7 +60822,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + } + } } } } @@ -48582,19 +60844,93 @@ } } }, - "/tax-rule-type/{id}": { + "/search/tax-rule": { + "post": { + "tags": [ + "Tax Rule" + ], + "summary": "Search for the Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRule", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-rule/{id}": { "get": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Detailed information about a Tax Rule Type resource.", + "summary": "Detailed information about a Tax Rule resource.", "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleType", + "operationId": "getTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -48604,7 +60940,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -48616,7 +60952,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48625,7 +60961,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + } + } } } } @@ -48640,16 +60984,16 @@ }, "delete": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Delete a Tax Rule Type resource.", + "summary": "Delete a Tax Rule resource.", "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRuleType", + "operationId": "deleteTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -48680,16 +61024,16 @@ }, "patch": { "tags": [ - "Tax Rule Type" + "Tax Rule" ], - "summary": "Partially update information about a Tax Rule Type resource.", + "summary": "Partially update information about a Tax Rule resource.", "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRuleType", + "operationId": "updateTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -48707,14 +61051,14 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule Type resource.", + "description": "Partially update information about a Tax Rule resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" }, "included": { "type": "array", @@ -48728,14 +61072,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -48747,7 +61091,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxRule" } } } @@ -48756,7 +61100,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRule" + } + } } } } @@ -48773,14 +61125,14 @@ } } }, - "/theme": { + "/tax-rule-type": { "get": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "List with basic information of Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getThemeList", + "summary": "List with basic information of Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleTypeList", "parameters": [ { "name": "limit", @@ -48809,7 +61161,7 @@ ], "responses": { "200": { - "description": "List of Theme resources.", + "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48828,7 +61180,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } ] @@ -48842,16 +61194,16 @@ "type": "object", "properties": { "first": { - "example": "/theme?limit=25" + "example": "/tax-rule-type?limit=25" }, "last": { - "example": "/theme?limit=25&page=11" + "example": "/tax-rule-type?limit=25&page=11" }, "next": { - "example": "/theme?limit=25&page=4" + "example": "/tax-rule-type?limit=25&page=4" }, "prev": { - "example": "/theme?limit=25&page=2" + "example": "/tax-rule-type?limit=25&page=2" } } } @@ -48872,7 +61224,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48887,11 +61239,11 @@ }, "post": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Create a new Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTheme", + "summary": "Create a new Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRuleType", "parameters": [ { "name": "_response", @@ -48913,7 +61265,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" }, "included": { "type": "array", @@ -48927,14 +61279,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -48946,7 +61298,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -48955,7 +61307,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + } + } } } } @@ -48969,19 +61329,93 @@ } } }, - "/theme/{id}": { + "/search/tax-rule-type": { + "post": { + "tags": [ + "Tax Rule Type" + ], + "summary": "Search for the Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRuleType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-rule-type/{id}": { "get": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Detailed information about a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTheme", + "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 theme", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -48991,7 +61425,7 @@ ], "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -49003,7 +61437,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -49012,7 +61446,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + } + } } } } @@ -49027,16 +61469,16 @@ }, "delete": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Delete a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", + "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 theme", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -49067,16 +61509,16 @@ }, "patch": { "tags": [ - "Theme" + "Tax Rule Type" ], - "summary": "Partially update information about a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTheme", + "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 theme", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -49094,14 +61536,14 @@ } ], "requestBody": { - "description": "Partially update information about a Theme resource.", + "description": "Partially update information about a Tax Rule Type resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" }, "included": { "type": "array", @@ -49115,14 +61557,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -49134,7 +61576,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -49143,7 +61585,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxRuleType" + } + } } } } @@ -49160,14 +61610,14 @@ } } }, - "/unit": { + "/theme": { "get": { "tags": [ - "Unit" + "Theme" ], - "summary": "List with basic information of Unit resources.", + "summary": "List with basic information of Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUnitList", + "operationId": "getThemeList", "parameters": [ { "name": "limit", @@ -49196,7 +61646,7 @@ ], "responses": { "200": { - "description": "List of Unit resources.", + "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49215,7 +61665,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } ] @@ -49229,16 +61679,16 @@ "type": "object", "properties": { "first": { - "example": "/unit?limit=25" + "example": "/theme?limit=25" }, "last": { - "example": "/unit?limit=25&page=11" + "example": "/theme?limit=25&page=11" }, "next": { - "example": "/unit?limit=25&page=4" + "example": "/theme?limit=25&page=4" }, "prev": { - "example": "/unit?limit=25&page=2" + "example": "/theme?limit=25&page=2" } } } @@ -49259,7 +61709,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -49274,11 +61724,11 @@ }, "post": { "tags": [ - "Unit" + "Theme" ], - "summary": "Create a new Unit resources.", + "summary": "Create a new Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUnit", + "operationId": "createTheme", "parameters": [ { "name": "_response", @@ -49300,7 +61750,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" }, "included": { "type": "array", @@ -49314,14 +61764,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -49333,7 +61783,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -49342,7 +61792,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } } } } @@ -49356,19 +61814,93 @@ } } }, - "/unit/{id}": { + "/search/theme": { + "post": { + "tags": [ + "Theme" + ], + "summary": "Search for the Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTheme", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/theme/{id}": { "get": { "tags": [ - "Unit" + "Theme" ], - "summary": "Detailed information about a Unit resource.", + "summary": "Detailed information about a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUnit", + "operationId": "getTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -49378,7 +61910,7 @@ ], "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -49390,7 +61922,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -49399,7 +61931,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } } } } @@ -49414,16 +61954,16 @@ }, "delete": { "tags": [ - "Unit" + "Theme" ], - "summary": "Delete a Unit resource.", + "summary": "Delete a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUnit", + "operationId": "deleteTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -49454,16 +61994,16 @@ }, "patch": { "tags": [ - "Unit" + "Theme" ], - "summary": "Partially update information about a Unit resource.", + "summary": "Partially update information about a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUnit", + "operationId": "updateTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the unit", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -49481,14 +62021,14 @@ } ], "requestBody": { - "description": "Partially update information about a Unit resource.", + "description": "Partially update information about a Theme resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" }, "included": { "type": "array", @@ -49502,14 +62042,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -49521,7 +62061,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Theme" } } } @@ -49530,7 +62070,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } } } } @@ -49547,14 +62095,14 @@ } } }, - "/user": { + "/unit": { "get": { "tags": [ - "User" + "Unit" ], - "summary": "List with basic information of User resources.", + "summary": "List with basic information of Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserList", + "operationId": "getUnitList", "parameters": [ { "name": "limit", @@ -49583,7 +62131,7 @@ ], "responses": { "200": { - "description": "List of User resources.", + "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49602,7 +62150,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } ] @@ -49616,16 +62164,16 @@ "type": "object", "properties": { "first": { - "example": "/user?limit=25" + "example": "/unit?limit=25" }, "last": { - "example": "/user?limit=25&page=11" + "example": "/unit?limit=25&page=11" }, "next": { - "example": "/user?limit=25&page=4" + "example": "/unit?limit=25&page=4" }, "prev": { - "example": "/user?limit=25&page=2" + "example": "/unit?limit=25&page=2" } } } @@ -49646,7 +62194,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -49661,11 +62209,11 @@ }, "post": { "tags": [ - "User" + "Unit" ], - "summary": "Create a new User resources.", + "summary": "Create a new Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUser", + "operationId": "createUnit", "parameters": [ { "name": "_response", @@ -49687,7 +62235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" }, "included": { "type": "array", @@ -49701,14 +62249,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -49720,7 +62268,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -49729,7 +62277,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } } } } @@ -49743,19 +62299,93 @@ } } }, - "/user/{id}": { + "/search/unit": { + "post": { + "tags": [ + "Unit" + ], + "summary": "Search for the Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUnit", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/unit/{id}": { "get": { "tags": [ - "User" + "Unit" ], - "summary": "Detailed information about a User resource.", + "summary": "Detailed information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUser", + "operationId": "getUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -49765,7 +62395,7 @@ ], "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -49777,7 +62407,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -49786,7 +62416,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } } } } @@ -49801,16 +62439,16 @@ }, "delete": { "tags": [ - "User" + "Unit" ], - "summary": "Delete a User resource.", + "summary": "Delete a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUser", + "operationId": "deleteUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -49841,16 +62479,16 @@ }, "patch": { "tags": [ - "User" + "Unit" ], - "summary": "Partially update information about a User resource.", + "summary": "Partially update information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUser", + "operationId": "updateUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -49868,14 +62506,14 @@ } ], "requestBody": { - "description": "Partially update information about a User resource.", + "description": "Partially update information about a Unit resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" }, "included": { "type": "array", @@ -49889,14 +62527,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -49908,7 +62546,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Unit" } } } @@ -49917,7 +62555,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } } } } @@ -49934,14 +62580,14 @@ } } }, - "/user-access-key": { + "/user": { "get": { "tags": [ - "User Access Key" + "User" ], - "summary": "List with basic information of User Access Key resources.", + "summary": "List with basic information of User resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKeyList", + "operationId": "getUserList", "parameters": [ { "name": "limit", @@ -49970,7 +62616,7 @@ ], "responses": { "200": { - "description": "List of User Access Key resources.", + "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49989,7 +62635,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } ] @@ -50003,16 +62649,16 @@ "type": "object", "properties": { "first": { - "example": "/user-access-key?limit=25" + "example": "/user?limit=25" }, "last": { - "example": "/user-access-key?limit=25&page=11" + "example": "/user?limit=25&page=11" }, "next": { - "example": "/user-access-key?limit=25&page=4" + "example": "/user?limit=25&page=4" }, "prev": { - "example": "/user-access-key?limit=25&page=2" + "example": "/user?limit=25&page=2" } } } @@ -50033,7 +62679,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -50048,11 +62694,11 @@ }, "post": { "tags": [ - "User Access Key" + "User" ], - "summary": "Create a new User Access Key resources.", + "summary": "Create a new User resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUserAccessKey", + "operationId": "createUser", "parameters": [ { "name": "_response", @@ -50074,7 +62720,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" }, "included": { "type": "array", @@ -50088,14 +62734,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -50107,7 +62753,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -50116,7 +62762,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/User" + } + } } } } @@ -50130,19 +62784,93 @@ } } }, - "/user-access-key/{id}": { + "/search/user": { + "post": { + "tags": [ + "User" + ], + "summary": "Search for the User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUser", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user/{id}": { "get": { "tags": [ - "User Access Key" + "User" ], - "summary": "Detailed information about a User Access Key resource.", + "summary": "Detailed information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", + "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -50152,7 +62880,7 @@ ], "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -50164,7 +62892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -50173,7 +62901,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/User" + } + } } } } @@ -50188,16 +62924,16 @@ }, "delete": { "tags": [ - "User Access Key" + "User" ], - "summary": "Delete a User Access Key resource.", + "summary": "Delete a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", + "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -50228,16 +62964,16 @@ }, "patch": { "tags": [ - "User Access Key" + "User" ], - "summary": "Partially update information about a User Access Key resource.", + "summary": "Partially update information about a User resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", + "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -50255,14 +62991,14 @@ } ], "requestBody": { - "description": "Partially update information about a User Access Key resource.", + "description": "Partially update information about a User resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" }, "included": { "type": "array", @@ -50276,14 +63012,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -50295,7 +63031,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/User" } } } @@ -50304,7 +63040,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/User" + } + } } } } @@ -50321,14 +63065,14 @@ } } }, - "/user-config": { + "/user-access-key": { "get": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "List with basic information of User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfigList", + "summary": "List with basic information of User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKeyList", "parameters": [ { "name": "limit", @@ -50357,7 +63101,7 @@ ], "responses": { "200": { - "description": "List of User Config resources.", + "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { @@ -50376,7 +63120,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } ] @@ -50390,16 +63134,16 @@ "type": "object", "properties": { "first": { - "example": "/user-config?limit=25" + "example": "/user-access-key?limit=25" }, "last": { - "example": "/user-config?limit=25&page=11" + "example": "/user-access-key?limit=25&page=11" }, "next": { - "example": "/user-config?limit=25&page=4" + "example": "/user-access-key?limit=25&page=4" }, "prev": { - "example": "/user-config?limit=25&page=2" + "example": "/user-access-key?limit=25&page=2" } } } @@ -50420,7 +63164,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50435,11 +63179,11 @@ }, "post": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Create a new User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createUserConfig", + "summary": "Create a new User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserAccessKey", "parameters": [ { "name": "_response", @@ -50461,7 +63205,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" }, "included": { "type": "array", @@ -50475,14 +63219,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -50494,7 +63238,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50503,7 +63247,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } } } } @@ -50517,19 +63269,93 @@ } } }, - "/user-config/{id}": { + "/search/user-access-key": { + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Search for the User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-access-key/{id}": { "get": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Detailed information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfig", + "summary": "Detailed information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -50539,7 +63365,7 @@ ], "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -50551,7 +63377,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50560,7 +63386,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } } } } @@ -50575,16 +63409,16 @@ }, "delete": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Delete a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteUserConfig", + "summary": "Delete a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -50615,16 +63449,16 @@ }, "patch": { "tags": [ - "User Config" + "User Access Key" ], - "summary": "Partially update information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateUserConfig", + "summary": "Partially update information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -50642,14 +63476,14 @@ } ], "requestBody": { - "description": "Partially update information about a User Config resource.", + "description": "Partially update information about a User Access Key resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" }, "included": { "type": "array", @@ -50663,14 +63497,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -50682,7 +63516,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -50691,7 +63525,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } } } } @@ -50708,14 +63550,14 @@ } } }, - "/user-recovery": { + "/user-config": { "get": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "List with basic information of User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecoveryList", + "summary": "List with basic information of User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfigList", "parameters": [ { "name": "limit", @@ -50744,7 +63586,7 @@ ], "responses": { "200": { - "description": "List of User Recovery resources.", + "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -50763,7 +63605,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } ] @@ -50777,16 +63619,16 @@ "type": "object", "properties": { "first": { - "example": "/user-recovery?limit=25" + "example": "/user-config?limit=25" }, "last": { - "example": "/user-recovery?limit=25&page=11" + "example": "/user-config?limit=25&page=11" }, "next": { - "example": "/user-recovery?limit=25&page=4" + "example": "/user-config?limit=25&page=4" }, "prev": { - "example": "/user-recovery?limit=25&page=2" + "example": "/user-config?limit=25&page=2" } } } @@ -50807,7 +63649,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50822,11 +63664,11 @@ }, "post": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Create a new User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUserRecovery", + "summary": "Create a new User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createUserConfig", "parameters": [ { "name": "_response", @@ -50848,7 +63690,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" }, "included": { "type": "array", @@ -50862,14 +63704,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -50881,7 +63723,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50890,7 +63732,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + } + } } } } @@ -50904,19 +63754,93 @@ } } }, - "/user-recovery/{id}": { + "/search/user-config": { + "post": { + "tags": [ + "User Config" + ], + "summary": "Search for the User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchUserConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-config/{id}": { "get": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Detailed information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserRecovery", + "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_recovery", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -50926,7 +63850,7 @@ ], "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -50938,7 +63862,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -50947,7 +63871,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + } + } } } } @@ -50962,16 +63894,16 @@ }, "delete": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Delete a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserRecovery", + "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_recovery", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -51002,16 +63934,16 @@ }, "patch": { "tags": [ - "User Recovery" + "User Config" ], - "summary": "Partially update information about a User Recovery resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserRecovery", + "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_recovery", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -51029,14 +63961,14 @@ } ], "requestBody": { - "description": "Partially update information about a User Recovery resource.", + "description": "Partially update information about a User Config resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" }, "included": { "type": "array", @@ -51050,14 +63982,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -51069,7 +64001,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserConfig" } } } @@ -51078,7 +64010,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserConfig" + } + } } } } @@ -51095,14 +64035,14 @@ } } }, - "/webhook": { + "/user-recovery": { "get": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "List with basic information of Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhookList", + "summary": "List with basic information of User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecoveryList", "parameters": [ { "name": "limit", @@ -51131,7 +64071,7 @@ ], "responses": { "200": { - "description": "List of Webhook resources.", + "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -51150,7 +64090,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } ] @@ -51164,16 +64104,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook?limit=25" + "example": "/user-recovery?limit=25" }, "last": { - "example": "/webhook?limit=25&page=11" + "example": "/user-recovery?limit=25&page=11" }, "next": { - "example": "/webhook?limit=25&page=4" + "example": "/user-recovery?limit=25&page=4" }, "prev": { - "example": "/webhook?limit=25&page=2" + "example": "/user-recovery?limit=25&page=2" } } } @@ -51194,7 +64134,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -51209,11 +64149,11 @@ }, "post": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Create a new Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createWebhook", + "summary": "Create a new User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserRecovery", "parameters": [ { "name": "_response", @@ -51235,7 +64175,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" }, "included": { "type": "array", @@ -51249,14 +64189,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -51268,7 +64208,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -51277,7 +64217,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserRecovery" + } + } } } } @@ -51291,19 +64239,93 @@ } } }, - "/webhook/{id}": { + "/search/user-recovery": { + "post": { + "tags": [ + "User Recovery" + ], + "summary": "Search for the User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserRecovery", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "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" + } + } + } + }, + "/user-recovery/{id}": { "get": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Detailed information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhook", + "summary": "Detailed information about a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -51313,7 +64335,7 @@ ], "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -51325,7 +64347,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -51334,7 +64356,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserRecovery" + } + } } } } @@ -51349,16 +64379,16 @@ }, "delete": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Delete a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteWebhook", + "summary": "Delete a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -51389,16 +64419,16 @@ }, "patch": { "tags": [ - "Webhook" + "User Recovery" ], - "summary": "Partially update information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateWebhook", + "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 webhook", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -51416,14 +64446,14 @@ } ], "requestBody": { - "description": "Partially update information about a Webhook resource.", + "description": "Partially update information about a User Recovery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" }, "included": { "type": "array", @@ -51437,14 +64467,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -51456,7 +64486,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -51465,7 +64495,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserRecovery" + } + } } } } @@ -51482,14 +64520,14 @@ } } }, - "/webhook-event-log": { + "/webhook": { "get": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "List with basic information of Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLogList", + "summary": "List with basic information of Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhookList", "parameters": [ { "name": "limit", @@ -51518,7 +64556,7 @@ ], "responses": { "200": { - "description": "List of Webhook Event Log resources.", + "description": "List of Webhook resources.", "content": { "application/vnd.api+json": { "schema": { @@ -51537,7 +64575,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } ] @@ -51551,16 +64589,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook-event-log?limit=25" + "example": "/webhook?limit=25" }, "last": { - "example": "/webhook-event-log?limit=25&page=11" + "example": "/webhook?limit=25&page=11" }, "next": { - "example": "/webhook-event-log?limit=25&page=4" + "example": "/webhook?limit=25&page=4" }, "prev": { - "example": "/webhook-event-log?limit=25&page=2" + "example": "/webhook?limit=25&page=2" } } } @@ -51581,7 +64619,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -51596,11 +64634,11 @@ }, "post": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Create a new Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "createWebhookEventLog", + "summary": "Create a new Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "createWebhook", "parameters": [ { "name": "_response", @@ -51622,7 +64660,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" }, "included": { "type": "array", @@ -51636,14 +64674,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -51655,7 +64693,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -51664,7 +64702,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" + } + } } } } @@ -51678,19 +64724,93 @@ } } }, - "/webhook-event-log/{id}": { + "/search/webhook": { + "post": { + "tags": [ + "Webhook" + ], + "summary": "Search for the Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchWebhook", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "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 Event Log" + "Webhook" ], - "summary": "Detailed information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLog", + "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_event_log", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -51700,7 +64820,7 @@ ], "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -51712,7 +64832,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -51721,7 +64841,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" + } + } } } } @@ -51736,16 +64864,16 @@ }, "delete": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Delete a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "deleteWebhookEventLog", + "summary": "Delete a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteWebhook", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -51776,16 +64904,16 @@ }, "patch": { "tags": [ - "Webhook Event Log" + "Webhook" ], - "summary": "Partially update information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "updateWebhookEventLog", + "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_event_log", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -51803,14 +64931,14 @@ } ], "requestBody": { - "description": "Partially update information about a Webhook Event Log resource.", + "description": "Partially update information about a Webhook resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" }, "included": { "type": "array", @@ -51824,14 +64952,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -51843,7 +64971,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/Webhook" } } } @@ -51852,7 +64980,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" + } + } } } } @@ -51869,169 +65005,1389 @@ } } }, - "/oauth/token": { - "post": { + "/webhook-event-log": { + "get": { "tags": [ - "Authorization & Authentication" + "Webhook Event Log" ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" - } - ] - } + "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": "Authorized successfully.", + "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": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], + "type": "object", "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", + "total": { "type": "integer" }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } - }, - "type": "object" + } } } } }, - "400": { - "$ref": "#/components/responses/400" + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_info/events.json": { - "get": { + }, + "post": { "tags": [ - "System Info & Healthcheck" + "Webhook Event Log" ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", - "responses": { - "200": { - "description": "Returns a list of about the business events.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/businessEventsResponse" - } - } + "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" + ] } } - } - } - }, - "/usage-data/needs-approval": { - "delete": { - "tags": [ - "Usage data" ], - "summary": "Get information about the usage data approval request.", - "description": "Get whether the usage data approval request is necessary or not.", - "operationId": "getNeedsUsageDataApprovalRequest", - "responses": { - "200": { - "description": "Returns true if it is needed, false if it is not." + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/WebhookEventLog" + } + } } - } - } - }, - "/_action/scheduled-task/run": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", + }, "responses": { "200": { - "description": "Returns a success message indicating a successful run.", + "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": { - "message": { - "description": "Success message", - "type": "string" + "data": { + "$ref": "#/components/schemas/WebhookEventLog" } - }, - "type": "object" + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/scheduled-task/min-run-interval": { - "get": { + "/search/webhook-event-log": { + "post": { "tags": [ - "System Operations" + "Webhook Event Log" ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + "summary": "Search for the Webhook Event Log resources.", + "description": "Available since: 6.4.1.0", + "operationId": "searchWebhookEventLog", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, "responses": { "200": { - "description": "Returns the minimum interval.", + "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": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } - }, - "type": "object" + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/indexing": { - "post": { + "/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", + "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 Event Log" + ], + "summary": "Partially update information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "updateWebhookEventLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the webhook_event_log", + "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 Event Log resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WebhookEventLog" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_info/flow-actions.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", + "responses": { + "200": { + "description": "Returns a list of action for flow builder.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flowBuilderActionsResponse" + } + } + } + } + } + } + }, + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Reserve or preview a document number", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "/_action/index": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." + } + } + } + }, + "/_action/cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } + }, + "/_action/document/{documentId}/{deepLinkCode}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "The document.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/document/{documentId}/upload": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Document uploaded successful", + "content": { + "application/json": { + "schema": { + "properties": { + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/container_cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." + } + } + } + }, + "/_action/mail-template/send": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], + "properties": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/mail-template/validate": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "contentHtml", + "contentPlain" + ], + "properties": { + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating the mail content was rendered successfully." + } + } + } + }, + "/_action/mail-template/build": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/oauth/token": { + "post": { + "tags": [ + "Authorization & Authentication" + ], + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" + }, + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Authorized successfully.", + "content": { + "application/json": { + "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], + "properties": { + "token_type": { + "description": "Type of the token.", + "type": "string" + }, + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", + "parameters": [ + { + "name": "refundId", + "in": "path", + "description": "Identifier of the order transaction capture refund.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_action/scheduled-task/run": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", + "responses": { + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/scheduled-task/min-run-interval": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", + "responses": { + "200": { + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/order/{orderId}/order-address": { + "post": { + "tags": [ + "Order address" + ], + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "type": "string", + "description": "The ID of the delivery (optional)", + "nullable": true + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", + "parameters": [ + { + "name": "orderDeliveryId", + "in": "path", + "description": "Identifier of the order delivery.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be send to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_action/indexing": { + "post": { "tags": [ "System Operations" ], @@ -52104,6 +66460,73 @@ } } }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" + }, + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/index-products": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." + } + } + } + }, "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ @@ -52176,54 +66599,62 @@ } } }, - "/_info/openapi3.json": { + "/_action/cache_info": { "get": { "tags": [ - "System Info & Healthcheck" - ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] - } - } + "System Operations" ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "Returns information about the API." + "description": "Information about the cache state.", + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } }, - "/_action/index": { + "/_action/message-queue/consume": { "post": { "tags": [ "System Operations" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "required": [ + "receiver" + ], "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" } }, "type": "object" @@ -52232,8 +66663,21 @@ } }, "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." + "200": { + "description": "Returns information about handled messages", + "content": { + "application/json": { + "schema": { + "properties": { + "handledMessages": { + "description": "The number of messages processed.", + "type": "integer" + } + }, + "type": "object" + } + } + } } } } @@ -52253,35 +66697,75 @@ } } }, - "/_action/cache_info": { - "get": { + "/_action/media/{mediaId}/upload": { + "post": { "tags": [ - "System Operations" + "Asset Management" ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "Identifier of the media entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `png`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the media file that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { - "200": { - "description": "Information about the cache state.", - "content": { - "application/json": { + "204": { + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", "schema": { - "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" - }, - "cacheAdapter": { - "description": "The active cache adapter.", - "type": "string" - } - }, - "type": "object" + "type": "string" } } } @@ -52289,67 +66773,45 @@ } } }, - "/_action/cache": { - "delete": { + "/_info/config": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", + "summary": "Get API information", + "description": "Get information about the API", + "operationId": "config", "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns information about the API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/infoConfigResponse" + } + } + } } } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { + "/_info/version": { "get": { "tags": [ - "Document Management" - ], - "summary": "Reserve or preview a document number", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } - } + "System Info & Health Check" ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "The generated number", + "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { "properties": { - "number": { - "description": "The generated (or previewed) document number.", + "version": { + "description": "The Shopware version.", "type": "string" } }, @@ -52357,24 +66819,6 @@ } } } - }, - "400": { - "description": "Number range not found" - } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispachtes an product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." } } } @@ -52563,177 +67007,10 @@ } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { - "post": { - "tags": [ - "Order Management" - ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", - "parameters": [ - { - "name": "orderDeliveryId", - "in": "path", - "description": "Identifier of the order delivery.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be send to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" - } - } - } - }, - "/_action/cache_warmup": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear and warm up caches", - "description": "After the cache has been cleared, new cache entries are generated asynchronously.", - "operationId": "clearCacheAndScheduleWarmUp", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared and generation of new cache has started." - } - } - } - }, - "/_action/message-queue/consume": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messenges from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regulary.", - "operationId": "consumeMessages", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "receiver" - ], - "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Returns information about handled messages", - "content": { - "application/json": { - "schema": { - "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/order_transaction_capture_refund/{refundId}": { - "post": { - "tags": [ - "Order Management" - ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", - "parameters": [ - { - "name": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" - } - } - } - }, "/_info/health-check": { "get": { "tags": [ - "System Info & Healthcheck" + "System Info & Health Check" ], "summary": "Check that the Application is running", "operationId": "healthCheck", @@ -52747,275 +67024,96 @@ } } }, - "/_action/mail-template/send": { - "post": { + "/_info/system-health-check": { + "get": { "tags": [ - "Mail Operations" + "System Info & Health Check" ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], - "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" - }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - } - }, - "type": "object" - } - } + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" } - }, + ], "responses": { "200": { - "description": "The mail was sent successful", + "description": "Returns the system health check results", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } } - }, - "type": "object" + } } } } + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/mail-template/validate": { - "post": { + "/_info/openapi3.json": { + "get": { "tags": [ - "Mail Operations" + "System Info & Health Check" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" - } + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] } } - }, - "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." - } - } - } - }, - "/_action/mail-template/build": { - "post": { - "tags": [ - "Mail Operations" ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], - "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "The rendered preview of the mail template.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } + "$ref": "#/components/responses/OpenApi3" } } } @@ -53065,7 +67163,7 @@ ], "properties": { "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entites with the provided identifiers", + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", "type": "string", "enum": [ "upsert", @@ -53099,15 +67197,15 @@ "schema": { "properties": { "data": { - "description": "Object with information about updated entites", + "description": "Object with information about updated entities", "type": "object" }, "notFound": { - "description": "Object with information about not found entites", + "description": "Object with information about not found entities", "type": "object" }, "deleted": { - "description": "Object with information about deleted entites", + "description": "Object with information about deleted entities", "type": "object" } }, @@ -53119,302 +67217,21 @@ } } }, - "/_action/container_cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." - } - } - } - }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Healthcheck" - ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBulderActionsResponse" - } - } - } - } - } - } - }, - "/_info/config": { - "get": { - "tags": [ - "System Info & Healthcheck" - ], - "summary": "Get API information", - "description": "Get information about the API", - "operationId": "config", - "responses": { - "200": { - "description": "Returns information about the API.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/infoConfigResponse" - } - } - } - } - } - } - }, - "/_info/version": { - "get": { - "tags": [ - "System Info & Healthcheck" - ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/media/{mediaId}/upload": { - "post": { - "tags": [ - "Asset Management" - ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "description": "Identifier of the media entity.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `png`", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/_action/document/{documentId}/{deepLinkCode}": { + "/_info/events.json": { "get": { "tags": [ - "Document Management" - ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document to be downloaded.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "The document.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, - "/_action/document/{documentId}/upload": { - "post": { - "tags": [ - "Document Management" - ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document the new file should be added to.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", - "required": true, - "schema": { - "type": "string" - } - } + "System Info & Health Check" ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { "200": { - "description": "Document uploaded successful", + "description": "Returns a list of about the business events.", "content": { "application/json": { "schema": { - "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/businessEventsResponse" } } } @@ -53783,6 +67600,7 @@ }, { "required": [ + "id", "name", "privileges", "createdAt" @@ -53923,6 +67741,7 @@ "AclRole": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "privileges", "createdAt" @@ -54032,6 +67851,7 @@ }, { "required": [ + "id", "name", "path", "active", @@ -54111,6 +67931,9 @@ "type": "integer", "format": "int64" }, + "checkoutGatewayUrl": { + "type": "string" + }, "label": { "type": "string" }, @@ -54482,6 +68305,37 @@ } }, "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" @@ -54494,6 +68348,7 @@ "App": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "name", "path", "active", @@ -54590,6 +68445,9 @@ "format": "int64", "description": "A numerical value to prioritize one of the templates from the list." }, + "checkoutGatewayUrl": { + "type": "string" + }, "label": { "type": "string", "description": "Label given to an app." @@ -54689,6 +68547,12 @@ "items": { "$ref": "#/components/schemas/AppFlowEvent" } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } }, "type": "object" @@ -54701,6 +68565,7 @@ }, { "required": [ + "id", "entity", "view", "url", @@ -54788,6 +68653,7 @@ "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "entity", "view", "url", @@ -54855,6 +68721,7 @@ }, { "required": [ + "id", "value", "appId", "localeId", @@ -54894,6 +68761,7 @@ "AppAdministrationSnippet": { "description": "Added since version: 6.4.15.0", "required": [ + "id", "value", "appId", "localeId", @@ -54940,6 +68808,7 @@ }, { "required": [ + "id", "name", "block", "template", @@ -55027,6 +68896,7 @@ "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": [ + "id", "name", "block", "template", @@ -55094,6 +68964,7 @@ }, { "required": [ + "id", "appId", "name", "url", @@ -55245,6 +69116,7 @@ "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": [ + "id", "appId", "name", "url", @@ -55355,6 +69227,7 @@ }, { "required": [ + "id", "appId", "name", "aware", @@ -55464,6 +69337,7 @@ "AppFlowEvent": { "description": "Added since version: 6.5.2.0", "required": [ + "id", "appId", "name", "aware", @@ -55525,6 +69399,7 @@ }, { "required": [ + "id", "appName", "identifier", "paymentMethodId", @@ -55681,6 +69556,7 @@ "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", "required": [ + "id", "appName", "identifier", "paymentMethodId", @@ -55769,6 +69645,7 @@ }, { "required": [ + "id", "identifier", "active", "appId", @@ -55888,6 +69765,7 @@ "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": [ + "id", "identifier", "active", "appId", @@ -55955,6 +69833,204 @@ }, "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": [ @@ -55963,6 +70039,7 @@ }, { "required": [ + "id", "template", "path", "active", @@ -56039,6 +70116,7 @@ "AppTemplate": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "template", "path", "active", @@ -56092,6 +70170,7 @@ }, { "required": [ + "id", "displayNestedProducts", "type", "productAssignmentType", @@ -56649,6 +70728,7 @@ "Category": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "displayNestedProducts", "type", "productAssignmentType", @@ -56943,6 +71023,7 @@ }, { "required": [ + "id", "position", "type", "sectionId", @@ -57135,6 +71216,7 @@ "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "position", "type", "sectionId", @@ -57269,6 +71351,7 @@ }, { "required": [ + "id", "type", "createdAt" ], @@ -57521,6 +71604,7 @@ "CmsPage": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "createdAt" ], @@ -57631,6 +71715,7 @@ }, { "required": [ + "id", "position", "type", "pageId", @@ -57814,6 +71899,7 @@ "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "position", "type", "pageId", @@ -57936,6 +72022,7 @@ }, { "required": [ + "id", "type", "slot", "blockId", @@ -58035,6 +72122,7 @@ "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "slot", "blockId", @@ -58120,6 +72208,8 @@ }, { "required": [ + "id", + "isEu", "createdAt", "name", "addressFormat" @@ -58224,6 +72314,9 @@ "defaultPostalCodePattern": { "type": "string" }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -58467,6 +72560,8 @@ "Country": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "isEu", "createdAt", "name", "addressFormat" @@ -58596,6 +72691,9 @@ "type": "string", "description": "Default pattern of postal or zip code." }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -58663,6 +72761,7 @@ }, { "required": [ + "id", "countryId", "shortCode", "createdAt", @@ -58810,6 +72909,7 @@ "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "countryId", "shortCode", "createdAt", @@ -58887,6 +72987,7 @@ }, { "required": [ + "id", "factor", "symbol", "isoCode", @@ -58933,6 +73034,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -58949,6 +73055,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59207,6 +73318,7 @@ "Currency": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "factor", "symbol", "isoCode", @@ -59262,6 +73374,11 @@ "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59281,6 +73398,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59366,6 +73488,7 @@ }, { "required": [ + "id", "currencyId", "countryId", "itemRounding", @@ -59386,6 +73509,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59402,6 +73530,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59498,6 +73631,7 @@ "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", "required": [ + "id", "currencyId", "countryId", "itemRounding", @@ -59521,6 +73655,11 @@ "description": "Unique identity of the country." }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59540,6 +73679,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -59585,6 +73729,7 @@ }, { "required": [ + "id", "name", "fields", "createdAt" @@ -59625,6 +73770,10 @@ "labelProperty": { "type": "string" }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -59643,6 +73792,7 @@ "CustomEntity": { "description": "Added since version: 6.4.9.0", "required": [ + "id", "name", "fields", "createdAt" @@ -59691,6 +73841,10 @@ "type": "string", "description": "Specifies which property or attribute of the custom entity is used." }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -59712,6 +73866,7 @@ }, { "required": [ + "id", "name", "type", "createdAt" @@ -59826,6 +73981,7 @@ "CustomField": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "type", "createdAt" @@ -59895,6 +74051,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -60068,6 +74225,7 @@ "CustomFieldSet": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "createdAt" ], @@ -60145,6 +74303,7 @@ }, { "required": [ + "id", "customFieldSetId", "entityName", "createdAt" @@ -60213,6 +74372,7 @@ "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "customFieldSetId", "entityName", "createdAt" @@ -60256,8 +74416,8 @@ }, { "required": [ + "id", "groupId", - "defaultPaymentMethodId", "salesChannelId", "languageId", "defaultBillingAddressId", @@ -60267,6 +74427,7 @@ "lastName", "email", "accountType", + "defaultPaymentMethodId", "createdAt" ], "properties": { @@ -60278,10 +74439,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -60425,6 +74582,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -60466,35 +74627,6 @@ }, "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" - }, "salesChannel": { "properties": { "links": { @@ -60999,6 +75131,35 @@ } }, "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" @@ -61011,8 +75172,8 @@ "Customer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "groupId", - "defaultPaymentMethodId", "salesChannelId", "languageId", "defaultBillingAddressId", @@ -61022,6 +75183,7 @@ "lastName", "email", "accountType", + "defaultPaymentMethodId", "createdAt" ], "properties": { @@ -61035,11 +75197,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of customer group." }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of default payment method." - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -61218,6 +75375,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of default payment method." + }, "createdAt": { "type": "string", "format": "date-time", @@ -61231,9 +75393,6 @@ "group": { "$ref": "#/components/schemas/CustomerGroup" }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, @@ -61302,6 +75461,9 @@ }, "updatedBy": { "$ref": "#/components/schemas/User" + }, + "defaultPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" @@ -61314,6 +75476,7 @@ }, { "required": [ + "id", "customerId", "countryId", "firstName", @@ -61518,6 +75681,7 @@ "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "customerId", "countryId", "firstName", @@ -61633,6 +75797,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -61784,6 +75949,7 @@ "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -61905,6 +76071,7 @@ }, { "required": [ + "id", "hash", "customerId", "createdAt" @@ -61973,6 +76140,7 @@ "CustomerRecovery": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "hash", "customerId", "createdAt" @@ -62047,6 +76215,7 @@ }, { "required": [ + "id", "customerId", "salesChannelId", "createdAt" @@ -62179,6 +76348,7 @@ "CustomerWishlist": { "description": "Added since version: 6.3.4.0", "required": [ + "id", "customerId", "salesChannelId", "createdAt" @@ -62236,6 +76406,7 @@ }, { "required": [ + "id", "productId", "wishlistId", "createdAt" @@ -62338,6 +76509,7 @@ "CustomerWishlistProduct": { "description": "Added since version: 6.3.4.0", "required": [ + "id", "productId", "wishlistId", "createdAt" @@ -62390,6 +76562,7 @@ }, { "required": [ + "id", "name", "min", "max", @@ -62506,6 +76679,7 @@ "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "min", "max", @@ -62577,6 +76751,7 @@ }, { "required": [ + "id", "documentTypeId", "fileType", "orderId", @@ -62624,6 +76799,9 @@ "deepLinkCode": { "type": "string" }, + "documentNumber": { + "type": "string" + }, "customFields": { "type": "object" }, @@ -62797,6 +76975,7 @@ "Document": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentTypeId", "fileType", "orderId", @@ -62855,6 +77034,9 @@ "type": "string", "description": "It is a generated special code linked to email. It is used to access details of guest customer actions." }, + "documentNumber": { + "type": "string" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -62898,6 +77080,7 @@ }, { "required": [ + "id", "documentTypeId", "name", "global", @@ -63049,6 +77232,7 @@ "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentTypeId", "name", "global", @@ -63132,6 +77316,7 @@ }, { "required": [ + "id", "documentBaseConfigId", "createdAt" ], @@ -63262,6 +77447,7 @@ "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentBaseConfigId", "createdAt" ], @@ -63316,6 +77502,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -63453,6 +77640,7 @@ "DocumentType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -63518,6 +77706,7 @@ }, { "required": [ + "id", "name", "eventName", "createdAt" @@ -63637,6 +77826,7 @@ "Flow": { "description": "Added since version: 6.4.6.0", "required": [ + "id", "name", "eventName", "createdAt" @@ -63712,6 +77902,7 @@ }, { "required": [ + "id", "flowId", "createdAt" ], @@ -63926,6 +78117,7 @@ "FlowSequence": { "description": "Added since version: 6.4.6.0", "required": [ + "id", "flowId", "createdAt" ], @@ -64021,6 +78213,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -64053,6 +78246,7 @@ "FlowTemplate": { "description": "Added since version: 6.4.18.0", "required": [ + "id", "name", "createdAt" ], @@ -64091,6 +78285,7 @@ }, { "required": [ + "id", "originalName", "path", "expireDate", @@ -64170,6 +78365,7 @@ "ImportExportFile": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "originalName", "path", "expireDate", @@ -64227,6 +78423,7 @@ }, { "required": [ + "id", "activity", "state", "records", @@ -64444,6 +78641,7 @@ "ImportExportLog": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "activity", "state", "records", @@ -64541,6 +78739,7 @@ }, { "required": [ + "id", "label", "sourceEntity", "fileType", @@ -64553,9 +78752,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, "label": { "type": "string" }, @@ -64586,6 +78782,12 @@ "config": { "type": "object" }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -64643,6 +78845,7 @@ "ImportExportProfile": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "label", "sourceEntity", "fileType", @@ -64656,10 +78859,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of import-export profile." }, - "name": { - "type": "string", - "description": "Unique name of the import-export file." - }, "label": { "type": "string", "description": "Label given to ImportExportProfile." @@ -64698,6 +78897,13 @@ "type": "object", "description": "Specifies detailed information about the component." }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string", + "description": "Unique name of the import-export file." + }, "createdAt": { "type": "string", "format": "date-time", @@ -64729,6 +78935,7 @@ }, { "required": [ + "id", "label", "accessKey", "secretAccessKey", @@ -64762,10 +78969,6 @@ "type": "string", "format": "date-time" }, - "writeAccess": { - "type": "boolean", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -64885,6 +79088,7 @@ "Integration": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "label", "accessKey", "secretAccessKey", @@ -64926,11 +79130,6 @@ "format": "date-time", "description": "Date and time when the integration was deleted." }, - "writeAccess": { - "type": "boolean", - "deprecated": true, - "description": "This field is deprecated." - }, "createdAt": { "type": "string", "format": "date-time", @@ -64986,6 +79185,9 @@ "$ref": "#/components/schemas/AclRole" } }, + "writeAccess": { + "description": "This field is deprecated." + }, "integrationId": { "description": "Unique identity of integration" }, @@ -65032,6 +79234,7 @@ }, { "required": [ + "id", "createdAt", "name", "url" @@ -65225,6 +79428,7 @@ "LandingPage": { "description": "Added since version: 6.4.0.0", "required": [ + "id", "createdAt", "name", "url" @@ -65400,6 +79604,7 @@ }, { "required": [ + "id", "localeId", "name", "createdAt" @@ -65876,6 +80081,7 @@ "Language": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "localeId", "name", "createdAt" @@ -66002,6 +80208,7 @@ }, { "required": [ + "id", "code", "createdAt", "name", @@ -66112,6 +80319,7 @@ "Locale": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "code", "createdAt", "name", @@ -66176,6 +80384,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -66217,6 +80426,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -66266,6 +80476,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -66352,6 +80563,7 @@ "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -66420,6 +80632,7 @@ }, { "required": [ + "id", "mailTemplateTypeId", "createdAt", "subject", @@ -66542,6 +80755,7 @@ "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "mailTemplateTypeId", "createdAt", "subject", @@ -66616,6 +80830,7 @@ "MailTemplateMedia": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "mailTemplateId", "languageId", "mediaId" @@ -66663,6 +80878,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -66744,6 +80960,7 @@ "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -66805,6 +81022,7 @@ }, { "required": [ + "id", "productId", "categoryId", "salesChannelId", @@ -66945,6 +81163,7 @@ "MainCategory": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "productId", "categoryId", "salesChannelId", @@ -67011,6 +81230,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -67056,6 +81276,9 @@ "type": "object", "readOnly": true }, + "config": { + "type": "object" + }, "alt": { "type": "string" }, @@ -67066,6 +81289,9 @@ "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" @@ -67835,6 +82061,37 @@ } }, "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" @@ -67847,6 +82104,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -67902,6 +82160,9 @@ "readOnly": true, "description": "Type or format of media content, such as images, videos, or audio files." }, + "config": { + "type": "object" + }, "alt": { "type": "string", "description": "Alternate text for media." @@ -67914,6 +82175,9 @@ "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" @@ -68133,6 +82397,12 @@ "items": { "$ref": "#/components/schemas/AppPaymentMethod" } + }, + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } }, "type": "object" @@ -68145,8 +82415,8 @@ }, { "required": [ + "id", "entity", - "associationFields", "createdAt" ], "properties": { @@ -68160,12 +82430,6 @@ "customFields": { "type": "object" }, - "associationFields": { - "type": "array", - "items": { - "type": "string" - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -68218,8 +82482,8 @@ "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "entity", - "associationFields", "createdAt" ], "properties": { @@ -68236,12 +82500,6 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "associationFields": { - "type": "array", - "items": { - "type": "string" - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -68266,6 +82524,7 @@ }, { "required": [ + "id", "configurationId", "name", "createdAt" @@ -68477,6 +82736,7 @@ "MediaFolder": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "configurationId", "name", "createdAt" @@ -68567,6 +82827,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -68678,6 +82939,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -68802,6 +83064,7 @@ }, { "required": [ + "id", "mediaId", "width", "height", @@ -68830,6 +83093,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "path": { + "type": "string" + }, "customFields": { "type": "object" }, @@ -68885,6 +83151,7 @@ "MediaThumbnail": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "mediaId", "width", "height", @@ -68917,6 +83184,9 @@ "description": "Public url of media thumbnail.", "type": "string" }, + "path": { + "type": "string" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -68945,6 +83215,7 @@ }, { "required": [ + "id", "width", "height", "createdAt" @@ -69019,6 +83290,7 @@ "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "width", "height", "createdAt" @@ -69070,6 +83342,7 @@ }, { "required": [ + "id", "email", "status", "hash", @@ -69269,6 +83542,7 @@ "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "email", "status", "hash", @@ -69409,6 +83683,7 @@ }, { "required": [ + "id", "status", "message", "createdAt" @@ -69523,6 +83798,7 @@ "Notification": { "description": "Added since version: 6.4.7.0", "required": [ + "id", "status", "message", "createdAt" @@ -69590,6 +83866,7 @@ }, { "required": [ + "id", "typeId", "global", "pattern", @@ -69740,6 +84017,7 @@ "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "typeId", "global", "pattern", @@ -69820,6 +84098,7 @@ }, { "required": [ + "id", "numberRangeId", "salesChannelId", "createdAt" @@ -69951,6 +84230,7 @@ "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "numberRangeId", "salesChannelId", "createdAt" @@ -70006,6 +84286,7 @@ }, { "required": [ + "id", "numberRangeId", "lastValue", "createdAt" @@ -70075,6 +84356,7 @@ "NumberRangeState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "numberRangeId", "lastValue", "createdAt" @@ -70118,6 +84400,7 @@ }, { "required": [ + "id", "global", "createdAt", "typeName" @@ -70227,6 +84510,7 @@ "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "global", "createdAt", "typeName" @@ -70290,6 +84574,7 @@ }, { "required": [ + "id", "billingAddressId", "currencyId", "languageId", @@ -70505,6 +84790,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -70521,6 +84811,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -70977,6 +85272,7 @@ "Order": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "billingAddressId", "currencyId", "languageId", @@ -71236,6 +85532,11 @@ "description": "Unique identity of updatedBy." }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -71255,6 +85556,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -71354,6 +85660,7 @@ }, { "required": [ + "id", "countryId", "orderId", "firstName", @@ -71600,6 +85907,7 @@ "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "countryId", "orderId", "firstName", @@ -71735,6 +86043,7 @@ }, { "required": [ + "id", "orderId", "email", "firstName", @@ -71906,6 +86215,7 @@ "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "email", "firstName", @@ -72012,6 +86322,7 @@ }, { "required": [ + "id", "orderId", "shippingOrderAddressId", "shippingMethodId", @@ -72298,6 +86609,7 @@ "OrderDelivery": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "shippingOrderAddressId", "shippingMethodId", @@ -72475,6 +86787,7 @@ }, { "required": [ + "id", "orderDeliveryId", "orderLineItemId", "createdAt" @@ -72657,6 +86970,7 @@ "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderDeliveryId", "orderLineItemId", "createdAt" @@ -72805,6 +87119,7 @@ }, { "required": [ + "id", "orderId", "identifier", "quantity", @@ -72842,8 +87157,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -73261,6 +87575,7 @@ "OrderLineItem": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "identifier", "quantity", @@ -73305,7 +87620,6 @@ "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "readOnly": true, "description": "Unique identity of product." }, "parentId": { @@ -73521,6 +87835,7 @@ }, { "required": [ + "id", "orderLineItemId", "mediaId", "position", @@ -73639,6 +87954,7 @@ "OrderLineItemDownload": { "description": "Added since version: 6.4.19.0", "required": [ + "id", "orderLineItemId", "mediaId", "position", @@ -73747,6 +88063,7 @@ }, { "required": [ + "id", "orderId", "paymentMethodId", "amount", @@ -73831,6 +88148,9 @@ }, "type": "object" }, + "validationData": { + "type": "object" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -73979,6 +88299,7 @@ "OrderTransaction": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "paymentMethodId", "amount", @@ -74071,6 +88392,9 @@ }, "type": "object" }, + "validationData": { + "type": "object" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -74149,6 +88473,7 @@ }, { "required": [ + "id", "orderTransactionId", "stateId", "amount", @@ -74350,6 +88675,7 @@ "OrderTransactionCapture": { "description": "Added since version: 6.4.12.0", "required": [ + "id", "orderTransactionId", "stateId", "amount", @@ -74515,6 +88841,7 @@ }, { "required": [ + "id", "captureId", "stateId", "amount", @@ -74719,6 +89046,7 @@ "OrderTransactionCaptureRefund": { "description": "Added since version: 6.4.12.0", "required": [ + "id", "captureId", "stateId", "amount", @@ -74888,6 +89216,7 @@ }, { "required": [ + "id", "refundId", "orderLineItemId", "amount", @@ -75069,6 +89398,7 @@ "OrderTransactionCaptureRefundPosition": { "description": "Added since version: 6.4.12.0", "required": [ + "id", "refundId", "orderLineItemId", "amount", @@ -75242,6 +89572,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -75322,6 +89653,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -75588,6 +89922,7 @@ "PaymentMethod": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -75680,6 +90015,9 @@ "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -75741,6 +90079,7 @@ }, { "required": [ + "id", "baseClass", "name", "autoload", @@ -75814,9 +90153,6 @@ "supportLink": { "type": "string" }, - "changelog": { - "type": "object" - }, "customFields": { "type": "object" }, @@ -75877,6 +90213,7 @@ "Plugin": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "baseClass", "name", "autoload", @@ -75969,10 +90306,6 @@ "type": "string", "description": "Links to the support page" }, - "changelog": { - "type": "object", - "description": "Deprecated from Shopware version 6.6" - }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -75996,6 +90329,9 @@ "items": { "$ref": "#/components/schemas/PaymentMethod" } + }, + "changelog": { + "description": "Deprecated from Shopware version 6.6" } }, "type": "object" @@ -76008,6 +90344,7 @@ }, { "required": [ + "id", "taxId", "price", "productNumber", @@ -76068,6 +90405,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -76101,6 +90442,15 @@ "isCloseout": { "type": "boolean" }, + "availableStock": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "type": "integer", + "format": "int64" + }, "variation": { "type": "array", "items": { @@ -76279,14 +90629,6 @@ "additionalProperties": false } }, - "availableStock": { - "type": "integer", - "format": "int64" - }, - "stock": { - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -77225,6 +91567,7 @@ "Product": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "taxId", "price", "productNumber", @@ -77298,6 +91641,10 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of canonical product." }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -77340,6 +91687,17 @@ "type": "boolean", "description": "When the value is set to true, the product is hidden when sold out." }, + "availableStock": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Indicates the number of products still available. This value results from the stock minus the open orders." + }, + "stock": { + "type": "integer", + "format": "int64", + "description": "Indicates the number of products available." + }, "variation": { "type": "array", "items": { @@ -77558,16 +91916,6 @@ }, "description": "List of additional keywords in the search." }, - "availableStock": { - "type": "integer", - "format": "int64", - "description": "Indicates the number of products still available. This value results from the stock minus the open orders." - }, - "stock": { - "type": "integer", - "format": "int64", - "description": "Indicates the number of products available." - }, "createdAt": { "type": "string", "format": "date-time", @@ -77828,6 +92176,7 @@ }, { "required": [ + "id", "productId", "optionId", "createdAt" @@ -77977,6 +92326,7 @@ "ProductConfiguratorSetting": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", "optionId", "createdAt" @@ -78055,6 +92405,7 @@ }, { "required": [ + "id", "name", "position", "type", @@ -78216,6 +92567,7 @@ "ProductCrossSelling": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "name", "position", "type", @@ -78310,6 +92662,7 @@ }, { "required": [ + "id", "crossSellingId", "productId", "createdAt" @@ -78416,6 +92769,7 @@ "ProductCrossSellingAssignedProducts": { "description": "Added since version: 6.2.0.0", "required": [ + "id", "crossSellingId", "productId", "createdAt" @@ -78509,6 +92863,7 @@ }, { "required": [ + "id", "productId", "mediaId", "createdAt" @@ -78622,6 +92977,7 @@ "ProductDownload": { "description": "Added since version: 6.4.19.0", "required": [ + "id", "productId", "mediaId", "createdAt" @@ -78688,6 +93044,7 @@ }, { "required": [ + "id", "productStreamId", "storefrontSalesChannelId", "salesChannelId", @@ -78935,6 +93292,7 @@ "ProductExport": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "productStreamId", "storefrontSalesChannelId", "salesChannelId", @@ -79069,6 +93427,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -79143,6 +93502,7 @@ "ProductFeatureSet": { "description": "Added since version: 6.3.0.0", "required": [ + "id", "createdAt", "name" ], @@ -79195,6 +93555,7 @@ }, { "required": [ + "id", "languageId", "keyword" ], @@ -79255,6 +93616,7 @@ "ProductKeywordDictionary": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "languageId", "keyword" ], @@ -79291,6 +93653,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -79405,6 +93768,7 @@ "ProductManufacturer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -79474,6 +93838,7 @@ }, { "required": [ + "id", "productId", "mediaId", "createdAt" @@ -79618,6 +93983,7 @@ "ProductMedia": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", "mediaId", "createdAt" @@ -79726,6 +94092,7 @@ }, { "required": [ + "id", "productId", "ruleId", "price", @@ -79848,6 +94215,7 @@ "ProductPrice": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", "ruleId", "price", @@ -79961,6 +94329,7 @@ }, { "required": [ + "id", "productId", "salesChannelId", "languageId", @@ -80157,6 +94526,7 @@ "ProductReview": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", "salesChannelId", "languageId", @@ -80261,6 +94631,7 @@ }, { "required": [ + "id", "languageId", "andLogic", "minSearchLength", @@ -80371,6 +94742,7 @@ "ProductSearchConfig": { "description": "Added since version: 6.3.5.0", "required": [ + "id", "languageId", "andLogic", "minSearchLength", @@ -80433,6 +94805,7 @@ }, { "required": [ + "id", "searchConfigId", "field", "tokenize", @@ -80547,6 +94920,7 @@ "ProductSearchConfigField": { "description": "Added since version: 6.3.5.0", "required": [ + "id", "searchConfigId", "field", "tokenize", @@ -80614,6 +94988,7 @@ }, { "required": [ + "id", "languageId", "productId", "keyword", @@ -80729,6 +95104,7 @@ "ProductSearchKeyword": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "languageId", "productId", "keyword", @@ -80797,6 +95173,7 @@ }, { "required": [ + "id", "key", "priority", "active", @@ -80849,6 +95226,7 @@ "ProductSorting": { "description": "Added since version: 6.3.2.0", "required": [ + "id", "key", "priority", "active", @@ -80912,6 +95290,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -81087,6 +95466,7 @@ "ProductStream": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -81167,6 +95547,7 @@ }, { "required": [ + "id", "productStreamId", "type", "createdAt" @@ -81318,6 +95699,7 @@ "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productStreamId", "type", "createdAt" @@ -81474,6 +95856,7 @@ }, { "required": [ + "id", "productId", "salesChannelId", "visibility", @@ -81581,6 +95964,7 @@ "ProductVisibility": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", "salesChannelId", "visibility", @@ -81639,6 +96023,7 @@ }, { "required": [ + "id", "active", "priority", "exclusive", @@ -82028,6 +96413,7 @@ "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "active", "priority", "exclusive", @@ -82242,6 +96628,7 @@ }, { "required": [ + "id", "promotionId", "scope", "type", @@ -82401,6 +96788,7 @@ "PromotionDiscount": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "promotionId", "scope", "type", @@ -82493,6 +96881,7 @@ }, { "required": [ + "id", "discountId", "currencyId", "price", @@ -82596,6 +96985,7 @@ "PromotionDiscountPrices": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "discountId", "currencyId", "price", @@ -82680,6 +97070,7 @@ }, { "required": [ + "id", "promotionId", "code", "createdAt" @@ -82751,6 +97142,7 @@ "PromotionIndividualCode": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "promotionId", "code", "createdAt" @@ -82891,6 +97283,7 @@ }, { "required": [ + "id", "promotionId", "salesChannelId", "priority", @@ -82994,6 +97387,7 @@ "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "promotionId", "salesChannelId", "priority", @@ -83047,6 +97441,7 @@ }, { "required": [ + "id", "promotionId", "packagerKey", "sorterKey", @@ -83155,6 +97550,7 @@ "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "promotionId", "packagerKey", "sorterKey", @@ -83246,6 +97642,7 @@ }, { "required": [ + "id", "displayType", "sortingType", "createdAt", @@ -83338,6 +97735,7 @@ "PropertyGroup": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "displayType", "sortingType", "createdAt", @@ -83413,6 +97811,7 @@ }, { "required": [ + "id", "groupId", "createdAt", "name" @@ -83620,6 +98019,7 @@ "PropertyGroupOption": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "groupId", "createdAt", "name" @@ -83706,6 +98106,7 @@ }, { "required": [ + "id", "name", "priority", "createdAt" @@ -84200,6 +98601,7 @@ "Rule": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "priority", "createdAt" @@ -84353,6 +98755,7 @@ }, { "required": [ + "id", "type", "ruleId", "createdAt" @@ -84528,6 +98931,7 @@ "RuleCondition": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "ruleId", "createdAt" @@ -84637,6 +99041,7 @@ }, { "required": [ + "id", "typeId", "languageId", "customerGroupId", @@ -85972,6 +100377,7 @@ "SalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "typeId", "languageId", "customerGroupId", @@ -86404,6 +100810,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -86475,6 +100882,7 @@ "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -86585,6 +100993,7 @@ }, { "required": [ + "id", "url", "salesChannelId", "languageId", @@ -86821,6 +101230,7 @@ "SalesChannelDomain": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "url", "salesChannelId", "languageId", @@ -87001,6 +101411,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -87093,6 +101504,7 @@ "SalesChannelType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -87167,6 +101579,7 @@ }, { "required": [ + "id", "salutationKey", "createdAt", "displayName", @@ -87370,6 +101783,7 @@ "Salutation": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "salutationKey", "createdAt", "displayName", @@ -87452,9 +101866,11 @@ }, { "required": [ + "id", "name", "scheduledTaskClass", "runInterval", + "defaultRunInterval", "status", "nextExecutionTime", "createdAt" @@ -87474,6 +101890,10 @@ "type": "integer", "format": "int64" }, + "defaultRunInterval": { + "type": "integer", + "format": "int64" + }, "status": { "type": "string" }, @@ -87485,10 +101905,6 @@ "type": "string", "format": "date-time" }, - "defaultRunInterval": { - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -87507,9 +101923,11 @@ "ScheduledTask": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "scheduledTaskClass", "runInterval", + "defaultRunInterval", "status", "nextExecutionTime", "createdAt" @@ -87533,6 +101951,11 @@ "format": "int64", "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc" }, + "defaultRunInterval": { + "type": "integer", + "format": "int64", + "description": "Default run interval setting." + }, "status": { "type": "string", "description": "When status is set, the ScheduledTask is made visible." @@ -87547,11 +101970,6 @@ "format": "date-time", "description": "Time when the scheduled task will execute next. " }, - "defaultRunInterval": { - "type": "integer", - "format": "int64", - "description": "Default run interval setting." - }, "createdAt": { "type": "string", "format": "date-time", @@ -87573,6 +101991,7 @@ }, { "required": [ + "id", "script", "hook", "name", @@ -87652,6 +102071,7 @@ "Script": { "description": "Added since version: 6.4.7.0", "required": [ + "id", "script", "hook", "name", @@ -87708,6 +102128,7 @@ }, { "required": [ + "id", "languageId", "foreignKey", "routeName", @@ -87750,6 +102171,10 @@ "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" @@ -87757,10 +102182,6 @@ "customFields": { "type": "object" }, - "isValid": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -87842,6 +102263,7 @@ "SeoUrl": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "languageId", "foreignKey", "routeName", @@ -87894,6 +102316,10 @@ "type": "boolean", "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later." }, + "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" @@ -87902,10 +102328,6 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "isValid": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -87933,6 +102355,7 @@ }, { "required": [ + "id", "entityName", "routeName", "createdAt" @@ -88013,6 +102436,7 @@ "SeoUrlTemplate": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "entityName", "routeName", "createdAt" @@ -88072,7 +102496,7 @@ }, { "required": [ - "availabilityRuleId", + "id", "deliveryTimeId", "taxType", "createdAt", @@ -88121,6 +102545,9 @@ "trackingUrl": { "type": "string" }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -88406,6 +102833,35 @@ } }, "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" @@ -88418,7 +102874,7 @@ "ShippingMethod": { "description": "Added since version: 6.0.0.0", "required": [ - "availabilityRuleId", + "id", "deliveryTimeId", "taxType", "createdAt", @@ -88479,6 +102935,9 @@ "type": "string", "description": "This URL allows to track packages." }, + "technicalName": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -88534,6 +102993,9 @@ }, "tax": { "$ref": "#/components/schemas/Tax" + }, + "appShippingMethod": { + "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" @@ -88546,6 +103008,7 @@ }, { "required": [ + "id", "shippingMethodId", "createdAt" ], @@ -88694,6 +103157,7 @@ "ShippingMethodPrice": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "shippingMethodId", "createdAt" ], @@ -88802,6 +103266,7 @@ }, { "required": [ + "id", "setId", "translationKey", "value", @@ -88881,6 +103346,7 @@ "Snippet": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "setId", "translationKey", "value", @@ -88938,6 +103404,7 @@ }, { "required": [ + "id", "name", "baseFile", "iso", @@ -89045,6 +103512,7 @@ "SnippetSet": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "baseFile", "iso", @@ -89104,6 +103572,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -89245,6 +103714,7 @@ "StateMachine": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -89313,11 +103783,13 @@ }, { "required": [ + "id", + "referencedId", + "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId", - "entityId", "createdAt" ], "properties": { @@ -89325,6 +103797,14 @@ "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}$" @@ -89347,18 +103827,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityId": { - "type": "object", - "deprecated": true - }, - "referencedId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -89498,11 +103966,13 @@ "StateMachineHistory": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "referencedId", + "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId", - "entityId", "createdAt" ], "properties": { @@ -89511,6 +103981,16 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of state machine history." }, + "referencedId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of reference." + }, + "referencedVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of reference's version." + }, "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -89539,21 +104019,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of user." }, - "entityId": { - "type": "object", - "deprecated": true, - "description": "Unique identity of entity." - }, - "referencedId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of reference." - }, - "referencedVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of reference's version." - }, "createdAt": { "type": "string", "format": "date-time", @@ -89575,6 +104040,9 @@ }, "user": { "$ref": "#/components/schemas/User" + }, + "entityId": { + "description": "Unique identity of entity." } }, "type": "object" @@ -89587,6 +104055,7 @@ }, { "required": [ + "id", "technicalName", "stateMachineId", "createdAt", @@ -89944,6 +104413,7 @@ "StateMachineState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "stateMachineId", "createdAt", @@ -90054,6 +104524,7 @@ }, { "required": [ + "id", "actionName", "stateMachineId", "fromStateId", @@ -90193,6 +104664,7 @@ "StateMachineTransition": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "actionName", "stateMachineId", "fromStateId", @@ -90258,6 +104730,7 @@ }, { "required": [ + "id", "configurationKey", "configurationValue", "createdAt" @@ -90334,6 +104807,7 @@ "SystemConfig": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "configurationKey", "configurationValue", "createdAt" @@ -90386,6 +104860,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -90699,6 +105174,7 @@ "Tag": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "createdAt" ], @@ -90787,6 +105263,7 @@ }, { "required": [ + "id", "taxRate", "name", "position", @@ -90928,6 +105405,7 @@ "Tax": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "taxRate", "name", "position", @@ -90996,6 +105474,7 @@ }, { "required": [ + "id", "identifier", "priority", "createdAt", @@ -91117,6 +105596,7 @@ "TaxProvider": { "description": "Added since version: 6.5.0.0", "required": [ + "id", "identifier", "priority", "createdAt", @@ -91194,6 +105674,7 @@ }, { "required": [ + "id", "taxRuleTypeId", "countryId", "taxRate", @@ -91356,6 +105837,7 @@ "TaxRule": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "taxRuleTypeId", "countryId", "taxRate", @@ -91448,6 +105930,7 @@ }, { "required": [ + "id", "technicalName", "position", "createdAt", @@ -91526,6 +106009,7 @@ "TaxRuleType": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "technicalName", "position", "createdAt", @@ -91582,6 +106066,7 @@ }, { "required": [ + "id", "name", "author", "active", @@ -91781,6 +106266,7 @@ "Theme": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "author", "active", @@ -91985,6 +106471,7 @@ }, { "required": [ + "id", "createdAt", "shortCode", "name" @@ -92060,6 +106547,7 @@ "Unit": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "shortCode", "name" @@ -92113,6 +106601,7 @@ }, { "required": [ + "id", "localeId", "username", "firstName", @@ -92621,6 +107110,7 @@ "User": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "localeId", "username", "firstName", @@ -92812,6 +107302,7 @@ }, { "required": [ + "id", "userId", "accessKey", "secretAccessKey", @@ -92891,6 +107382,7 @@ "UserAccessKey": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "userId", "accessKey", "secretAccessKey", @@ -92948,6 +107440,7 @@ }, { "required": [ + "id", "userId", "key", "createdAt" @@ -93019,6 +107512,7 @@ "UserConfig": { "description": "Added since version: 6.3.5.0", "required": [ + "id", "userId", "key", "createdAt" @@ -93066,6 +107560,7 @@ }, { "required": [ + "id", "hash", "userId", "createdAt" @@ -93134,6 +107629,7 @@ "UserRecovery": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "hash", "userId", "createdAt" @@ -93177,6 +107673,7 @@ }, { "required": [ + "id", "name", "eventName", "url", @@ -93197,6 +107694,9 @@ "url": { "type": "string" }, + "onlyLiveVersion": { + "type": "boolean" + }, "errorCount": { "type": "integer", "format": "int64", @@ -93261,6 +107761,7 @@ "Webhook": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "name", "eventName", "url", @@ -93285,6 +107786,9 @@ "type": "string", "description": "URL to be called when the event occurs." }, + "onlyLiveVersion": { + "type": "boolean" + }, "errorCount": { "type": "integer", "format": "int64", @@ -93324,6 +107828,7 @@ }, { "required": [ + "id", "webhookName", "eventName", "deliveryStatus", @@ -93374,6 +107879,9 @@ "url": { "type": "string" }, + "onlyLiveVersion": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -93395,6 +107903,7 @@ "WebhookEventLog": { "description": "Added since version: 6.4.1.0", "required": [ + "id", "webhookName", "eventName", "deliveryStatus", @@ -93458,6 +107967,9 @@ "type": "string", "description": "A URL for the webhook event log." }, + "onlyLiveVersion": { + "type": "boolean" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -93712,40 +108224,6 @@ } } }, - "flowBulderActionsResponse": { - "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" - } - } - }, - "properties": { - "name": { - "description": "Unique name of the flowBulderActionsResponse." - }, - "extensions": { - "description": "Internal field." - } - } - }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -93916,6 +108394,32 @@ } } }, + "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" + } + } + } + }, "Cart": { "properties": { "id": { @@ -95073,6 +109577,16 @@ } } }, + "flowBulderActionsResponse": { + "properties": { + "name": { + "description": "Unique name of the flowBulderActionsResponse." + }, + "extensions": { + "description": "Internal field." + } + } + }, "LineItem": { "properties": { "id": { @@ -95524,6 +110038,195 @@ }, "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": { @@ -95595,6 +110298,10 @@ "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" From e2ab0d5cfb9165943b8ab70c7f950721355aabcd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 27 Sep 2024 08:04:20 +0200 Subject: [PATCH 22/63] [create-pull-request] automated change (#308) Co-authored-by: shopwareBot --- SwagGuidedShopping-adminapi.json | 35875 +++++++++++++---------------- 1 file changed, 15896 insertions(+), 19979 deletions(-) diff --git a/SwagGuidedShopping-adminapi.json b/SwagGuidedShopping-adminapi.json index c0f0c4e..69369a7 100644 --- a/SwagGuidedShopping-adminapi.json +++ b/SwagGuidedShopping-adminapi.json @@ -3,797 +3,18 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.7.3" + "license": { + "name": "MIT", + "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" + }, + "version": "6.6.6.1" }, "servers": [ { "url": "http://localhost:8000/api" } ], - "paths": { - "/_action/guided-shopping/appointment/{appointmentId}/join-as-guide": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" - } - } - } - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/start": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "attendeeIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "The attendee ids are waiting the appointment to start" - } - } - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/guided-shopping/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "The sw-context-token from the attendee", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "attendee-sw-context-token": { - "type": "string" - } - }, - "example": { - "attendee-sw-context-token": "4em6N6cPQSWogR6tfal6mLtDK6HXSV6l" - } - } - } - } - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/instant-listing": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "productIds", - "currentPageGroupId" - ], - "properties": { - "productIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - }, - "patch": { - "tags": [ - "Appointment" - ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], - "properties": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "removeProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be removed to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/presentation/state": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" - } - } - } - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/video-room": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } - } - } - } - } - }, - "delete": { - "tags": [ - "Appointment" - ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": [] - } - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" - } - } - } - } - } - } - }, - "/_action/guided-shopping/appointment/{appointmentId}/widgets/cart-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get cart insights", - "description": "Get cart insights for the given appointment", - "operationId": "getCartInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCartInsightsResponse" - } - } - } - } - } - } - }, - "/search/guided-shopping-appointment": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Search appointments", - "description": "Return list of appointments", - "operationId": "searchAppointments", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetListBodyRequest" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Appointment" - } - }, - "aggregations": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/guided-shopping-appointment": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Create a new appointment", - "description": "", - "operationId": "createAppointment", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Appointment" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - } - }, - "/guided-shopping-appointment/{appointmentId}": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get detail of appointment", - "description": "", - "operationId": "getAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Appointment" - } - } - } - } - } - } - } - }, - "patch": { - "tags": [ - "Appointment" - ], - "summary": "Update partially the existing appointment", - "description": "", - "operationId": "updateAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Appointment" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Appointment" - ], - "summary": "Delete appointment", - "description": "", - "operationId": "deleteAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/search/guided-shopping-presentation": { - "post": { - "tags": [ - "Presentation" - ], - "summary": "Search presentations", - "description": "Return list of presentations", - "operationId": "searchPresentations", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetListBodyRequest" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Presentation" - } - }, - "aggregations": { - "type": "array", - "items": { - "type": "object" - } - } - } - } - } - } - } - } - } - }, - "/guided-shopping-presentation": { - "post": { - "tags": [ - "Presentation" - ], - "summary": "Create a new presentation", - "description": "", - "operationId": "createPresentation", - "parameters": [], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Presentation" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - } - }, - "/guided-shopping-presentation/{presentationId}": { - "get": { - "tags": [ - "Presentation" - ], - "summary": "Get detail of presentation", - "description": "", - "operationId": "getPresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Presentation" - } - } - } - } - } - } - } - }, - "patch": { - "tags": [ - "Presentation" - ], - "summary": "Update partially the existing presentation", - "description": "", - "operationId": "updatePresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Presentation" - } - } - } - }, - "responses": { - "204": { - "description": "" - } - } - }, - "delete": { - "tags": [ - "Presentation" - ], - "summary": "Delete presentation", - "description": "", - "operationId": "deletePresentation", - "parameters": [ - { - "name": "presentationId", - "in": "path", - "description": "Presentation id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - } - }, + "paths": [], "components": { "schemas": { "success": { @@ -1154,6 +375,7 @@ }, { "required": [ + "id", "name", "privileges", "createdAt" @@ -1294,6 +516,7 @@ "AclRole": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "privileges", "createdAt" @@ -1395,6 +618,7 @@ }, { "required": [ + "id", "name", "path", "active", @@ -1474,6 +698,9 @@ "type": "integer", "format": "int64" }, + "checkoutGatewayUrl": { + "type": "string" + }, "label": { "type": "string" }, @@ -1888,6 +1115,7 @@ "App": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "name", "path", "active", @@ -1967,6 +1195,9 @@ "type": "integer", "format": "int64" }, + "checkoutGatewayUrl": { + "type": "string" + }, "label": { "type": "string" }, @@ -2077,6 +1308,7 @@ }, { "required": [ + "id", "entity", "view", "url", @@ -2164,6 +1396,7 @@ "AppActionButton": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "entity", "view", "url", @@ -2223,6 +1456,7 @@ }, { "required": [ + "id", "value", "appId", "localeId", @@ -2262,6 +1496,7 @@ "AppAdministrationSnippet": { "description": "Added since version: 6.4.15.0", "required": [ + "id", "value", "appId", "localeId", @@ -2304,6 +1539,7 @@ }, { "required": [ + "id", "name", "block", "template", @@ -2391,6 +1627,7 @@ "AppCmsBlock": { "description": "Added since version: 6.4.2.0", "required": [ + "id", "name", "block", "template", @@ -2450,6 +1687,7 @@ }, { "required": [ + "id", "appId", "name", "url", @@ -2601,6 +1839,7 @@ "AppFlowAction": { "description": "Added since version: 6.4.10.0", "required": [ + "id", "appId", "name", "url", @@ -2699,6 +1938,7 @@ }, { "required": [ + "id", "appId", "name", "aware", @@ -2808,6 +2048,7 @@ "AppFlowEvent": { "description": "Added since version: 6.5.2.0", "required": [ + "id", "appId", "name", "aware", @@ -2864,6 +2105,7 @@ }, { "required": [ + "id", "appName", "identifier", "paymentMethodId", @@ -3020,6 +2262,7 @@ "AppPaymentMethod": { "description": "Added since version: 6.4.1.0", "required": [ + "id", "appName", "identifier", "paymentMethodId", @@ -3096,6 +2339,7 @@ }, { "required": [ + "id", "identifier", "active", "appId", @@ -3215,6 +2459,7 @@ "AppScriptCondition": { "description": "Added since version: 6.4.10.3", "required": [ + "id", "identifier", "active", "appId", @@ -3281,6 +2526,7 @@ }, { "required": [ + "id", "appName", "identifier", "shippingMethodId", @@ -3419,6 +2665,7 @@ "AppShippingMethod": { "description": "Added since version: 6.5.7.0", "required": [ + "id", "appName", "identifier", "shippingMethodId", @@ -3477,6 +2724,7 @@ }, { "required": [ + "id", "template", "path", "active", @@ -3553,6 +2801,7 @@ "AppTemplate": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "template", "path", "active", @@ -3601,6 +2850,7 @@ }, { "required": [ + "id", "displayNestedProducts", "type", "productAssignmentType", @@ -4158,6 +3408,7 @@ "Category": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "displayNestedProducts", "type", "productAssignmentType", @@ -4416,6 +3667,7 @@ }, { "required": [ + "id", "position", "type", "sectionId", @@ -4608,6 +3860,7 @@ "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "position", "type", "sectionId", @@ -4721,6 +3974,7 @@ }, { "required": [ + "id", "type", "createdAt" ], @@ -4776,40 +4030,6 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { "sections": { @@ -5007,6 +4227,7 @@ "CmsPage": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "createdAt" ], @@ -5062,40 +4283,6 @@ "translated": { "type": "object" }, - "extensions": { - "properties": { - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "sections": { "type": "array", "items": { @@ -5140,11 +4327,11 @@ }, { "required": [ + "id", "position", "type", "pageId", - "createdAt", - "name" + "createdAt" ], "properties": { "id": { @@ -5161,6 +4348,9 @@ "locked": { "type": "boolean" }, + "name": { + "type": "string" + }, "sizingMode": { "type": "string" }, @@ -5219,9 +4409,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { "page": { @@ -5324,11 +4511,11 @@ "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "position", "type", "pageId", - "createdAt", - "name" + "createdAt" ], "properties": { "id": { @@ -5345,6 +4532,9 @@ "locked": { "type": "boolean" }, + "name": { + "type": "string" + }, "sizingMode": { "type": "string" }, @@ -5403,9 +4593,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "page": { "$ref": "#/components/schemas/CmsPage" }, @@ -5429,6 +4616,7 @@ }, { "required": [ + "id", "type", "slot", "blockId", @@ -5528,6 +4716,7 @@ "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "slot", "blockId", @@ -5599,6 +4788,8 @@ }, { "required": [ + "id", + "isEu", "createdAt", "name", "addressFormat" @@ -5703,6 +4894,9 @@ "defaultPostalCodePattern": { "type": "string" }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -5946,6 +5140,8 @@ "Country": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "isEu", "createdAt", "name", "addressFormat" @@ -6050,6 +5246,9 @@ "defaultPostalCodePattern": { "type": "string" }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -6116,6 +5315,7 @@ }, { "required": [ + "id", "countryId", "shortCode", "createdAt", @@ -6263,6 +5463,7 @@ "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "countryId", "shortCode", "createdAt", @@ -6332,6 +5533,7 @@ }, { "required": [ + "id", "factor", "symbol", "isoCode", @@ -6378,6 +5580,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6394,6 +5601,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6652,6 +5864,7 @@ "Currency": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "factor", "symbol", "isoCode", @@ -6698,6 +5911,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6714,6 +5932,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6795,6 +6018,7 @@ }, { "required": [ + "id", "currencyId", "countryId", "itemRounding", @@ -6815,6 +6039,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6831,6 +6060,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6927,6 +6161,7 @@ "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", "required": [ + "id", "currencyId", "countryId", "itemRounding", @@ -6947,6 +6182,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -6963,6 +6203,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -7005,6 +6250,7 @@ }, { "required": [ + "id", "name", "fields", "createdAt" @@ -7067,6 +6313,7 @@ "CustomEntity": { "description": "Added since version: 6.4.9.0", "required": [ + "id", "name", "fields", "createdAt" @@ -7132,6 +6379,7 @@ }, { "required": [ + "id", "name", "type", "createdAt" @@ -7246,6 +6494,7 @@ "CustomField": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "type", "createdAt" @@ -7307,6 +6556,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -7480,6 +6730,7 @@ "CustomFieldSet": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "createdAt" ], @@ -7550,6 +6801,7 @@ }, { "required": [ + "id", "customFieldSetId", "entityName", "createdAt" @@ -7618,6 +6870,7 @@ "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "customFieldSetId", "entityName", "createdAt" @@ -7658,8 +6911,8 @@ }, { "required": [ + "id", "groupId", - "defaultPaymentMethodId", "salesChannelId", "languageId", "defaultBillingAddressId", @@ -7669,6 +6922,7 @@ "lastName", "email", "accountType", + "defaultPaymentMethodId", "createdAt" ], "properties": { @@ -7680,10 +6934,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -7827,6 +7077,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7837,42 +7091,6 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "attendee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment_attendee" - }, - "id": { - "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { "group": { @@ -7904,35 +7122,6 @@ }, "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" - }, "salesChannel": { "properties": { "links": { @@ -8437,6 +7626,35 @@ } }, "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" @@ -8449,8 +7667,8 @@ "Customer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "groupId", - "defaultPaymentMethodId", "salesChannelId", "languageId", "defaultBillingAddressId", @@ -8460,6 +7678,7 @@ "lastName", "email", "accountType", + "defaultPaymentMethodId", "createdAt" ], "properties": { @@ -8471,10 +7690,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -8618,6 +7833,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -8628,48 +7847,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "attendee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment_attendee" - }, - "id": { - "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "group": { "$ref": "#/components/schemas/CustomerGroup" }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, @@ -8738,6 +7918,9 @@ }, "updatedBy": { "$ref": "#/components/schemas/User" + }, + "defaultPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" @@ -8750,6 +7933,7 @@ }, { "required": [ + "id", "customerId", "countryId", "firstName", @@ -8954,6 +8138,7 @@ "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "customerId", "countryId", "firstName", @@ -9052,6 +8237,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -9203,6 +8389,7 @@ "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -9311,6 +8498,7 @@ }, { "required": [ + "id", "hash", "customerId", "createdAt" @@ -9379,6 +8567,7 @@ "CustomerRecovery": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "hash", "customerId", "createdAt" @@ -9447,6 +8636,7 @@ }, { "required": [ + "id", "customerId", "salesChannelId", "createdAt" @@ -9579,6 +8769,7 @@ "CustomerWishlist": { "description": "Added since version: 6.3.4.0", "required": [ + "id", "customerId", "salesChannelId", "createdAt" @@ -9632,6 +8823,7 @@ }, { "required": [ + "id", "productId", "wishlistId", "createdAt" @@ -9734,6 +8926,7 @@ "CustomerWishlistProduct": { "description": "Added since version: 6.3.4.0", "required": [ + "id", "productId", "wishlistId", "createdAt" @@ -9782,6 +8975,7 @@ }, { "required": [ + "id", "name", "min", "max", @@ -9898,6 +9092,7 @@ "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "min", "max", @@ -9962,6 +9157,7 @@ }, { "required": [ + "id", "documentTypeId", "fileType", "orderId", @@ -10185,6 +9381,7 @@ "Document": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentTypeId", "fileType", "orderId", @@ -10277,6 +9474,7 @@ }, { "required": [ + "id", "documentTypeId", "name", "global", @@ -10428,6 +9626,7 @@ "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentTypeId", "name", "global", @@ -10500,6 +9699,7 @@ }, { "required": [ + "id", "documentBaseConfigId", "createdAt" ], @@ -10630,6 +9830,7 @@ "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentBaseConfigId", "createdAt" ], @@ -10680,6 +9881,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -10817,6 +10019,7 @@ "DocumentType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -10877,6 +10080,7 @@ }, { "required": [ + "id", "name", "eventName", "createdAt" @@ -10996,6 +10200,7 @@ "Flow": { "description": "Added since version: 6.4.6.0", "required": [ + "id", "name", "eventName", "createdAt" @@ -11062,6 +10267,7 @@ }, { "required": [ + "id", "flowId", "createdAt" ], @@ -11276,6 +10482,7 @@ "FlowSequence": { "description": "Added since version: 6.4.6.0", "required": [ + "id", "flowId", "createdAt" ], @@ -11359,6 +10566,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -11391,6 +10599,7 @@ "FlowTemplate": { "description": "Added since version: 6.4.18.0", "required": [ + "id", "name", "createdAt" ], @@ -11418,18 +10627,18 @@ }, "type": "object" }, - "GuidedShoppingAppointmentJsonApi": { + "ImportExportFileJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "salesChannelDomainId", - "presentationPath", - "mode", - "name", - "createdById", + "id", + "originalName", + "path", + "expireDate", "createdAt" ], "properties": { @@ -11437,78 +10646,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "salesChannelDomainId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "presentationPath": { - "type": "string" - }, - "accessibleFrom": { - "type": "string", - "format": "date-time" - }, - "accessibleTo": { - "type": "string", - "format": "date-time" - }, - "attendeeRuleIds": { - "type": "object" - }, - "guideUserId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mode": { - "type": "string" - }, - "message": { - "type": "string" - }, - "attendeeRestrictionType": { - "type": "string" - }, - "isPreview": { - "type": "boolean" - }, - "videoAudioSettings": { + "originalName": { "type": "string" }, - "name": { + "path": { "type": "string" }, - "startedAt": { - "type": "string", - "format": "date-time" - }, - "endedAt": { + "expireDate": { "type": "string", "format": "date-time" }, - "default": { - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "size": { + "type": "integer", + "format": "int64" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "accessToken": { + "type": "string" }, "createdAt": { "type": "string", @@ -11522,7 +10675,7 @@ }, "relationships": { "properties": { - "presentation": { + "log": { "properties": { "links": { "type": "object", @@ -11530,7 +10683,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/presentation" + "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" } } }, @@ -11539,19 +10692,144 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation" + "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2486923a98e77fd0740381d01acd1782" + "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" } } } }, "type": "object" - }, - "videoChat": { + } + }, + "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", @@ -11559,7 +10837,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/videoChat" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" } } }, @@ -11568,19 +10846,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment_video_chat" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b23b1765cc6500512065f5a39a713b75" + "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, - "guideUser": { + "profile": { "properties": { "links": { "type": "object", @@ -11588,7 +10866,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/guideUser" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" } } }, @@ -11597,19 +10875,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "import_export_profile" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7d58fd6cf68b2c4c00b51069f10a25eb" + "example": "7d97481b1fe66f4b51db90da7e794d9f" } } } }, "type": "object" }, - "salesChannelDomain": { + "file": { "properties": { "links": { "type": "object", @@ -11617,7 +10895,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/salesChannelDomain" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" } } }, @@ -11626,50 +10904,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "import_export_file" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "29c8b34b04e94e35e95e8346954b7fb4" - } - } - } - }, - "type": "object" - }, - "attendees": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/attendees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment_attendee" - }, - "id": { - "type": "string", - "example": "4d77992a742c290d1e37290f3986fd4e" - } + "example": "8c7dd922ad47494fc02c388e12c00eac" } } } }, "type": "object" }, - "createdBy": { + "invalidRecordsLog": { "properties": { "links": { "type": "object", @@ -11677,7 +10924,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/createdBy" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" } } }, @@ -11686,19 +10933,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "46eeeb74b58b97a6a05494fa0024c998" } } } }, "type": "object" }, - "updatedBy": { + "failedImportLog": { "properties": { "links": { "type": "object", @@ -11706,7 +10953,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment/72e8b20caae21074a840ea2c263fd795/updatedBy" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" } } }, @@ -11715,12 +10962,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "import_export_log" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "1d6996fa1560fc40e5faad086b07ad18" } } } @@ -11735,13 +10982,14 @@ } ] }, - "GuidedShoppingAppointment": { + "ImportExportLog": { + "description": "Added since version: 6.0.0.0", "required": [ - "salesChannelDomainId", - "presentationPath", - "mode", - "name", - "createdById", + "id", + "activity", + "state", + "records", + "config", "createdAt" ], "properties": { @@ -11749,78 +10997,43 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "activity": { + "type": "string" }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "state": { + "type": "string" }, - "active": { - "type": "boolean" + "records": { + "type": "integer", + "format": "int64" }, - "salesChannelDomainId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationPath": { - "type": "string" - }, - "accessibleFrom": { + "profileId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "accessibleTo": { + "fileId": { "type": "string", - "format": "date-time" - }, - "attendeeRuleIds": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "guideUserId": { + "invalidRecordsLogId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mode": { - "type": "string" - }, - "message": { - "type": "string" - }, - "attendeeRestrictionType": { - "type": "string" - }, - "isPreview": { - "type": "boolean" - }, - "videoAudioSettings": { + "username": { "type": "string" }, - "name": { + "profileName": { "type": "string" }, - "startedAt": { - "type": "string", - "format": "date-time" - }, - "endedAt": { - "type": "string", - "format": "date-time" - }, - "default": { - "type": "boolean" - }, - "customFields": { + "config": { "type": "object" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "result": { + "type": "object" }, "createdAt": { "type": "string", @@ -11832,42 +11045,38 @@ "format": "date-time", "readOnly": true }, - "presentation": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "videoChat": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentVideoChat" - }, - "guideUser": { + "user": { "$ref": "#/components/schemas/User" }, - "salesChannelDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" + "profile": { + "$ref": "#/components/schemas/ImportExportProfile" }, - "attendees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - } + "file": { + "$ref": "#/components/schemas/ImportExportFile" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "invalidRecordsLog": { + "$ref": "#/components/schemas/ImportExportLog" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "failedImportLog": { + "$ref": "#/components/schemas/ImportExportLog" } }, "type": "object" }, - "GuidedShoppingAppointmentAttendeeJsonApi": { + "ImportExportProfileJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "appointmentId", - "type", + "id", + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure", "createdAt" ], "properties": { @@ -11875,47 +11084,41 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guideCartPermissionsGranted": { - "type": "boolean" - }, - "attendeeSubmittedAt": { - "type": "string", - "format": "date-time" + "label": { + "type": "string" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "systemDefault": { + "type": "boolean" }, - "videoUserId": { + "sourceEntity": { "type": "string" }, - "attendeeName": { + "fileType": { "type": "string" }, - "attendeeEmail": { + "delimiter": { "type": "string" }, - "type": { + "enclosure": { "type": "string" }, - "invitationStatus": { - "type": "string" + "mapping": { + "type": "object" }, - "joinedAt": { - "type": "string", - "format": "date-time" + "updateBy": { + "type": "object" }, - "lastActive": { - "type": "string", - "format": "date-time" + "config": { + "type": "object" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" }, "createdAt": { "type": "string", @@ -11927,127 +11130,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "appointment": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/appointment" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b1caa385c37f1fec467494c8fde4f49b" - } - } - } - }, - "type": "object" - }, - "customer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/customer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } - } - } - }, - "type": "object" - }, - "user": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/user" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" - } - } - } - }, - "type": "object" - }, - "interactions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/interactions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_interaction" - }, - "id": { - "type": "string", - "example": "85aa9c704a544e104741012bf72b6572" - } - } - } - } - }, - "type": "object" - }, - "productCollections": { + "importExportLogs": { "properties": { "links": { "type": "object", @@ -12055,7 +11143,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-attendee/1c6e84dd56d3d017733b559a107cf2aa/productCollections" + "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" } } }, @@ -12066,11 +11154,11 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_attendee_product_collection" + "example": "import_export_log" }, "id": { "type": "string", - "example": "3fa1ecbee1fa3d24671a2e81d9b71d17" + "example": "e4ca733e3c1da4bff4cd4b6078f2237a" } } } @@ -12086,10 +11174,15 @@ } ] }, - "GuidedShoppingAppointmentAttendee": { + "ImportExportProfile": { + "description": "Added since version: 6.0.0.0", "required": [ - "appointmentId", - "type", + "id", + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure", "createdAt" ], "properties": { @@ -12097,47 +11190,41 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guideCartPermissionsGranted": { - "type": "boolean" - }, - "attendeeSubmittedAt": { - "type": "string", - "format": "date-time" + "label": { + "type": "string" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "systemDefault": { + "type": "boolean" }, - "videoUserId": { + "sourceEntity": { "type": "string" }, - "attendeeName": { + "fileType": { "type": "string" }, - "attendeeEmail": { + "delimiter": { "type": "string" }, - "type": { + "enclosure": { "type": "string" }, - "invitationStatus": { - "type": "string" + "mapping": { + "type": "object" }, - "joinedAt": { - "type": "string", - "format": "date-time" + "updateBy": { + "type": "object" }, - "lastActive": { - "type": "string", - "format": "date-time" + "config": { + "type": "object" + }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" }, "createdAt": { "type": "string", @@ -12149,38 +11236,30 @@ "format": "date-time", "readOnly": true }, - "appointment": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "user": { - "$ref": "#/components/schemas/User" - }, - "interactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GuidedShoppingInteraction" - } + "translated": { + "type": "object" }, - "productCollections": { + "importExportLogs": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAttendeeProductCollection" + "$ref": "#/components/schemas/ImportExportLog" } } }, "type": "object" }, - "GuidedShoppingAppointmentVideoChatJsonApi": { + "IntegrationJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "appointmentId", + "id", + "label", + "accessKey", + "secretAccessKey", "createdAt" ], "properties": { @@ -12188,28 +11267,29 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { + "label": { "type": "string" }, - "ownerToken": { + "accessKey": { "type": "string" }, - "userToken": { + "secretAccessKey": { "type": "string" }, - "url": { - "type": "string" + "lastUsageAt": { + "type": "string", + "format": "date-time" }, - "startAsBroadcast": { + "admin": { "type": "boolean" }, "customFields": { "type": "object" }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, "createdAt": { "type": "string", "format": "date-time", @@ -12220,9 +11300,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "appointment": { + "createdNotifications": { "properties": { "links": { "type": "object", @@ -12230,21 +11310,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-appointment-video-chat/ff6e704f90e15236139b7cdd89b9b667/appointment" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b1caa385c37f1fec467494c8fde4f49b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } } } } @@ -12253,105 +11335,10 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "GuidedShoppingAppointmentVideoChat": { - "required": [ - "appointmentId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "ownerToken": { - "type": "string" - }, - "userToken": { - "type": "string" - }, - "url": { - "type": "string" - }, - "startAsBroadcast": { - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "appointment": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" - } - }, - "type": "object" - }, - "GuidedShoppingAttendeeProductCollectionJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "attendeeId", - "productId", - "alias", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "alias": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, "relationships": { "properties": { - "attendee": { + "app": { "properties": { "links": { "type": "object", @@ -12359,7 +11346,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-attendee-product-collection/b6b9e6db620045c70dbf40f9f18d75db/attendee" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" } } }, @@ -12368,19 +11355,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment_attendee" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "product": { + "aclRoles": { "properties": { "links": { "type": "object", @@ -12388,21 +11375,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-attendee-product-collection/b6b9e6db620045c70dbf40f9f18d75db/product" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "example": "e050a8081a3eb1d193c23cf0ef761183" + } } } } @@ -12417,11 +11406,13 @@ } ] }, - "GuidedShoppingAttendeeProductCollection": { + "Integration": { + "description": "Added since version: 6.0.0.0", "required": [ - "attendeeId", - "productId", - "alias", + "id", + "label", + "accessKey", + "secretAccessKey", "createdAt" ], "properties": { @@ -12429,20 +11420,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "type": "string" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "accessKey": { + "type": "string" }, - "productVersionId": { + "secretAccessKey": { + "type": "string" + }, + "lastUsageAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "alias": { - "type": "string" + "admin": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "deletedAt": { + "type": "string", + "format": "date-time" }, "createdAt": { "type": "string", @@ -12454,155 +11453,94 @@ "format": "date-time", "readOnly": true }, - "attendee": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" - }, - "product": { - "$ref": "#/components/schemas/Product" - } - }, - "type": "object" - }, - "GuidedShoppingInteractionJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "name", - "triggeredAt", - "attendeeId", - "createdAt" - ], + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "triggeredAt": { - "type": "string", - "format": "date-time" - }, - "payload": { - "type": "object" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { + "createdNotifications": { "properties": { - "attendee": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-interaction/af36f528ed70da8c2478965b40809b79/attendee" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment_attendee" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } + "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" } }, "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "aclRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } } - ] + }, + "type": "object" }, - "GuidedShoppingInteraction": { + "IntegrationRole": { + "description": "Added since version: 6.3.3.0", "required": [ - "name", - "triggeredAt", - "attendeeId", - "createdAt" + "integrationId", + "aclRoleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "triggeredAt": { - "type": "string", - "format": "date-time" - }, - "payload": { - "type": "object" - }, - "attendeeId": { + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "aclRoleId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "integration": { + "$ref": "#/components/schemas/Integration" }, - "attendee": { - "$ref": "#/components/schemas/GuidedShoppingAppointmentAttendee" + "role": { + "$ref": "#/components/schemas/AclRole" } }, "type": "object" }, - "GuidedShoppingPresentationJsonApi": { + "LandingPageJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "createdById", + "id", "createdAt", - "name" + "name", + "url" ], "properties": { "id": { @@ -12616,25 +11554,32 @@ "active": { "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { "type": "string" }, "customFields": { "type": "object" }, - "createdById": { + "slotConfig": { + "type": "object" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "url": { + "type": "string" + }, + "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -12653,7 +11598,38 @@ }, "relationships": { "properties": { - "parent": { + "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", @@ -12661,7 +11637,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/parent" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" } } }, @@ -12670,19 +11646,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, - "appointments": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -12690,7 +11666,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/appointments" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" } } }, @@ -12701,11 +11677,11 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_appointment" + "example": "sales_channel" }, "id": { "type": "string", - "example": "2417b53255206bdce189add39d85fca1" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -12713,7 +11689,7 @@ }, "type": "object" }, - "cmsPages": { + "seoUrls": { "properties": { "links": { "type": "object", @@ -12721,7 +11697,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/cmsPages" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" } } }, @@ -12732,75 +11708,17 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation_cms_page" + "example": "seo_url" }, "id": { "type": "string", - "example": "e676148cc6ffb82b89b3903ecaed2d16" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } } }, "type": "object" - }, - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - }, - "updatedBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/guided-shopping-presentation/456c93075050cca0e3e24aeecf897330/updatedBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" - } - } - } - }, - "type": "object" } }, "type": "object" @@ -12810,11 +11728,13 @@ } ] }, - "GuidedShoppingPresentation": { + "LandingPage": { + "description": "Added since version: 6.4.0.0", "required": [ - "createdById", + "id", "createdAt", - "name" + "name", + "url" ], "properties": { "id": { @@ -12828,25 +11748,32 @@ "active": { "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { "type": "string" }, "customFields": { "type": "object" }, - "createdById": { + "slotConfig": { + "type": "object" + }, + "metaTitle": { + "type": "string" + }, + "metaDescription": { + "type": "string" + }, + "keywords": { + "type": "string" + }, + "url": { + "type": "string" + }, + "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "cmsPageVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -12863,31 +11790,95 @@ "translated": { "type": "object" }, - "parent": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "appointments": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingAppointment" + "$ref": "#/components/schemas/SalesChannel" } }, - "cmsPages": { + "seoUrls": { "type": "array", "items": { - "$ref": "#/components/schemas/GuidedShoppingPresentationCmsPage" + "$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}$" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "landingPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "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" }, - "GuidedShoppingPresentationCmsPageJsonApi": { + "LanguageJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -12895,8 +11886,9 @@ }, { "required": [ - "presentationId", - "cmsPageId", + "id", + "localeId", + "name", "createdAt" ], "properties": { @@ -12904,53 +11896,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageId": { + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "translationCodeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "title": { + "name": { "type": "string" }, "customFields": { "type": "object" }, - "slotConfig": { - "type": "object" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pickedProductIds": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "isInstantListing": { - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -12961,12 +11924,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "presentation": { + "parent": { "properties": { "links": { "type": "object", @@ -12974,7 +11934,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/presentation" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, @@ -12983,19 +11943,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2486923a98e77fd0740381d01acd1782" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "cmsPage": { + "locale": { "properties": { "links": { "type": "object", @@ -13003,7 +11963,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/cmsPage" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, @@ -13012,19 +11972,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, - "product": { + "translationCode": { "properties": { "links": { "type": "object", @@ -13032,7 +11992,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/product" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" } } }, @@ -13041,19 +12001,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "6ef2035242b8fcb7b61c3a41850e60b3" } } } }, "type": "object" }, - "productStream": { + "children": { "properties": { "links": { "type": "object", @@ -13061,170 +12021,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/guided-shopping-presentation-cms-page/57363e7d22ac102ed71cd68204fd16cc/productStream" + "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": { - "type": { + "related": { "type": "string", - "example": "product_stream" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "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" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "GuidedShoppingPresentationCmsPage": { - "description": "Added since version: 6.0.0.0", - "required": [ - "presentationId", - "cmsPageId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "title": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pickedProductIds": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "isInstantListing": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "presentation": { - "$ref": "#/components/schemas/GuidedShoppingPresentation" - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" - } - }, - "type": "object" - }, - "ImportExportFileJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "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": { + }, + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -13232,151 +12114,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "ImportExportFile": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "customers": { "properties": { "links": { "type": "object", @@ -13384,28 +12145,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "example": "4b6f7d34a58ba399f077685951d06738" + } } } } }, "type": "object" }, - "profile": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -13413,28 +12176,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "import_export_profile" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7d97481b1fe66f4b51db90da7e794d9f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "newsletter_recipient" + }, + "id": { + "type": "string", + "example": "2217f01dc5cddfd5b60387c39867f58e" + } } } } }, "type": "object" }, - "file": { + "orders": { "properties": { "links": { "type": "object", @@ -13442,28 +12207,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" + "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": { - "type": { - "type": "string", - "example": "import_export_file" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8c7dd922ad47494fc02c388e12c00eac" + "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" }, - "invalidRecordsLog": { + "productKeywordDictionaries": { "properties": { "links": { "type": "object", @@ -13471,28 +12269,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" + "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": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "46eeeb74b58b97a6a05494fa0024c998" + "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" }, - "failedImportLog": { + "productSearchConfig": { "properties": { "links": { "type": "object", @@ -13500,7 +12331,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" } } }, @@ -13509,12 +12340,12 @@ "properties": { "type": { "type": "string", - "example": "import_export_log" + "example": "product_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1d6996fa1560fc40e5faad086b07ad18" + "example": "8d4fbbaa71409309d308e57678de7d7a" } } } @@ -13529,13 +12360,12 @@ } ] }, - "ImportExportLog": { + "Language": { "description": "Added since version: 6.0.0.0", "required": [ - "activity", - "state", - "records", - "config", + "id", + "localeId", + "name", "createdAt" ], "properties": { @@ -13543,42 +12373,22 @@ "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": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileId": { + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "invalidRecordsLogId": { + "translationCodeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "username": { - "type": "string" - }, - "profileName": { + "name": { "type": "string" }, - "config": { - "type": "object" - }, - "result": { + "customFields": { "type": "object" }, "createdAt": { @@ -13591,75 +12401,110 @@ "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "parent": { + "$ref": "#/components/schemas/Language" }, - "profile": { - "$ref": "#/components/schemas/ImportExportProfile" + "locale": { + "$ref": "#/components/schemas/Locale" }, - "file": { - "$ref": "#/components/schemas/ImportExportFile" + "translationCode": { + "$ref": "#/components/schemas/Locale" }, - "invalidRecordsLog": { - "$ref": "#/components/schemas/ImportExportLog" + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } }, - "failedImportLog": { - "$ref": "#/components/schemas/ImportExportLog" - } - }, - "type": "object" - }, - "ImportExportProfileJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - { - "required": [ - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure", - "createdAt" + "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}$" }, - "name": { - "type": "string" - }, - "label": { - "type": "string" - }, - "type": { - "type": "string" - }, - "systemDefault": { - "type": "boolean" - }, - "sourceEntity": { - "type": "string" - }, - "fileType": { + "code": { "type": "string" }, - "delimiter": { + "name": { "type": "string" }, - "enclosure": { + "territory": { "type": "string" }, - "mapping": { - "type": "object" - }, - "updateBy": { - "type": "object" - }, - "config": { + "customFields": { "type": "object" }, "createdAt": { @@ -13677,7 +12522,7 @@ }, "relationships": { "properties": { - "importExportLogs": { + "languages": { "properties": { "links": { "type": "object", @@ -13685,7 +12530,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" } } }, @@ -13696,11 +12541,42 @@ "properties": { "type": { "type": "string", - "example": "import_export_log" + "example": "language" }, "id": { "type": "string", - "example": "e4ca733e3c1da4bff4cd4b6078f2237a" + "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" } } } @@ -13716,52 +12592,30 @@ } ] }, - "ImportExportProfile": { + "Locale": { "description": "Added since version: 6.0.0.0", "required": [ - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure", - "createdAt" + "id", + "code", + "createdAt", + "name", + "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "label": { - "type": "string" - }, - "type": { - "type": "string" - }, - "systemDefault": { - "type": "boolean" - }, - "sourceEntity": { - "type": "string" - }, - "fileType": { + "code": { "type": "string" }, - "delimiter": { + "name": { "type": "string" }, - "enclosure": { + "territory": { "type": "string" }, - "mapping": { - "type": "object" - }, - "updateBy": { - "type": "object" - }, - "config": { + "customFields": { "type": "object" }, "createdAt": { @@ -13777,16 +12631,22 @@ "translated": { "type": "object" }, - "importExportLogs": { + "languages": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/Language" + } + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" } } }, "type": "object" }, - "IntegrationJsonApi": { + "LogEntryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -13794,9 +12654,7 @@ }, { "required": [ - "label", - "accessKey", - "secretAccessKey", + "id", "createdAt" ], "properties": { @@ -13804,32 +12662,114 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "label": { + "message": { "type": "string" }, - "accessKey": { - "type": "string" + "level": { + "type": "integer", + "format": "int64" }, - "secretAccessKey": { + "channel": { "type": "string" }, - "lastUsageAt": { + "context": { + "type": "object" + }, + "extra": { + "type": "object" + }, + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - "admin": { + "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" }, - "customFields": { - "type": "object" + "name": { + "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" + "description": { + "type": "string" }, - "writeAccess": { - "type": "boolean", - "deprecated": true + "headerHtml": { + "type": "string" + }, + "headerPlain": { + "type": "string" + }, + "footerHtml": { + "type": "string" + }, + "footerPlain": { + "type": "string" }, "createdAt": { "type": "string", @@ -13841,9 +12781,12 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "translated": { + "type": "object" + }, + "relationships": { "properties": { - "createdNotifications": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -13851,7 +12794,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" + "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" } } }, @@ -13862,11 +12805,11 @@ "properties": { "type": { "type": "string", - "example": "notification" + "example": "sales_channel" }, "id": { "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -13876,10 +12819,128 @@ } }, "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": { - "app": { + "mailTemplateType": { "properties": { "links": { "type": "object", @@ -13887,7 +12948,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" } } }, @@ -13896,19 +12957,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "mail_template_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "f4e3707ad46065609def210a855620cd" } } } }, "type": "object" }, - "aclRoles": { + "media": { "properties": { "links": { "type": "object", @@ -13916,7 +12977,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" } } }, @@ -13927,11 +12988,11 @@ "properties": { "type": { "type": "string", - "example": "acl_role" + "example": "mail_template_media" }, "id": { "type": "string", - "example": "e050a8081a3eb1d193c23cf0ef761183" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -13947,46 +13008,46 @@ } ] }, - "Integration": { + "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "label", - "accessKey", - "secretAccessKey", - "createdAt" + "id", + "mailTemplateTypeId", + "createdAt", + "subject", + "contentHtml", + "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "label": { + "mailTemplateTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "systemDefault": { + "type": "boolean" + }, + "senderName": { "type": "string" }, - "accessKey": { + "description": { "type": "string" }, - "secretAccessKey": { + "subject": { "type": "string" }, - "lastUsageAt": { - "type": "string", - "format": "date-time" + "contentHtml": { + "type": "string" }, - "admin": { - "type": "boolean" + "contentPlain": { + "type": "string" }, "customFields": { "type": "object" }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "writeAccess": { - "type": "boolean", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -13997,134 +13058,91 @@ "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" - } - }, + "translated": { "type": "object" }, - "app": { - "$ref": "#/components/schemas/App" + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" }, - "aclRoles": { + "media": { "type": "array", "items": { - "$ref": "#/components/schemas/AclRole" + "$ref": "#/components/schemas/MailTemplateMedia" } } }, "type": "object" }, - "IntegrationRole": { - "description": "Added since version: 6.3.3.0", + "MailTemplateMedia": { + "description": "Added since version: 6.0.0.0", "required": [ - "integrationId", - "aclRoleId" + "id", + "mailTemplateId", + "languageId", + "mediaId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "integrationId": { + "mailTemplateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "integration": { - "$ref": "#/components/schemas/Integration" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "role": { - "$ref": "#/components/schemas/AclRole" + "position": { + "type": "integer", + "format": "int64" + }, + "mailTemplate": { + "$ref": "#/components/schemas/MailTemplate" + }, + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "LandingPageJsonApi": { - "description": "Added since version: 6.4.0.0", + "MailTemplateTypeJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", + "technicalName", "createdAt", - "name", - "url" + "name" ], "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": { + "technicalName": { "type": "string" }, - "url": { - "type": "string" + "availableEntities": { + "type": "object" }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "templateData": { + "type": "object" }, "createdAt": { "type": "string", @@ -14141,7 +13159,7 @@ }, "relationships": { "properties": { - "tags": { + "mailTemplates": { "properties": { "links": { "type": "object", @@ -14149,7 +13167,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" + "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" } } }, @@ -14160,19 +13178,128 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "mail_template" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "e6f502f7d88de75db45325d22998cf6d" } } } } }, "type": "object" - }, - "cmsPage": { + } + }, + "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", @@ -14180,7 +13307,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" } } }, @@ -14189,19 +13316,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "salesChannels": { + "category": { "properties": { "links": { "type": "object", @@ -14209,30 +13336,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c4ef352f74e502ef5e7bc98e6f4e493d" } } } }, "type": "object" }, - "seoUrls": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -14240,23 +13365,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" + "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url" - }, - "id": { - "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -14271,51 +13394,37 @@ } ] }, - "LandingPage": { - "description": "Added since version: 6.4.0.0", + "MainCategory": { + "description": "Added since version: 6.1.0.0", "required": [ - "createdAt", - "name", - "url" + "id", + "productId", + "categoryId", + "salesChannelId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "productId": { "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" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "url": { - "type": "string" + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsPageId": { + "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14329,58 +13438,11 @@ "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}$" + "product": { + "$ref": "#/components/schemas/Product" }, - "landingPage": { - "$ref": "#/components/schemas/LandingPage" + "category": { + "$ref": "#/components/schemas/Category" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" @@ -14388,39 +13450,7 @@ }, "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": { + "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -14428,8 +13458,7 @@ }, { "required": [ - "localeId", - "name", + "id", "createdAt" ], "properties": { @@ -14437,21 +13466,67 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { + "mimeType": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "name": { + "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" }, @@ -14465,9 +13540,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "presentationTranslation": { + "themes": { "properties": { "links": { "type": "object", @@ -14475,7 +13553,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" } } }, @@ -14486,24 +13564,19 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation_translation" + "example": "theme" }, "id": { "type": "string", - "example": "e22d79f2b1909484a375a5dc228ef751" + "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { + }, + "themeMedia": { "properties": { "links": { "type": "object", @@ -14511,28 +13584,35 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" + "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "260be9ecb281c4ff04e7189bb18a35bd" + } } } } }, "type": "object" - }, - "locale": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "tags": { "properties": { "links": { "type": "object", @@ -14540,28 +13620,90 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" + "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "locale" + "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": "fb216d9e8791e63c8d12bdc420956839" + "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, - "translationCode": { + "categories": { "properties": { "links": { "type": "object", @@ -14569,7 +13711,193 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + "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" } } }, @@ -14578,19 +13906,19 @@ "properties": { "type": { "type": "string", - "example": "locale" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "6ef2035242b8fcb7b61c3a41850e60b3" + "example": "70605921a592ee735964394f7948773b" } } } }, "type": "object" }, - "children": { + "propertyGroupOptions": { "properties": { "links": { "type": "object", @@ -14598,7 +13926,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" + "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" } } }, @@ -14609,11 +13937,11 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "property_group_option" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "789104e3568fde835b6239b251d4aa07" } } } @@ -14621,7 +13949,7 @@ }, "type": "object" }, - "salesChannels": { + "mailTemplateMedia": { "properties": { "links": { "type": "object", @@ -14629,7 +13957,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" } } }, @@ -14640,11 +13968,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "mail_template_media" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "9970132c8439a2e630b655812b031459" } } } @@ -14652,7 +13980,7 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "documentBaseConfigs": { "properties": { "links": { "type": "object", @@ -14660,7 +13988,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" + "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" } } }, @@ -14671,11 +13999,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "document_base_config" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } @@ -14683,7 +14011,7 @@ }, "type": "object" }, - "salesChannelDomains": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -14691,7 +14019,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" + "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" } } }, @@ -14702,11 +14030,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "shipping_method" }, "id": { "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -14714,7 +14042,7 @@ }, "type": "object" }, - "customers": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -14722,7 +14050,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" + "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" } } }, @@ -14733,11 +14061,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "payment_method" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "b631b1ab565525e892f9cdc1242cca14" } } } @@ -14745,7 +14073,7 @@ }, "type": "object" }, - "newsletterRecipients": { + "productConfiguratorSettings": { "properties": { "links": { "type": "object", @@ -14753,7 +14081,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" } } }, @@ -14764,11 +14092,11 @@ "properties": { "type": { "type": "string", - "example": "newsletter_recipient" + "example": "product_configurator_setting" }, "id": { "type": "string", - "example": "2217f01dc5cddfd5b60387c39867f58e" + "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" } } } @@ -14776,7 +14104,7 @@ }, "type": "object" }, - "orders": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -14784,7 +14112,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" } } }, @@ -14795,11 +14123,11 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "order_line_item" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } @@ -14807,7 +14135,7 @@ }, "type": "object" }, - "productSearchKeywords": { + "cmsBlocks": { "properties": { "links": { "type": "object", @@ -14815,7 +14143,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" } } }, @@ -14826,11 +14154,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_keyword" + "example": "cms_block" }, "id": { "type": "string", - "example": "ea9cb6522f347c9212c9459d63c645f4" + "example": "3636c4901eab836dfb837e1a9a37d3c0" } } } @@ -14838,7 +14166,7 @@ }, "type": "object" }, - "productKeywordDictionaries": { + "cmsSections": { "properties": { "links": { "type": "object", @@ -14846,7 +14174,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" } } }, @@ -14857,11 +14185,11 @@ "properties": { "type": { "type": "string", - "example": "product_keyword_dictionary" + "example": "cms_section" }, "id": { "type": "string", - "example": "660e189a383ca4eb148e25eb0df85988" + "example": "53be3cc1c4a8f41af67a90cf9fd09194" } } } @@ -14869,7 +14197,7 @@ }, "type": "object" }, - "productReviews": { + "cmsPages": { "properties": { "links": { "type": "object", @@ -14877,7 +14205,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" } } }, @@ -14888,11 +14216,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "cms_page" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "e676148cc6ffb82b89b3903ecaed2d16" } } } @@ -14900,7 +14228,7 @@ }, "type": "object" }, - "productSearchConfig": { + "documents": { "properties": { "links": { "type": "object", @@ -14908,21 +14236,85 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" + "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": { - "type": { + "related": { "type": "string", - "example": "product_search_config" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "8d4fbbaa71409309d308e57678de7d7a" + "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" + } } } } @@ -14937,11 +14329,10 @@ } ] }, - "Language": { + "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "localeId", - "name", + "id", "createdAt" ], "properties": { @@ -14949,21 +14340,67 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "mediaFolderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { + "mimeType": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "name": { + "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" }, @@ -14977,9 +14414,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "presentationTranslation": { + "themes": { "properties": { "links": { "type": "object", @@ -14987,7 +14427,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" } } }, @@ -14998,97 +14438,188 @@ "properties": { "type": { "type": "string", - "example": "guided_shopping_presentation_translation" + "example": "theme" }, "id": { "type": "string", - "example": "e22d79f2b1909484a375a5dc228ef751" + "example": "fe021943dcda87150f590b3475afaded" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "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", + }, + "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/SalesChannel" + "$ref": "#/components/schemas/Tag" } }, - "salesChannelDefaultAssignments": { + "thumbnails": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/MediaThumbnail" } }, - "salesChannelDomains": { + "user": { + "$ref": "#/components/schemas/User" + }, + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/Category" } }, - "customers": { + "productManufacturers": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/ProductManufacturer" } }, - "newsletterRecipients": { + "productMedia": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/ProductMedia" } }, - "orders": { + "productDownloads": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/ProductDownload" } }, - "productSearchKeywords": { + "orderLineItemDownloads": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/OrderLineItemDownload" } }, - "productKeywordDictionaries": { + "avatarUsers": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/User" } }, - "productReviews": { + "mediaFolder": { + "$ref": "#/components/schemas/MediaFolder" + }, + "propertyGroupOptions": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/PropertyGroupOption" } }, - "productSearchConfig": { - "$ref": "#/components/schemas/ProductSearchConfig" + "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" }, - "LocaleJsonApi": { + "MediaDefaultFolderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -15096,23 +14627,16 @@ }, { "required": [ - "code", - "createdAt", - "name", - "territory" + "id", + "entity", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "type": "string" - }, - "name": { - "type": "string" - }, - "territory": { + "entity": { "type": "string" }, "customFields": { @@ -15128,12 +14652,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "languages": { + "folder": { "properties": { "links": { "type": "object", @@ -15141,54 +14662,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/locale/911f0f24bdce6808f4614d6a263b143b/languages" + "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" } } }, "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": { "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" - } + "example": "media_folder" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "851148b4fd8fd7ae74bd9100c5c0c898" } } } @@ -15203,26 +14691,19 @@ } ] }, - "Locale": { + "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", "required": [ - "code", - "createdAt", - "name", - "territory" + "id", + "entity", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "type": "string" - }, - "name": { - "type": "string" - }, - "territory": { + "entity": { "type": "string" }, "customFields": { @@ -15238,25 +14719,13 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "languages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - }, - "users": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "folder": { + "$ref": "#/components/schemas/MediaFolder" } }, "type": "object" }, - "LogEntryJsonApi": { + "MediaFolderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -15264,6 +14733,9 @@ }, { "required": [ + "id", + "configurationId", + "name", "createdAt" ], "properties": { @@ -15271,112 +14743,35 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "message": { - "type": "string" - }, - "level": { - "type": "integer", - "format": "int64" - }, - "channel": { - "type": "string" + "useParentConfiguration": { + "type": "boolean" }, - "context": { - "type": "object" + "configurationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "extra": { - "type": "object" + "defaultFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "parentId": { "type": "string", - "format": "date-time", + "pattern": "^[0-9a-f]{32}$" + }, + "childCount": { + "type": "integer", + "format": "int64", "readOnly": true }, - "updatedAt": { + "path": { "type": "string", - "format": "date-time", "readOnly": true - } - }, - "type": "object" - } - ] - }, - "LogEntry": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -15388,12 +14783,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannels": { + "parent": { "properties": { "links": { "type": "object", @@ -15401,7 +14793,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" + "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" } } }, @@ -15412,17 +14833,106 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "media_folder" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "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" @@ -15432,38 +14942,49 @@ } ] }, - "MailHeaderFooter": { + "MediaFolder": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", - "name" + "id", + "configurationId", + "name", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { + "useParentConfiguration": { "type": "boolean" }, - "name": { - "type": "string" + "configurationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "defaultFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "headerHtml": { - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "headerPlain": { - "type": "string" + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "footerHtml": { - "type": "string" + "path": { + "type": "string", + "readOnly": true }, - "footerPlain": { + "name": { "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -15474,19 +14995,31 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "parent": { + "$ref": "#/components/schemas/MediaFolder" }, - "salesChannels": { + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/MediaFolder" } + }, + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + }, + "defaultFolder": { + "$ref": "#/components/schemas/MediaDefaultFolder" + }, + "configuration": { + "$ref": "#/components/schemas/MediaFolderConfiguration" } }, "type": "object" }, - "MailTemplateJsonApi": { + "MediaFolderConfigurationJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -15494,38 +15027,29 @@ }, { "required": [ - "mailTemplateTypeId", - "createdAt", - "subject", - "contentHtml", - "contentPlain" + "id", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "systemDefault": { + "createThumbnails": { "type": "boolean" }, - "senderName": { - "type": "string" - }, - "description": { - "type": "string" + "keepAspectRatio": { + "type": "boolean" }, - "subject": { - "type": "string" + "thumbnailQuality": { + "type": "integer", + "format": "int64" }, - "contentHtml": { - "type": "string" + "private": { + "type": "boolean" }, - "contentPlain": { - "type": "string" + "noAssociation": { + "type": "boolean" }, "customFields": { "type": "object" @@ -15540,12 +15064,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "mailTemplateType": { + "mediaFolders": { "properties": { "links": { "type": "object", @@ -15553,28 +15074,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "mail_template_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f4e3707ad46065609def210a855620cd" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "example": "6e8238687513bde2e85821c839c597c6" + } } } } }, "type": "object" }, - "media": { + "mediaThumbnailSizes": { "properties": { "links": { "type": "object", @@ -15582,7 +15105,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" } } }, @@ -15593,11 +15116,11 @@ "properties": { "type": { "type": "string", - "example": "mail_template_media" + "example": "media_thumbnail_size" }, "id": { "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "44dee48a0006e8db2fcec2a5e1456449" } } } @@ -15613,41 +15136,32 @@ } ] }, - "MailTemplate": { + "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ - "mailTemplateTypeId", - "createdAt", - "subject", - "contentHtml", - "contentPlain" + "id", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "systemDefault": { + "createThumbnails": { "type": "boolean" }, - "senderName": { - "type": "string" - }, - "description": { - "type": "string" + "keepAspectRatio": { + "type": "boolean" }, - "subject": { - "type": "string" + "thumbnailQuality": { + "type": "integer", + "format": "int64" }, - "contentHtml": { - "type": "string" + "private": { + "type": "boolean" }, - "contentPlain": { - "type": "string" + "noAssociation": { + "type": "boolean" }, "customFields": { "type": "object" @@ -15662,59 +15176,78 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "mailTemplateType": { - "$ref": "#/components/schemas/MailTemplateType" + "mediaFolders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } }, - "media": { + "mediaThumbnailSizes": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplateMedia" + "$ref": "#/components/schemas/MediaThumbnailSize" } } }, "type": "object" }, - "MailTemplateMedia": { + "MediaFolderConfigurationMediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ - "mailTemplateId", - "languageId", - "mediaId" + "mediaFolderConfigurationId", + "mediaThumbnailSizeId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateId": { + "mediaFolderConfigurationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "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}$" }, - "position": { - "type": "integer", - "format": "int64" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "mailTemplate": { - "$ref": "#/components/schemas/MailTemplate" + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "media": { "$ref": "#/components/schemas/Media" + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "MailTemplateTypeJsonApi": { + "MediaThumbnailJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -15722,28 +15255,171 @@ }, { "required": [ - "technicalName", - "createdAt", - "name" + "id", + "mediaId", + "width", + "height", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "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" }, - "technicalName": { + "path": { "type": "string" }, - "availableEntities": { + "customFields": { "type": "object" }, - "customFields": { + "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}$" }, - "templateData": { + "width": { + "type": "integer", + "format": "int64" + }, + "height": { + "type": "integer", + "format": "int64" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -15756,12 +15432,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "mailTemplates": { + "mediaFolderConfigurations": { "properties": { "links": { "type": "object", @@ -15769,7 +15442,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" } } }, @@ -15780,11 +15453,11 @@ "properties": { "type": { "type": "string", - "example": "mail_template" + "example": "media_folder_configuration" }, "id": { "type": "string", - "example": "e6f502f7d88de75db45325d22998cf6d" + "example": "056df7a700173d83ebb685b1a890f09b" } } } @@ -15800,33 +15473,30 @@ } ] }, - "MailTemplateType": { + "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ - "technicalName", - "createdAt", - "name" + "id", + "width", + "height", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "technicalName": { - "type": "string" + "width": { + "type": "integer", + "format": "int64" }, - "availableEntities": { - "type": "object" + "height": { + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" }, - "templateData": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -15837,28 +15507,28 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "mailTemplates": { + "mediaFolderConfigurations": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } }, "type": "object" }, - "MainCategoryJsonApi": { - "description": "Added since version: 6.1.0.0", + "NewsletterRecipientJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "categoryId", + "id", + "email", + "status", + "hash", + "languageId", "salesChannelId", "createdAt" ], @@ -15867,19 +15537,45 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "email": { + "type": "string" }, - "productVersionId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "categoryId": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryVersionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15899,7 +15595,7 @@ }, "relationships": { "properties": { - "product": { + "tags": { "properties": { "links": { "type": "object", @@ -15907,7 +15603,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" + "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" } } }, @@ -15916,19 +15643,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "category": { + "language": { "properties": { "links": { "type": "object", @@ -15936,7 +15663,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" } } }, @@ -15945,12 +15672,12 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c4ef352f74e502ef5e7bc98e6f4e493d" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -15965,7 +15692,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" } } }, @@ -15994,12 +15721,15 @@ } ] }, - "MainCategory": { - "description": "Added since version: 6.1.0.0", + "NewsletterRecipient": { + "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "categoryId", - "salesChannelId", + "id", + "email", + "status", + "hash", + "languageId", + "salesChannelId", "createdAt" ], "properties": { @@ -16007,19 +15737,45 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "email": { + "type": "string" }, - "productVersionId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "categoryId": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryVersionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -16037,11 +15793,17 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "category": { - "$ref": "#/components/schemas/Category" + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "language": { + "$ref": "#/components/schemas/Language" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" @@ -16049,14 +15811,45 @@ }, "type": "object" }, - "MediaJsonApi": { + "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": { @@ -16064,66 +15857,29 @@ "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 - }, - "alt": { - "type": "string" - }, - "title": { - "type": "string" - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "status": { "type": "string" }, - "path": { + "message": { "type": "string" }, - "hasFile": { - "description": "Runtime field, cannot be used as part of the criteria.", + "adminOnly": { "type": "boolean" }, - "private": { - "type": "boolean" + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "customFields": { - "type": "object" + "createdByIntegrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdByUserId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -16135,12 +15891,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { + "relationships": { "properties": { - "themes": { + "createdByIntegration": { "properties": { "links": { "type": "object", @@ -16148,30 +15901,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "theme" - }, - "id": { - "type": "string", - "example": "fe021943dcda87150f590b3475afaded" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "4698501400b26be8a41def09646e1b59" } } } }, "type": "object" }, - "themeMedia": { + "createdByUser": { "properties": { "links": { "type": "object", @@ -16179,23 +15930,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "theme" - }, - "id": { - "type": "string", - "example": "260be9ecb281c4ff04e7189bb18a35bd" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8a66af2fd5b68899934d19e078c9c111" } } } @@ -16204,10 +15953,128 @@ } }, "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": { - "tags": { + "type": { "properties": { "links": { "type": "object", @@ -16215,30 +16082,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, - "thumbnails": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -16246,7 +16111,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" } } }, @@ -16257,11 +16122,11 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail" + "example": "number_range_sales_channel" }, "id": { "type": "string", - "example": "3b8779ba05b8f0aed49650f3ff8beb4b" + "example": "62db021f1d56ae4688775365be68a04f" } } } @@ -16269,7 +16134,7 @@ }, "type": "object" }, - "user": { + "state": { "properties": { "links": { "type": "object", @@ -16277,7 +16142,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/user" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" } } }, @@ -16286,19 +16151,136 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "number_range_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" - }, - "categories": { + } + }, + "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", @@ -16306,92 +16288,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" } } }, "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": { "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": { + "example": "number_range" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" }, - "productDownloads": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -16399,92 +16317,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" } } }, "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": { "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": { + "example": "sales_channel" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "mediaFolder": { + "numberRangeType": { "properties": { "links": { "type": "object", @@ -16492,7 +16346,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" } } }, @@ -16501,81 +16355,112 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "number_range_type" }, "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" - } + "example": "3d771a402fc5aa3349c2c15637058e8c" } } } }, "type": "object" - }, - "documentBaseConfigs": { + } + }, + "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", @@ -16583,92 +16468,118 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" + "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" } } }, "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": { "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": { + "example": "number_range" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" - }, - "productConfiguratorSettings": { + } + }, + "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", @@ -16676,7 +16587,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" } } }, @@ -16687,11 +16598,11 @@ "properties": { "type": { "type": "string", - "example": "product_configurator_setting" + "example": "number_range" }, "id": { "type": "string", - "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + "example": "d28d88efea70a67487116019cff39002" } } } @@ -16699,7 +16610,7 @@ }, "type": "object" }, - "orderLineItems": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -16707,7 +16618,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" } } }, @@ -16718,50 +16629,386 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "number_range_sales_channel" }, "id": { "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + "example": "62db021f1d56ae4688775365be68a04f" } } } } }, "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" + } + }, + "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" }, - "cmsSections": { + "orderCustomer": { "properties": { "links": { "type": "object", @@ -16769,30 +17016,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_section" - }, - "id": { - "type": "string", - "example": "53be3cc1c4a8f41af67a90cf9fd09194" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e90c9c228c1510f5a25902f7a1e8426a" } } } }, "type": "object" }, - "cmsPages": { + "currency": { "properties": { "links": { "type": "object", @@ -16800,30 +17045,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "example": "e676148cc6ffb82b89b3903ecaed2d16" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "documents": { + "language": { "properties": { "links": { "type": "object", @@ -16831,30 +17074,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document" - }, - "id": { - "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "appPaymentMethods": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -16862,7 +17103,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" + "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" } } }, @@ -16873,11 +17143,11 @@ "properties": { "type": { "type": "string", - "example": "app_payment_method" + "example": "order_address" }, "id": { "type": "string", - "example": "e53c737d351047e64a02b7a2a4caffe3" + "example": "963e3a2fe559e393bad631f3dc686f69" } } } @@ -16885,7 +17155,7 @@ }, "type": "object" }, - "appShippingMethods": { + "billingAddress": { "properties": { "links": { "type": "object", @@ -16893,7 +17163,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" + "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" } } }, @@ -16904,354 +17203,19 @@ "properties": { "type": { "type": "string", - "example": "app_shipping_method" + "example": "order_delivery" }, "id": { "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" + "example": "6fc31b6b9cd717cc0dcb81152308f8af" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Media": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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 - }, - "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": [ - "entity", - "associationFields", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "associationFields": { - "type": "array", - "items": { - "type": "string" - } - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "folder": { + "lineItems": { "properties": { "links": { "type": "object", @@ -17259,135 +17223,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_folder" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "851148b4fd8fd7ae74bd9100c5c0c898" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "MediaDefaultFolder": { - "description": "Added since version: 6.0.0.0", - "required": [ - "entity", - "associationFields", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "associationFields": { - "type": "array", - "items": { - "type": "string" - } - }, - "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": [ - "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": { + }, + "transactions": { "properties": { "links": { "type": "object", @@ -17395,28 +17254,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_folder" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "c15b977dd99332ca8623fbdfb86827e8" + } } } } }, "type": "object" }, - "children": { + "documents": { "properties": { "links": { "type": "object", @@ -17424,7 +17285,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" } } }, @@ -17435,11 +17296,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "document" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -17447,7 +17308,7 @@ }, "type": "object" }, - "media": { + "tags": { "properties": { "links": { "type": "object", @@ -17455,7 +17316,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" } } }, @@ -17466,11 +17327,11 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "tag" }, "id": { "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -17478,7 +17339,7 @@ }, "type": "object" }, - "defaultFolder": { + "createdBy": { "properties": { "links": { "type": "object", @@ -17486,7 +17347,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" } } }, @@ -17495,19 +17356,19 @@ "properties": { "type": { "type": "string", - "example": "media_default_folder" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "251dcc9b1621d34e6b01ee14c26b3027" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "configuration": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -17515,7 +17376,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" } } }, @@ -17524,12 +17385,12 @@ "properties": { "type": { "type": "string", - "example": "media_folder_configuration" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ccd1066343c95877b75b79d47c36bebe" + "example": "7ced3d0067ad61702af7db8ae260aa76" } } } @@ -17544,11 +17405,19 @@ } ] }, - "MediaFolder": { + "Order": { "description": "Added since version: 6.0.0.0", "required": [ - "configurationId", - "name", + "id", + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding", "createdAt" ], "properties": { @@ -17556,36 +17425,246 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "useParentConfiguration": { - "type": "boolean" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "configurationId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "type": "string" + }, + "billingAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultFolderId": { + "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "childCount": { - "type": "integer", - "format": "int64", + "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 }, - "path": { + "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 }, - "name": { + "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", @@ -17596,31 +17675,70 @@ "format": "date-time", "readOnly": true }, - "parent": { - "$ref": "#/components/schemas/MediaFolder" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "children": { + "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/MediaFolder" + "$ref": "#/components/schemas/OrderAddress" } }, - "media": { + "billingAddress": { + "$ref": "#/components/schemas/OrderAddress" + }, + "deliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/OrderDelivery" } }, - "defaultFolder": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } }, - "configuration": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "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" }, - "MediaFolderConfigurationJsonApi": { + "OrderAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -17628,6 +17746,13 @@ }, { "required": [ + "id", + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city", "createdAt" ], "properties": { @@ -17635,21 +17760,65 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createThumbnails": { - "type": "boolean" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "keepAspectRatio": { - "type": "boolean" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "thumbnailQuality": { - "type": "integer", - "format": "int64" + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "private": { - "type": "boolean" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "noAssociation": { - "type": "boolean" + "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" @@ -17666,7 +17835,7 @@ }, "relationships": { "properties": { - "mediaFolders": { + "country": { "properties": { "links": { "type": "object", @@ -17674,30 +17843,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_folder" - }, - "id": { - "type": "string", - "example": "6e8238687513bde2e85821c839c597c6" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "mediaThumbnailSizes": { + "countryState": { "properties": { "links": { "type": "object", @@ -17705,7 +17872,65 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" + "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" } } }, @@ -17716,17 +17941,46 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail_size" + "example": "order_delivery" }, "id": { "type": "string", - "example": "44dee48a0006e8db2fcec2a5e1456449" + "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" @@ -17736,9 +17990,16 @@ } ] }, - "MediaFolderConfiguration": { + "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city", "createdAt" ], "properties": { @@ -17746,348 +18007,65 @@ "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": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaThumbnailSizeId": { + "countryId": { "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": { + "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "orderVersionId": { "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": [ - "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": [ - "mediaId", - "width", - "height", - "createdAt" - ], - "properties": { - "id": { + "salutationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "type": "string" }, - "width": { - "type": "integer", - "format": "int64", - "readOnly": true + "lastName": { + "type": "string" }, - "height": { - "type": "integer", - "format": "int64", - "readOnly": true + "street": { + "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "zipcode": { "type": "string" }, - "path": { + "city": { "type": "string" }, - "customFields": { - "type": "object" + "company": { + "type": "string" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "department": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "title": { + "type": "string" }, - "media": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "MediaThumbnailSizeJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "vatId": { + "type": "string" }, - { - "required": [ - "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": [ - "width", - "height", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "phoneNumber": { + "type": "string" }, - "width": { - "type": "integer", - "format": "int64" + "additionalAddressLine1": { + "type": "string" }, - "height": { - "type": "integer", - "format": "int64" + "additionalAddressLine2": { + "type": "string" }, "customFields": { "type": "object" @@ -18102,16 +18080,28 @@ "format": "date-time", "readOnly": true }, - "mediaFolderConfigurations": { + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "orderDeliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/OrderDelivery" } + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "NewsletterRecipientJsonApi": { + "OrderCustomerJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -18119,11 +18109,11 @@ }, { "required": [ + "id", + "orderId", "email", - "status", - "hash", - "languageId", - "salesChannelId", + "firstName", + "lastName", "createdAt" ], "properties": { @@ -18131,11 +18121,28 @@ "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" }, - "title": { - "type": "string" + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" @@ -18143,39 +18150,26 @@ "lastName": { "type": "string" }, - "zipCode": { - "type": "string" - }, - "city": { + "company": { "type": "string" }, - "street": { + "title": { "type": "string" }, - "status": { - "type": "string" + "vatIds": { + "type": "array", + "items": { + "type": "string" + } }, - "hash": { + "customerNumber": { "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}$" + "remoteAddress": { + "type": "string" }, "createdAt": { "type": "string", @@ -18189,38 +18183,7 @@ }, "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": { + "order": { "properties": { "links": { "type": "object", @@ -18228,7 +18191,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" } } }, @@ -18237,19 +18200,19 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "language": { + "customer": { "properties": { "links": { "type": "object", @@ -18257,7 +18220,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" } } }, @@ -18266,19 +18229,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "salesChannel": { + "salutation": { "properties": { "links": { "type": "object", @@ -18286,7 +18249,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" } } }, @@ -18295,12 +18258,12 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -18315,14 +18278,14 @@ } ] }, - "NewsletterRecipient": { + "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "orderId", "email", - "status", - "hash", - "languageId", - "salesChannelId", + "firstName", + "lastName", "createdAt" ], "properties": { @@ -18330,11 +18293,28 @@ "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" }, - "title": { - "type": "string" + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "firstName": { "type": "string" @@ -18342,39 +18322,26 @@ "lastName": { "type": "string" }, - "zipCode": { + "company": { "type": "string" }, - "city": { + "title": { "type": "string" }, - "street": { - "type": "string" + "vatIds": { + "type": "array", + "items": { + "type": "string" + } }, - "status": { - "type": "string" - }, - "hash": { + "customerNumber": { "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}$" + "remoteAddress": { + "type": "string" }, "createdAt": { "type": "string", @@ -18386,62 +18353,34 @@ "format": "date-time", "readOnly": true }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "order": { + "$ref": "#/components/schemas/Order" + }, + "customer": { + "$ref": "#/components/schemas/Customer" }, "salutation": { "$ref": "#/components/schemas/Salutation" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "NewsletterRecipientTag": { + "OrderDeliveryJsonApi": { "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": [ - "status", - "message", + "id", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", + "stateId", + "trackingCodes", + "shippingDateEarliest", + "shippingDateLatest", "createdAt" ], "properties": { @@ -18449,29 +18388,107 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "status": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "message": { - "type": "string" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "adminOnly": { - "type": "boolean" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "requiredPrivileges": { + "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": "object", - "additionalProperties": false + "type": "string" } }, - "createdByIntegrationId": { + "shippingDateEarliest": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "createdByUserId": { + "shippingDateLatest": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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", @@ -18485,7 +18502,7 @@ }, "relationships": { "properties": { - "createdByIntegration": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -18493,7 +18510,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" } } }, @@ -18502,19 +18519,19 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "4698501400b26be8a41def09646e1b59" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "createdByUser": { + "order": { "properties": { "links": { "type": "object", @@ -18522,7 +18539,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" } } }, @@ -18531,140 +18548,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8a66af2fd5b68899934d19e078c9c111" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Notification": { - "description": "Added since version: 6.4.7.0", - "required": [ - "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": [ - "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": { + }, + "shippingOrderAddress": { "properties": { "links": { "type": "object", @@ -18672,7 +18568,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" } } }, @@ -18681,19 +18577,19 @@ "properties": { "type": { "type": "string", - "example": "number_range_type" + "example": "order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "599dcce2998a6b40b1e38e8c6006cb0a" + "example": "39a8592767b8b6a5d6b1dbc47e4058ca" } } } }, "type": "object" }, - "numberRangeSalesChannels": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -18701,30 +18597,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_sales_channel" - }, - "id": { - "type": "string", - "example": "62db021f1d56ae4688775365be68a04f" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "state": { + "positions": { "properties": { "links": { "type": "object", @@ -18732,21 +18626,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery_position" + }, + "id": { + "type": "string", + "example": "365a4a972db646c76d115b3897f2d4de" + } } } } @@ -18761,231 +18657,125 @@ } ] }, - "NumberRange": { + "OrderDelivery": { "description": "Added since version: 6.0.0.0", "required": [ - "typeId", - "global", - "pattern", - "start", - "createdAt", - "name" + "id", + "orderId", + "shippingOrderAddressId", + "shippingMethodId", + "stateId", + "trackingCodes", + "shippingDateEarliest", + "shippingDateLatest", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "typeId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "global": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "pattern": { - "type": "string" - }, - "start": { - "type": "integer", - "format": "int64" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "shippingOrderAddressId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "shippingOrderAddressVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "type": { - "$ref": "#/components/schemas/NumberRangeType" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "numberRangeSalesChannels": { + "trackingCodes": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "type": "string" } }, - "state": { - "$ref": "#/components/schemas/NumberRangeState" - } - }, - "type": "object" - }, - "NumberRangeSalesChannelJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "shippingDateEarliest": { + "type": "string", + "format": "date-time" }, - { + "shippingDateLatest": { + "type": "string", + "format": "date-time" + }, + "shippingCosts": { "required": [ - "numberRangeId", - "salesChannelId", - "createdAt" + "unitPrice", + "totalPrice", + "quantity" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "type": "number", + "format": "float" }, - "numberRangeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "totalPrice": { + "type": "number", + "format": "float" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "integer", + "format": "int64" }, - "numberRangeTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "calculatedTaxes": { + "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "taxRules": { + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "referencePrice": { + "type": "object" }, - "relationships": { + "listPrice": { "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" + "price": { + "type": "number", + "format": "float" }, - "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" + "discount": { + "type": "number", + "format": "float" }, - "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" + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" } }, "type": "object" } }, "type": "object" - } - ] - }, - "NumberRangeSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -18997,19 +18787,28 @@ "format": "date-time", "readOnly": true }, - "numberRange": { - "$ref": "#/components/schemas/NumberRange" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "order": { + "$ref": "#/components/schemas/Order" }, - "numberRangeType": { - "$ref": "#/components/schemas/NumberRangeType" + "shippingOrderAddress": { + "$ref": "#/components/schemas/OrderAddress" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } } }, "type": "object" }, - "NumberRangeStateJsonApi": { + "OrderDeliveryPositionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -19017,8 +18816,9 @@ }, { "required": [ - "numberRangeId", - "lastValue", + "id", + "orderDeliveryId", + "orderLineItemId", "createdAt" ], "properties": { @@ -19026,14 +18826,98 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "lastValue": { + "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", @@ -19046,7 +18930,7 @@ }, "relationships": { "properties": { - "numberRange": { + "orderDelivery": { "properties": { "links": { "type": "object", @@ -19054,7 +18938,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" } } }, @@ -19063,12 +18947,41 @@ "properties": { "type": { "type": "string", - "example": "number_range" + "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" + "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" } } } @@ -19083,11 +18996,12 @@ } ] }, - "NumberRangeState": { + "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": [ - "numberRangeId", - "lastValue", + "id", + "orderDeliveryId", + "orderLineItemId", "createdAt" ], "properties": { @@ -19095,164 +19009,94 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "numberRangeId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "lastValue": { - "type": "integer", - "format": "int64" + "orderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderDeliveryVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "orderLineItemId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "numberRange": { - "$ref": "#/components/schemas/NumberRange" - } - }, - "type": "object" - }, - "NumberRangeTypeJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { + "price": { "required": [ - "global", - "createdAt", - "typeName" + "unitPrice", + "totalPrice", + "quantity" ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "technicalName": { - "type": "string" + "unitPrice": { + "type": "number", + "format": "float" }, - "typeName": { - "type": "string" + "totalPrice": { + "type": "number", + "format": "float" }, - "global": { - "type": "boolean" + "quantity": { + "type": "integer", + "format": "int64" }, - "customFields": { + "calculatedTaxes": { "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "taxRules": { + "type": "object" }, - "translated": { + "referencePrice": { "type": "object" }, - "relationships": { + "listPrice": { "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" + "price": { + "type": "number", + "format": "float" }, - "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" + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" } }, "type": "object" } }, "type": "object" - } - ] - }, - "NumberRangeType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "global", - "createdAt", - "typeName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" + "unitPrice": { + "type": "number", + "format": "float" }, - "typeName": { - "type": "string" + "totalPrice": { + "type": "number", + "format": "float" }, - "global": { - "type": "boolean" + "quantity": { + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -19267,25 +19111,16 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "numberRanges": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } + "orderDelivery": { + "$ref": "#/components/schemas/OrderDelivery" }, - "numberRangeSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, - "OrderJsonApi": { + "OrderLineItemJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -19293,15 +19128,15 @@ }, { "required": [ - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding", + "id", + "orderId", + "identifier", + "quantity", + "label", + "position", + "states", + "price", + "children", "createdAt" ], "properties": { @@ -19313,99 +19148,74 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderNumber": { - "type": "string" - }, - "billingAddressId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "billingAddressVersionId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDateTime": { + "parentVersionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "orderDate": { + "coverId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "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" - } - }, + "identifier": { + "type": "string" + }, + "referencedId": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "label": { + "type": "string" + }, + "payload": { "type": "object" }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true + "good": { + "type": "boolean" }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true + "removable": { + "type": "boolean" }, - "positionPrice": { - "type": "number", - "format": "float", - "readOnly": true + "stackable": { + "type": "boolean" }, - "taxStatus": { - "type": "string", - "readOnly": true + "position": { + "type": "integer", + "format": "int64" }, - "shippingCosts": { + "states": { + "type": "array", + "items": { + "type": "string" + } + }, + "price": { "required": [ "unitPrice", "totalPrice", @@ -19462,83 +19272,26 @@ }, "type": "object" }, - "shippingTotal": { - "type": "number", - "format": "float", - "readOnly": true + "priceDefinition": { + "type": "object" }, - "currencyFactor": { + "unitPrice": { "type": "number", "format": "float" }, - "deepLinkCode": { - "type": "string" - }, - "affiliateCode": { - "type": "string" - }, - "campaignCode": { - "type": "string" + "totalPrice": { + "type": "number", + "format": "float" }, - "customerComment": { + "description": { "type": "string" }, - "source": { + "type": { "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": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -19551,36 +19304,7 @@ }, "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": { + "cover": { "properties": { "links": { "type": "object", @@ -19588,7 +19312,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" } } }, @@ -19597,19 +19321,19 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e90c9c228c1510f5a25902f7a1e8426a" + "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, - "currency": { + "order": { "properties": { "links": { "type": "object", @@ -19617,7 +19341,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" } } }, @@ -19626,19 +19350,19 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "language": { + "product": { "properties": { "links": { "type": "object", @@ -19646,7 +19370,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" } } }, @@ -19655,19 +19379,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "salesChannel": { + "promotion": { "properties": { "links": { "type": "object", @@ -19675,7 +19399,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" } } }, @@ -19684,19 +19408,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "addresses": { + "orderDeliveryPositions": { "properties": { "links": { "type": "object", @@ -19704,7 +19428,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" } } }, @@ -19715,11 +19439,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "order_delivery_position" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "76d4619a36f864b08f57415baaa685ec" } } } @@ -19727,36 +19451,7 @@ }, "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": { + "orderTransactionCaptureRefundPositions": { "properties": { "links": { "type": "object", @@ -19764,7 +19459,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" } } }, @@ -19775,11 +19470,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "order_transaction_capture_refund_position" }, "id": { "type": "string", - "example": "6fc31b6b9cd717cc0dcb81152308f8af" + "example": "c330b64e5adc1e48e07a78aa79e5b27a" } } } @@ -19787,7 +19482,7 @@ }, "type": "object" }, - "lineItems": { + "downloads": { "properties": { "links": { "type": "object", @@ -19795,7 +19490,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" } } }, @@ -19806,11 +19501,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "order_line_item_download" }, "id": { "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" + "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } @@ -19818,7 +19513,7 @@ }, "type": "object" }, - "transactions": { + "parent": { "properties": { "links": { "type": "object", @@ -19826,61 +19521,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/transactions" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" } } }, "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": { "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" - } + "example": "order_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "tags": { + "children": { "properties": { "links": { "type": "object", @@ -19888,7 +19550,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" } } }, @@ -19899,75 +19561,17 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "order_line_item" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "268184c12df027f536154d099d497b31" } } } } }, "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" @@ -19977,18 +19581,18 @@ } ] }, - "Order": { + "OrderLineItem": { "description": "Added since version: 6.0.0.0", "required": [ - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding", + "id", + "orderId", + "identifier", + "quantity", + "label", + "position", + "states", + "price", + "children", "createdAt" ], "properties": { @@ -20000,52 +19604,81 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderNumber": { - "type": "string" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "billingAddressId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "billingAddressVersionId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDateTime": { + "parentVersionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "orderDate": { + "coverId": { "type": "string", - "readOnly": true + "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": [ - "netPrice", + "unitPrice", "totalPrice", - "positionPrice", - "rawTotal", - "taxStatus" + "quantity" ], "properties": { - "netPrice": { + "unitPrice": { "type": "number", "format": "float" }, @@ -20053,72 +19686,18 @@ "type": "number", "format": "float" }, + "quantity": { + "type": "integer", + "format": "int64" + }, "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" + "referencePrice": { + "type": "object" }, "listPrice": { "properties": { @@ -20149,83 +19728,26 @@ }, "type": "object" }, - "shippingTotal": { - "type": "number", - "format": "float", - "readOnly": true + "priceDefinition": { + "type": "object" }, - "currencyFactor": { + "unitPrice": { "type": "number", "format": "float" }, - "deepLinkCode": { - "type": "string" - }, - "affiliateCode": { - "type": "string" - }, - "campaignCode": { - "type": "string" + "totalPrice": { + "type": "number", + "format": "float" }, - "customerComment": { + "description": { "type": "string" }, - "source": { + "type": { "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": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -20236,83 +19758,61 @@ "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" + "cover": { + "$ref": "#/components/schemas/Media" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "order": { + "$ref": "#/components/schemas/Order" }, - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } + "product": { + "$ref": "#/components/schemas/Product" }, - "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "deliveries": { + "orderDeliveryPositions": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDeliveryPosition" } }, - "lineItems": { + "orderTransactionCaptureRefundPositions": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } }, - "transactions": { + "downloads": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItemDownload" } }, - "documents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "parent": { + "$ref": "#/components/schemas/OrderLineItem" }, - "tags": { + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/OrderLineItem" } - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" } }, "type": "object" }, - "OrderAddressJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderLineItemDownloadJsonApi": { + "description": "Added since version: 6.4.19.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city", + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted", "createdAt" ], "properties": { @@ -20324,61 +19824,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { + "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "mediaId": { "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" + "position": { + "type": "integer", + "format": "int64" }, - "additionalAddressLine2": { - "type": "string" + "accessGranted": { + "type": "boolean" }, "customFields": { "type": "object" @@ -20395,65 +19858,7 @@ }, "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": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -20461,7 +19866,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" } } }, @@ -20470,50 +19875,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "order_line_item" }, "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" - } + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, - "salutation": { + "media": { "properties": { "links": { "type": "object", @@ -20521,7 +19895,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" } } }, @@ -20530,12 +19904,12 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -20550,15 +19924,14 @@ } ] }, - "OrderAddress": { - "description": "Added since version: 6.0.0.0", + "OrderLineItemDownload": { + "description": "Added since version: 6.4.19.0", "required": [ - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city", + "id", + "orderLineItemId", + "mediaId", + "position", + "accessGranted", "createdAt" ], "properties": { @@ -20570,61 +19943,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { + "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "mediaId": { "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" + "position": { + "type": "integer", + "format": "int64" }, - "additionalAddressLine2": { - "type": "string" + "accessGranted": { + "type": "boolean" }, "customFields": { "type": "object" @@ -20639,28 +19975,48 @@ "format": "date-time", "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" }, - "countryState": { - "$ref": "#/components/schemas/CountryState" + "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" }, - "orderDeliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "OrderCustomerJsonApi": { + "OrderTransactionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -20668,10 +20024,11 @@ }, { "required": [ + "id", "orderId", - "email", - "firstName", - "lastName", + "paymentMethodId", + "amount", + "stateId", "createdAt" ], "properties": { @@ -20683,10 +20040,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -20695,53 +20048,90 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "email": { - "type": "string" - }, - "salutationId": { + "paymentMethodId": { "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", + "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": { - "order": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -20749,7 +20139,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" } } }, @@ -20758,19 +20148,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "customer": { + "order": { "properties": { "links": { "type": "object", @@ -20778,7 +20168,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" } } }, @@ -20787,19 +20177,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "salutation": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -20807,7 +20197,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" } } }, @@ -20816,12 +20206,43 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "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" + } } } } @@ -20836,13 +20257,14 @@ } ] }, - "OrderCustomer": { + "OrderTransaction": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", - "email", - "firstName", - "lastName", + "paymentMethodId", + "amount", + "stateId", "createdAt" ], "properties": { @@ -20854,10 +20276,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -20866,40 +20284,77 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "email": { - "type": "string" - }, - "salutationId": { + "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "company": { - "type": "string" - }, - "title": { - "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" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } + "validationData": { + "type": "object" }, - "customerNumber": { - "type": "string" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "remoteAddress": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -20910,33 +20365,36 @@ "format": "date-time", "readOnly": true }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, "order": { "$ref": "#/components/schemas/Order" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "captures": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } } }, "type": "object" }, - "OrderDeliveryJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureJsonApi": { + "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "orderId", - "shippingOrderAddressId", - "shippingMethodId", + "id", + "orderTransactionId", "stateId", - "trackingCodes", - "shippingDateEarliest", - "shippingDateLatest", + "amount", "createdAt" ], "properties": { @@ -20948,23 +20406,11 @@ "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": { + "orderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20972,21 +20418,10 @@ "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" + "externalReference": { + "type": "string" }, - "shippingCosts": { + "amount": { "required": [ "unitPrice", "totalPrice", @@ -21066,7 +20501,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" } } }, @@ -21087,65 +20522,7 @@ }, "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": { + "transaction": { "properties": { "links": { "type": "object", @@ -21153,7 +20530,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" } } }, @@ -21162,19 +20539,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "f4d5b76a2418eba4baeabc1ed9142b54" } } } }, "type": "object" }, - "positions": { + "refunds": { "properties": { "links": { "type": "object", @@ -21182,7 +20559,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" } } }, @@ -21193,11 +20570,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "order_transaction_capture_refund" }, "id": { "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" + "example": "0084ff716402199f733f841f5937d3ae" } } } @@ -21213,16 +20590,13 @@ } ] }, - "OrderDelivery": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", "required": [ - "orderId", - "shippingOrderAddressId", - "shippingMethodId", + "id", + "orderTransactionId", "stateId", - "trackingCodes", - "shippingDateEarliest", - "shippingDateLatest", + "amount", "createdAt" ], "properties": { @@ -21234,23 +20608,11 @@ "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": { + "orderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "orderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21258,21 +20620,10 @@ "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" + "externalReference": { + "type": "string" }, - "shippingCosts": { + "amount": { "required": [ "unitPrice", "totalPrice", @@ -21345,34 +20696,30 @@ "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "transaction": { + "$ref": "#/components/schemas/OrderTransaction" }, - "positions": { + "refunds": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } }, "type": "object" }, - "OrderDeliveryPositionJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefundJsonApi": { + "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "orderDeliveryId", - "orderLineItemId", + "id", + "captureId", + "stateId", + "amount", "createdAt" ], "properties": { @@ -21384,23 +20731,25 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryId": { + "captureId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryVersionId": { + "captureVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "externalReference": { + "type": "string" }, - "price": { + "reason": { + "type": "string" + }, + "amount": { "required": [ "unitPrice", "totalPrice", @@ -21457,18 +20806,6 @@ }, "type": "object" }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "customFields": { "type": "object" }, @@ -21484,7 +20821,7 @@ }, "relationships": { "properties": { - "orderDelivery": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -21492,7 +20829,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" } } }, @@ -21501,19 +20838,19 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "473c50bdac32ac0dc66364d121260dce" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "orderLineItem": { + "transactionCapture": { "properties": { "links": { "type": "object", @@ -21521,7 +20858,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" } } }, @@ -21530,12 +20867,43 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "order_transaction_capture" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "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" + } } } } @@ -21550,13 +20918,15 @@ } ] }, - "OrderDeliveryPosition": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefund": { + "description": "Added since version: 6.4.12.0", "required": [ - "orderDeliveryId", - "orderLineItemId", - "createdAt" - ], + "id", + "captureId", + "stateId", + "amount", + "createdAt" + ], "properties": { "id": { "type": "string", @@ -21566,23 +20936,25 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryId": { + "captureId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryVersionId": { + "captureVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "externalReference": { + "type": "string" }, - "price": { + "reason": { + "type": "string" + }, + "amount": { "required": [ "unitPrice", "totalPrice", @@ -21639,18 +21011,6 @@ }, "type": "object" }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "customFields": { "type": "object" }, @@ -21664,31 +21024,33 @@ "format": "date-time", "readOnly": true }, - "orderDelivery": { - "$ref": "#/components/schemas/OrderDelivery" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" + "transactionCapture": { + "$ref": "#/components/schemas/OrderTransactionCapture" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } } }, "type": "object" }, - "OrderLineItemJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderTransactionCaptureRefundPositionJsonApi": { + "description": "Added since version: 6.4.12.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "orderId", - "identifier", - "quantity", - "label", - "position", - "states", - "price", - "children", + "id", + "refundId", + "orderLineItemId", + "amount", "createdAt" ], "properties": { @@ -21700,75 +21062,33 @@ "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": { + "refundId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true - }, - "parentId": { + "refundVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentVersionId": { + "orderLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { + "externalReference": { "type": "string" }, - "referencedId": { + "reason": { "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": { + "amount": { "required": [ "unitPrice", "totalPrice", @@ -21825,23 +21145,6 @@ }, "type": "object" }, - "priceDefinition": { - "type": "object" - }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "description": { - "type": "string" - }, - "type": { - "type": "string" - }, "customFields": { "type": "object" }, @@ -21857,7 +21160,7 @@ }, "relationships": { "properties": { - "cover": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -21865,7 +21168,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" } } }, @@ -21874,19 +21177,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, - "order": { + "orderTransactionCaptureRefund": { "properties": { "links": { "type": "object", @@ -21894,7 +21197,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" } } }, @@ -21903,19 +21206,257 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "order_transaction_capture_refund" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "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" }, - "product": { + "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", @@ -21923,7 +21464,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" } } }, @@ -21932,19 +21473,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "promotion": { + "availabilityRule": { "properties": { "links": { "type": "object", @@ -21952,7 +21493,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" } } }, @@ -21961,19 +21502,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, - "orderDeliveryPositions": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -21981,7 +21522,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" } } }, @@ -21992,11 +21533,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "sales_channel" }, "id": { "type": "string", - "example": "76d4619a36f864b08f57415baaa685ec" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -22004,7 +21545,7 @@ }, "type": "object" }, - "orderTransactionCaptureRefundPositions": { + "plugin": { "properties": { "links": { "type": "object", @@ -22012,30 +21553,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction_capture_refund_position" - }, - "id": { - "type": "string", - "example": "c330b64e5adc1e48e07a78aa79e5b27a" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "plugin" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a24bcf2198b1b13ad985304483f7f324" } } } }, "type": "object" }, - "downloads": { + "customers": { "properties": { "links": { "type": "object", @@ -22043,7 +21582,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" } } }, @@ -22054,11 +21593,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item_download" + "example": "customer" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -22066,7 +21605,7 @@ }, "type": "object" }, - "parent": { + "orderTransactions": { "properties": { "links": { "type": "object", @@ -22074,28 +21613,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "example": "3bdb6a464fb3330bd1935325493c5f2c" + } } } } }, "type": "object" }, - "children": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -22103,7 +21644,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" } } }, @@ -22114,17 +21655,46 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "sales_channel" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "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" @@ -22134,172 +21704,92 @@ } ] }, - "OrderLineItem": { + "PaymentMethod": { "description": "Added since version: 6.0.0.0", "required": [ - "orderId", - "identifier", - "quantity", - "label", - "position", - "states", - "price", - "children", - "createdAt" + "id", + "createdAt", + "name" ], "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": { + "pluginId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "handlerIdentifier": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "promotionId": { + "distinguishableName": { "type": "string", - "pattern": "^[0-9a-f]{32}$", "readOnly": true }, - "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": { + "description": { "type": "string" }, - "quantity": { + "position": { "type": "integer", "format": "int64" }, - "label": { - "type": "string" - }, - "payload": { - "type": "object" - }, - "good": { + "active": { "type": "boolean" }, - "removable": { + "afterOrderEnabled": { "type": "boolean" }, - "stackable": { - "type": "boolean" + "customFields": { + "type": "object" }, - "position": { - "type": "integer", - "format": "int64" + "availabilityRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "states": { - "type": "array", - "items": { - "type": "string" - } + "mediaId": { + "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" + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "priceDefinition": { - "type": "object" + "synchronous": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true }, - "unitPrice": { - "type": "number", - "format": "float" + "asynchronous": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true }, - "totalPrice": { - "type": "number", - "format": "float" + "prepared": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true }, - "description": { - "type": "string" + "refundable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "readOnly": true }, - "type": { + "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" }, - "customFields": { - "type": "object" + "technicalName": { + "type": "string" }, "createdAt": { "type": "string", @@ -22311,89 +21801,129 @@ "format": "date-time", "readOnly": true }, - "cover": { - "$ref": "#/components/schemas/Media" - }, - "order": { - "$ref": "#/components/schemas/Order" + "translated": { + "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "media": { + "$ref": "#/components/schemas/Media" }, - "promotion": { - "$ref": "#/components/schemas/Promotion" + "availabilityRule": { + "$ref": "#/components/schemas/Rule" }, - "orderDeliveryPositions": { + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/SalesChannel" } }, - "orderTransactionCaptureRefundPositions": { + "plugin": { + "$ref": "#/components/schemas/Plugin" + }, + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/Customer" } }, - "downloads": { + "orderTransactions": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderTransaction" } }, - "parent": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "children": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/SalesChannel" } + }, + "appPaymentMethod": { + "$ref": "#/components/schemas/AppPaymentMethod" } }, "type": "object" }, - "OrderLineItemDownloadJsonApi": { - "description": "Added since version: 6.4.19.0", + "PluginJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "orderLineItemId", - "mediaId", - "position", - "accessGranted", - "createdAt" + "id", + "baseClass", + "name", + "autoload", + "version", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "baseClass": { + "type": "string" }, - "orderLineItemId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "orderLineItemVersionId": { + "upgradedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "mediaId": { + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "position": { - "type": "integer", - "format": "int64" + "label": { + "type": "string" }, - "accessGranted": { - "type": "boolean" + "description": { + "type": "string" + }, + "manufacturerLink": { + "type": "string" + }, + "supportLink": { + "type": "string" }, "customFields": { "type": "object" @@ -22408,38 +21938,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -22447,21 +21951,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" + "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } } } } @@ -22476,42 +21982,82 @@ } ] }, - "OrderLineItemDownload": { - "description": "Added since version: 6.4.19.0", + "Plugin": { + "description": "Added since version: 6.0.0.0", "required": [ - "orderLineItemId", - "mediaId", - "position", - "accessGranted", - "createdAt" + "id", + "baseClass", + "name", + "autoload", + "version", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "baseClass": { + "type": "string" }, - "orderLineItemId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "orderLineItemVersionId": { + "upgradedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "mediaId": { + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "position": { - "type": "integer", - "format": "int64" + "label": { + "type": "string" }, - "accessGranted": { - "type": "boolean" + "description": { + "type": "string" + }, + "manufacturerLink": { + "type": "string" + }, + "supportLink": { + "type": "string" }, "customFields": { "type": "object" @@ -22526,48 +22072,19 @@ "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" + "translated": { + "type": "object" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } } }, "type": "object" }, - "OrderTransactionJsonApi": { + "ProductJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -22575,11 +22092,13 @@ }, { "required": [ - "orderId", - "paymentMethodId", - "amount", - "stateId", - "createdAt" + "id", + "taxId", + "price", + "productNumber", + "stock", + "createdAt", + "name" ], "properties": { "id": { @@ -22590,82 +22109,274 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "manufacturerId": { "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" + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "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", @@ -22676,9 +22387,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "stateMachineState": { + "downloads": { "properties": { "links": { "type": "object", @@ -22686,7 +22400,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" + "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" } } }, @@ -22695,19 +22440,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "order": { + "children": { "properties": { "links": { "type": "object", @@ -22715,7 +22460,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" + "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" } } }, @@ -22724,19 +22500,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "delivery_time" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, - "paymentMethod": { + "tax": { "properties": { "links": { "type": "object", @@ -22744,7 +22520,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" + "example": "/product/deb10517653c255364175796ace3553f/tax" } } }, @@ -22753,19 +22529,19 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, - "captures": { + "manufacturer": { "properties": { "links": { "type": "object", @@ -22773,269 +22549,57 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" + "example": "/product/deb10517653c255364175796ace3553f/manufacturer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction_capture" - }, - "id": { - "type": "string", - "example": "8856ffdd044d57cd4124a6be5dcea329" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_manufacturer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c2904bca62b22443d6cf5e9d89cab204" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderTransaction": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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" + "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" }, - "percentage": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "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": [ - "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": { + "cover": { "properties": { "links": { "type": "object", @@ -23043,7 +22607,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" + "example": "/product/deb10517653c255364175796ace3553f/cover" } } }, @@ -23052,19 +22616,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "product_media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, - "transaction": { + "featureSet": { "properties": { "links": { "type": "object", @@ -23072,7 +22636,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" + "example": "/product/deb10517653c255364175796ace3553f/featureSet" } } }, @@ -23081,19 +22645,19 @@ "properties": { "type": { "type": "string", - "example": "order_transaction" + "example": "product_feature_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f4d5b76a2418eba4baeabc1ed9142b54" + "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" } } } }, "type": "object" }, - "refunds": { + "cmsPage": { "properties": { "links": { "type": "object", @@ -23101,267 +22665,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" + "example": "/product/deb10517653c255364175796ace3553f/cmsPage" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction_capture_refund" - }, - "id": { - "type": "string", - "example": "0084ff716402199f733f841f5937d3ae" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderTransactionCapture": { - "description": "Added since version: 6.4.12.0", - "required": [ - "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": [ - "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": { + "canonicalProduct": { "properties": { "links": { "type": "object", @@ -23369,7 +22694,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" + "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" } } }, @@ -23378,19 +22703,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "023995a50b56c0de077323e958b2bbcd" } } } }, "type": "object" }, - "transactionCapture": { + "prices": { "properties": { "links": { "type": "object", @@ -23398,28 +22723,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" + "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": { - "type": { - "type": "string", - "example": "order_transaction_capture" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56b70ce76ce8e9bfbaf80ea040d456b5" + "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" }, - "positions": { + "crossSellings": { "properties": { "links": { "type": "object", @@ -23427,7 +22785,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" + "example": "/product/deb10517653c255364175796ace3553f/crossSellings" } } }, @@ -23438,267 +22796,174 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund_position" + "example": "product_cross_selling" }, "id": { "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" + "example": "89936e14544d1b403cecef938101b6b0" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderTransactionCaptureRefund": { - "description": "Added since version: 6.4.12.0", - "required": [ - "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": [ - "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": { + "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" }, - "taxRules": { + "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" }, - "referencePrice": { + "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" }, - "listPrice": { + "searchKeywords": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "effbcffaacb8111b531f15e6f4c796d1" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "productReviews": { "properties": { - "price": { - "type": "number", - "format": "float" + "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" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "orderLineItem": { + }, + "mainCategories": { "properties": { "links": { "type": "object", @@ -23706,28 +22971,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" + "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": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "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" }, - "orderTransactionCaptureRefund": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -23735,322 +23033,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" + "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": { - "type": { + "related": { "type": "string", - "example": "order_transaction_capture_refund" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "8e55f83da36c39263717541ec1f18de7" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderTransactionCaptureRefundPosition": { - "description": "Added since version: 6.4.12.0", - "required": [ - "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": [ - "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" + "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" }, - "salesChannelDefaultAssignments": { + "properties": { "properties": { "links": { "type": "object", @@ -24058,7 +23126,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" + "example": "/product/deb10517653c255364175796ace3553f/properties" } } }, @@ -24069,11 +23137,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "property_group_option" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "74693d2fc58b46bd06410f278e39aa71" } } } @@ -24081,7 +23149,7 @@ }, "type": "object" }, - "plugin": { + "categories": { "properties": { "links": { "type": "object", @@ -24089,28 +23157,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" + "example": "/product/deb10517653c255364175796ace3553f/categories" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "plugin" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "a24bcf2198b1b13ad985304483f7f324" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } } } } }, "type": "object" }, - "customers": { + "streams": { "properties": { "links": { "type": "object", @@ -24118,7 +23188,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" + "example": "/product/deb10517653c255364175796ace3553f/streams" } } }, @@ -24129,11 +23199,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "product_stream" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "2f6f4768f1c2d7c8f1f54823723f1a70" } } } @@ -24141,7 +23211,7 @@ }, "type": "object" }, - "orderTransactions": { + "categoriesRo": { "properties": { "links": { "type": "object", @@ -24149,7 +23219,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" + "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" } } }, @@ -24160,11 +23230,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction" + "example": "category" }, "id": { "type": "string", - "example": "3bdb6a464fb3330bd1935325493c5f2c" + "example": "7f0702d3a90d965b8c9158c451f43fdb" } } } @@ -24172,7 +23242,7 @@ }, "type": "object" }, - "salesChannels": { + "tags": { "properties": { "links": { "type": "object", @@ -24180,7 +23250,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" + "example": "/product/deb10517653c255364175796ace3553f/tags" } } }, @@ -24191,11 +23261,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "tag" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -24203,7 +23273,7 @@ }, "type": "object" }, - "appPaymentMethod": { + "customFieldSets": { "properties": { "links": { "type": "object", @@ -24211,21 +23281,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" + "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } } } } @@ -24240,9 +23312,14 @@ } ] }, - "PaymentMethod": { + "Product": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "taxId", + "price", + "productNumber", + "stock", "createdAt", "name" ], @@ -24251,134 +23328,520 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "handlerIdentifier": { - "type": "string" - }, - "name": { - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "distinguishableName": { + "parentVersionId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "manufacturerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "unitId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "afterOrderEnabled": { - "type": "boolean" + "taxId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "availabilityRuleId": { + "productMediaVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "formattedHandlerIdentifier": { - "description": "Runtime field, cannot be used as part of the criteria.", + "featureSetId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "synchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "canonicalProductId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "asynchronous": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "prepared": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "refundable": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "recurring": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean", - "readOnly": true + "price": { + "type": "object" }, - "shortName": { - "description": "Runtime field, cannot be used as part of the criteria.", + "productNumber": { "type": "string" }, - "technicalName": { - "type": "string" + "restockTime": { + "type": "integer", + "format": "int64" }, - "createdAt": { - "type": "string", - "format": "date-time", + "autoIncrement": { + "type": "integer", + "format": "int64", "readOnly": true }, - "updatedAt": { - "type": "string", - "format": "date-time", + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean", "readOnly": true }, - "translated": { - "type": "object" + "isCloseout": { + "type": "boolean" }, - "media": { - "$ref": "#/components/schemas/Media" + "availableStock": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "stock": { + "type": "integer", + "format": "int64" }, - "salesChannelDefaultAssignments": { + "variation": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "type": "string" } }, - "plugin": { - "$ref": "#/components/schemas/Plugin" + "displayGroup": { + "type": "string", + "readOnly": true }, - "customers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } + "variantListingConfig": { + "type": "object" }, - "orderTransactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } + "variantRestrictions": { + "type": "object" }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" + "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 } }, - "appPaymentMethod": { - "$ref": "#/components/schemas/AppPaymentMethod" + "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" }, - "PluginJsonApi": { + "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": [ { @@ -24386,82 +23849,43 @@ }, { "required": [ - "baseClass", - "name", - "autoload", - "version", - "createdAt", - "label" + "id", + "productId", + "optionId", + "createdAt" ], "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": { + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "upgradedAt": { + "productId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "productVersionId": { "type": "string", - "readOnly": true - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "manufacturerLink": { - "type": "string" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "supportLink": { - "type": "string" + "optionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "changelog": { + "price": { "type": "object" }, + "position": { + "type": "integer", + "format": "int64" + }, "customFields": { "type": "object" }, @@ -24475,12 +23899,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "paymentMethods": { + "product": { "properties": { "links": { "type": "object", @@ -24488,30 +23909,86 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/product" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } + "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" } }, @@ -24519,85 +23996,46 @@ } ] }, - "Plugin": { + "ProductConfiguratorSetting": { "description": "Added since version: 6.0.0.0", "required": [ - "baseClass", - "name", - "autoload", - "version", - "createdAt", - "label" + "id", + "productId", + "optionId", + "createdAt" ], "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": { + "versionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "upgradedAt": { + "productId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "productVersionId": { "type": "string", - "readOnly": true - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" + "pattern": "^[0-9a-f]{32}$" }, - "manufacturerLink": { - "type": "string" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "supportLink": { - "type": "string" + "optionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "changelog": { + "price": { "type": "object" }, + "position": { + "type": "integer", + "format": "int64" + }, "customFields": { "type": "object" }, @@ -24611,304 +24049,72 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "product": { + "$ref": "#/components/schemas/Product" }, - "paymentMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } + "media": { + "$ref": "#/components/schemas/Media" + }, + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "ProductJsonApi": { - "description": "Added since version: 6.0.0.0", + "ProductCrossSellingJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "taxId", - "price", - "productNumber", - "stock", - "createdAt", - "name" + "id", + "name", + "position", + "type", + "productId", + "createdAt" ], "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}$" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "type": "object" - }, - "productNumber": { + "name": { "type": "string" }, - "restockTime": { + "position": { "type": "integer", "format": "int64" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "active": { - "type": "boolean" - }, - "available": { - "type": "boolean", - "readOnly": true - }, - "isCloseout": { - "type": "boolean" - }, - "variation": { - "type": "array", - "items": { - "type": "string" - } - }, - "displayGroup": { - "type": "string", - "readOnly": true - }, - "variantListingConfig": { - "type": "object" - }, - "variantRestrictions": { - "type": "object" - }, - "manufacturerNumber": { + "sortBy": { "type": "string" }, - "ean": { + "sortDirection": { "type": "string" }, - "purchaseSteps": { - "type": "integer", - "format": "int64" + "type": { + "type": "string" }, - "maxPurchase": { - "type": "integer", - "format": "int64" + "active": { + "type": "boolean" }, - "minPurchase": { + "limit": { "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": { + "productId": { "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 - } + "pattern": "^[0-9a-f]{32}$" }, - "availableStock": { - "type": "integer", - "format": "int64" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "stock": { - "type": "integer", - "format": "int64" + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -24923,9 +24129,9 @@ "translated": { "type": "object" }, - "extensions": { + "relationships": { "properties": { - "attendeeProductCollections": { + "product": { "properties": { "links": { "type": "object", @@ -24933,30 +24139,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" + "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/product" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_attendee_product_collection" - }, - "id": { - "type": "string", - "example": "0a7b3b2f4b81f36910a74f22826f35df" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "presentationCmsPages": { + "productStream": { "properties": { "links": { "type": "object", @@ -24964,35 +24168,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" + "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/productStream" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "downloads": { + }, + "assignedProducts": { "properties": { "links": { "type": "object", @@ -25000,7 +24197,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/downloads" + "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/assignedProducts" } } }, @@ -25011,32 +24208,164 @@ "properties": { "type": { "type": "string", - "example": "product_download" + "example": "product_cross_selling_assigned_products" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "5da5e10eda1b7026499bcd4747d6bdf8" } } } } }, "type": "object" - }, - "parent": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/parent" - } - } - }, - "data": { - "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", @@ -25045,14 +24374,14 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "children": { + "crossSelling": { "properties": { "links": { "type": "object", @@ -25060,30 +24389,169 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/children" + "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/crossSelling" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "268184c12df027f536154d099d497b31" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_cross_selling" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ef23268669fb6d8a7def2b9f2da0aceb" } } } }, "type": "object" - }, - "deliveryTime": { + } + }, + "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", @@ -25091,7 +24559,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" + "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/product" } } }, @@ -25100,19 +24568,19 @@ "properties": { "type": { "type": "string", - "example": "delivery_time" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8c888ae25a7bd42057370e31f7e01044" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "tax": { + "media": { "properties": { "links": { "type": "object", @@ -25120,7 +24588,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tax" + "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/media" } } }, @@ -25129,19 +24597,182 @@ "properties": { "type": { "type": "string", - "example": "tax" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" - }, - "manufacturer": { + } + }, + "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", @@ -25149,7 +24780,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/manufacturer" + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/productStream" } } }, @@ -25158,19 +24789,19 @@ "properties": { "type": { "type": "string", - "example": "product_manufacturer" + "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "c2904bca62b22443d6cf5e9d89cab204" + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, - "unit": { + "storefrontSalesChannel": { "properties": { "links": { "type": "object", @@ -25178,7 +24809,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/unit" + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/storefrontSalesChannel" } } }, @@ -25187,19 +24818,19 @@ "properties": { "type": { "type": "string", - "example": "unit" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "3e34bdebd9bd5edda27e8728904a2552" + "example": "5979d6e259ba5ec4c2b93cf79df6f2e5" } } } }, "type": "object" }, - "cover": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -25207,36 +24838,7 @@ "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" + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannel" } } }, @@ -25245,19 +24847,19 @@ "properties": { "type": { "type": "string", - "example": "product_feature_set" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "cmsPage": { + "salesChannelDomain": { "properties": { "links": { "type": "object", @@ -25265,7 +24867,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannelDomain" } } }, @@ -25274,19 +24876,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "sales_channel_domain" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "29c8b34b04e94e35e95e8346954b7fb4" } } } }, "type": "object" }, - "canonicalProduct": { + "currency": { "properties": { "links": { "type": "object", @@ -25294,7 +24896,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/currency" } } }, @@ -25303,19 +24905,179 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "023995a50b56c0de077323e958b2bbcd" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" - }, - "prices": { + } + }, + "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", @@ -25323,7 +25085,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/prices" + "example": "/product-feature-set/69d445ae065ef917cd50febab4b55db2/products" } } }, @@ -25334,19 +25096,99 @@ "properties": { "type": { "type": "string", - "example": "product_price" + "example": "product" }, "id": { "type": "string", - "example": "afae32efe0f84fece3f96b377b768b33" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - }, - "media": { + } + }, + "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", @@ -25354,61 +25196,116 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/media" + "example": "/product-keyword-dictionary/a1bc4695aa3e6f80fb42d62e6439296c/language" } } }, "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": { "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" - } + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" - }, - "crossSellingAssignedProducts": { + } + }, + "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", @@ -25416,61 +25313,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" + "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/media" } } }, "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": { "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" - } + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "visibilities": { + "products": { "properties": { "links": { "type": "object", @@ -25478,7 +25342,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/visibilities" + "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/products" } } }, @@ -25489,205 +25353,137 @@ "properties": { "type": { "type": "string", - "example": "product_visibility" + "example": "product" }, "id": { "type": "string", - "example": "63226fcdfe3316ec1237ef07a8fe6732" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "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": { + } + }, + "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", @@ -25695,92 +25491,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/options" + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/product" } } }, "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": { "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": { + "example": "product" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "streams": { + "media": { "properties": { "links": { "type": "object", @@ -25788,92 +25520,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/streams" + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" } } }, "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": { "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": { + "example": "media" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "customFieldSets": { + "coverProducts": { "properties": { "links": { "type": "object", @@ -25881,7 +25549,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/coverProducts" } } }, @@ -25892,11 +25560,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "product" }, "id": { "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" + "example": "41f7b522ee6fd2f54469cf9ec8e1c8b0" } } } @@ -25912,15 +25580,13 @@ } ] }, - "Product": { + "ProductMedia": { "description": "Added since version: 6.0.0.0", "required": [ - "taxId", - "price", - "productNumber", - "stock", - "createdAt", - "name" + "id", + "productId", + "mediaId", + "createdAt" ], "properties": { "id": { @@ -25931,546 +25597,55 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "manufacturerId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productManufacturerVersionId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "unitId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "taxId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "position": { + "type": "integer", + "format": "int64" }, - "coverId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "productMediaVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "deliveryTimeId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "featureSetId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "product": { + "$ref": "#/components/schemas/Product" }, - "canonicalProductId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "media": { + "$ref": "#/components/schemas/Media" }, - "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" - }, - "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 - } - }, - "availableStock": { - "type": "integer", - "format": "int64" - }, - "stock": { - "type": "integer", - "format": "int64" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "attendeeProductCollections": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_attendee_product_collection" - }, - "id": { - "type": "string", - "example": "0a7b3b2f4b81f36910a74f22826f35df" - } - } - } - } - }, - "type": "object" - }, - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "downloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - }, - "parent": { - "$ref": "#/components/schemas/Product" - }, - "children": { + "coverProducts": { "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": { + "ProductOption": { "description": "Added since version: 6.0.0.0", "required": [ "productId", - "categoryId" + "optionId" ], "properties": { "id": { @@ -26485,24 +25660,20 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "categoryVersionId": { + "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, - "category": { - "$ref": "#/components/schemas/Category" + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "ProductConfiguratorSettingJsonApi": { + "ProductPriceJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -26510,8 +25681,11 @@ }, { "required": [ + "id", "productId", - "optionId", + "ruleId", + "price", + "quantityStart", "createdAt" ], "properties": { @@ -26531,18 +25705,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "optionId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, - "position": { + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { "type": "integer", "format": "int64" }, @@ -26569,7 +25743,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/product" + "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" } } }, @@ -26590,7 +25764,7 @@ }, "type": "object" }, - "media": { + "rule": { "properties": { "links": { "type": "object", @@ -26598,36 +25772,7 @@ "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" + "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" } } }, @@ -26636,12 +25781,12 @@ "properties": { "type": { "type": "string", - "example": "property_group_option" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ef3e30e070f70244fd6578d88a6b77ac" + "example": "981c1e7b3795da18687613fbd66d4954" } } } @@ -26656,11 +25801,14 @@ } ] }, - "ProductConfiguratorSetting": { + "ProductPrice": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", - "optionId", + "ruleId", + "price", + "quantityStart", "createdAt" ], "properties": { @@ -26680,18 +25828,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "optionId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object" }, - "position": { + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { "type": "integer", "format": "int64" }, @@ -26711,8 +25859,37 @@ "product": { "$ref": "#/components/schemas/Product" }, - "media": { - "$ref": "#/components/schemas/Media" + "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" @@ -26720,18 +25897,20 @@ }, "type": "object" }, - "ProductCrossSellingJsonApi": { - "description": "Added since version: 6.1.0.0", + "ProductReviewJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", - "position", - "type", + "id", "productId", + "salesChannelId", + "languageId", + "title", + "content", "createdAt" ], "properties": { @@ -26739,40 +25918,50 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sortBy": { + "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" }, - "sortDirection": { + "externalEmail": { "type": "string" }, - "type": { + "title": { "type": "string" }, - "active": { - "type": "boolean" + "content": { + "type": "string" }, - "limit": { - "type": "integer", - "format": "int64" + "points": { + "type": "number", + "format": "float" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "status": { + "type": "boolean" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "comment": { + "type": "string" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -26784,9 +25973,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { "product": { @@ -26797,7 +25983,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/product" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" } } }, @@ -26818,7 +26004,7 @@ }, "type": "object" }, - "productStream": { + "customer": { "properties": { "links": { "type": "object", @@ -26826,7 +26012,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/productStream" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/customer" } } }, @@ -26835,19 +26021,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "assignedProducts": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -26855,23 +26041,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/assignedProducts" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_cross_selling_assigned_products" - }, - "id": { - "type": "string", - "example": "5da5e10eda1b7026499bcd4747d6bdf8" - } + "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" } } } @@ -26886,13 +26099,15 @@ } ] }, - "ProductCrossSelling": { - "description": "Added since version: 6.1.0.0", + "ProductReview": { + "description": "Added since version: 6.0.0.0", "required": [ - "name", - "position", - "type", + "id", "productId", + "salesChannelId", + "languageId", + "title", + "content", "createdAt" ], "properties": { @@ -26900,40 +26115,50 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sortBy": { + "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" }, - "sortDirection": { + "externalEmail": { "type": "string" }, - "type": { + "title": { "type": "string" }, - "active": { - "type": "boolean" + "content": { + "type": "string" }, - "limit": { - "type": "integer", - "format": "int64" + "points": { + "type": "number", + "format": "float" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "status": { + "type": "boolean" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "comment": { + "type": "string" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -26945,34 +26170,33 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "product": { "$ref": "#/components/schemas/Product" }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "assignedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "ProductCrossSellingAssignedProductsJsonApi": { - "description": "Added since version: 6.2.0.0", + "ProductSearchConfigJsonApi": { + "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "crossSellingId", - "productId", + "id", + "languageId", + "andLogic", + "minSearchLength", "createdAt" ], "properties": { @@ -26980,22 +26204,23 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "crossSellingId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "andLogic": { + "type": "boolean" }, - "position": { + "minSearchLength": { "type": "integer", "format": "int64" }, + "excludedTerms": { + "type": "array", + "items": { + "type": "string" + } + }, "createdAt": { "type": "string", "format": "date-time", @@ -27008,7 +26233,7 @@ }, "relationships": { "properties": { - "product": { + "language": { "properties": { "links": { "type": "object", @@ -27016,7 +26241,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/product" + "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" } } }, @@ -27025,19 +26250,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "crossSelling": { + "configFields": { "properties": { "links": { "type": "object", @@ -27045,21 +26270,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/crossSelling" + "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_cross_selling" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ef23268669fb6d8a7def2b9f2da0aceb" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config_field" + }, + "id": { + "type": "string", + "example": "5334117da647d3f2fb8a82948d56bcc3" + } } } } @@ -27074,11 +26301,13 @@ } ] }, - "ProductCrossSellingAssignedProducts": { - "description": "Added since version: 6.2.0.0", + "ProductSearchConfig": { + "description": "Added since version: 6.3.5.0", "required": [ - "crossSellingId", - "productId", + "id", + "languageId", + "andLogic", + "minSearchLength", "createdAt" ], "properties": { @@ -27086,22 +26315,23 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "crossSellingId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "andLogic": { + "type": "boolean" }, - "position": { + "minSearchLength": { "type": "integer", "format": "int64" }, + "excludedTerms": { + "type": "array", + "items": { + "type": "string" + } + }, "createdAt": { "type": "string", "format": "date-time", @@ -27112,57 +26342,32 @@ "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" + "language": { + "$ref": "#/components/schemas/Language" }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "configFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } } }, "type": "object" }, - "ProductDownloadJsonApi": { - "description": "Added since version: 6.4.19.0", + "ProductSearchConfigFieldJsonApi": { + "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "mediaId", + "id", + "searchConfigId", + "field", + "tokenize", + "searchable", + "ranking", "createdAt" ], "properties": { @@ -27170,29 +26375,27 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "searchConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "type": "string" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "tokenize": { + "type": "boolean" }, - "position": { + "searchable": { + "type": "boolean" + }, + "ranking": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -27205,7 +26408,7 @@ }, "relationships": { "properties": { - "product": { + "searchConfig": { "properties": { "links": { "type": "object", @@ -27213,7 +26416,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/product" + "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" } } }, @@ -27222,19 +26425,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "bc8281d44069ce8ffd34144fbad1bddd" } } } }, "type": "object" }, - "media": { + "customField": { "properties": { "links": { "type": "object", @@ -27242,7 +26445,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/media" + "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" } } }, @@ -27251,12 +26454,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "custom_field" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "ed2028a1c479c7e0065da597452d9c11" } } } @@ -27271,11 +26474,15 @@ } ] }, - "ProductDownload": { - "description": "Added since version: 6.4.19.0", + "ProductSearchConfigField": { + "description": "Added since version: 6.3.5.0", "required": [ - "productId", - "mediaId", + "id", + "searchConfigId", + "field", + "tokenize", + "searchable", + "ranking", "createdAt" ], "properties": { @@ -27283,28 +26490,26 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "searchConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "type": "string" }, - "position": { - "type": "integer", - "format": "int64" + "tokenize": { + "type": "boolean" }, - "customFields": { - "type": "object" + "searchable": { + "type": "boolean" + }, + "ranking": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -27316,34 +26521,28 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "searchConfig": { + "$ref": "#/components/schemas/ProductSearchConfig" }, - "media": { - "$ref": "#/components/schemas/Media" + "customField": { + "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, - "ProductExportJsonApi": { - "description": "Added since version: 6.1.0.0", + "ProductSearchKeywordJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productStreamId", - "storefrontSalesChannelId", - "salesChannelId", - "salesChannelDomainId", - "currencyId", - "fileName", - "accessKey", - "encoding", - "fileFormat", - "generateByCronjob", - "interval", + "id", + "languageId", + "productId", + "keyword", + "ranking", "createdAt" ], "properties": { @@ -27351,66 +26550,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "storefrontSalesChannelId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelDomainId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "productVersionId": { "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": { + "keyword": { "type": "string" }, - "pausedSchedule": { - "type": "boolean" - }, - "isRunning": { - "type": "boolean" + "ranking": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -27424,94 +26585,7 @@ }, "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": { + "product": { "properties": { "links": { "type": "object", @@ -27519,7 +26593,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannelDomain" + "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/product" } } }, @@ -27528,19 +26602,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "29c8b34b04e94e35e95e8346954b7fb4" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "currency": { + "language": { "properties": { "links": { "type": "object", @@ -27548,7 +26622,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/currency" + "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" } } }, @@ -27557,12 +26631,12 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -27577,20 +26651,14 @@ } ] }, - "ProductExport": { - "description": "Added since version: 6.1.0.0", + "ProductSearchKeyword": { + "description": "Added since version: 6.0.0.0", "required": [ - "productStreamId", - "storefrontSalesChannelId", - "salesChannelId", - "salesChannelDomainId", - "currencyId", - "fileName", - "accessKey", - "encoding", - "fileFormat", - "generateByCronjob", - "interval", + "id", + "languageId", + "productId", + "keyword", + "ranking", "createdAt" ], "properties": { @@ -27598,66 +26666,140 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "storefrontSalesChannelId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelDomainId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileName": { + "keyword": { "type": "string" }, - "accessKey": { - "type": "string" + "ranking": { + "type": "number", + "format": "float" }, - "encoding": { - "type": "string" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "fileFormat": { - "type": "string" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "includeVariants": { - "type": "boolean" + "product": { + "$ref": "#/components/schemas/Product" }, - "generateByCronjob": { - "type": "boolean" + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "ProductSortingJsonApi": { + "description": "Added since version: 6.3.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "generatedAt": { + { + "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", - "format": "date-time" - }, - "interval": { - "type": "integer", - "format": "int64" + "pattern": "^[0-9a-f]{32}$" }, - "headerTemplate": { - "type": "string" + "locked": { + "type": "boolean" }, - "bodyTemplate": { + "key": { "type": "string" }, - "footerTemplate": { - "type": "string" + "priority": { + "type": "integer", + "format": "int64" }, - "pausedSchedule": { + "active": { "type": "boolean" }, - "isRunning": { - "type": "boolean" + "fields": { + "type": "object" + }, + "label": { + "type": "string" }, "createdAt": { "type": "string", @@ -27669,32 +26811,21 @@ "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" + "translated": { + "type": "object" } }, "type": "object" }, - "ProductFeatureSetJsonApi": { - "description": "Added since version: 6.3.0.0", + "ProductStreamJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", "createdAt", "name" ], @@ -27703,13 +26834,21 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, "name": { "type": "string" }, "description": { "type": "string" }, - "features": { + "customFields": { "type": "object" }, "createdAt": { @@ -27727,7 +26866,7 @@ }, "relationships": { "properties": { - "products": { + "filters": { "properties": { "links": { "type": "object", @@ -27735,7 +26874,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-feature-set/69d445ae065ef917cd50febab4b55db2/products" + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/filters" } } }, @@ -27746,11 +26885,104 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_stream_filter" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "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" } } } @@ -27766,9 +26998,10 @@ } ] }, - "ProductFeatureSet": { - "description": "Added since version: 6.3.0.0", + "ProductStream": { + "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -27777,13 +27010,21 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, "name": { "type": "string" }, "description": { "type": "string" }, - "features": { + "customFields": { "type": "object" }, "createdAt": { @@ -27799,108 +27040,34 @@ "translated": { "type": "object" }, - "products": { + "filters": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductStreamFilter" } - } - }, - "type": "object" - }, - "ProductKeywordDictionaryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { - "required": [ - "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": [ - "languageId", - "keyword" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "keyword": { - "type": "string" + "productCrossSellings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } }, - "reversed": { - "type": "string" + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } }, - "language": { - "$ref": "#/components/schemas/Language" + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } } }, "type": "object" }, - "ProductManufacturerJsonApi": { + "ProductStreamFilterJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -27908,205 +27075,38 @@ }, { "required": [ - "createdAt", - "name" + "id", + "productStreamId", + "type", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "link": { + "type": { "type": "string" }, - "name": { + "field": { "type": "string" }, - "description": { + "operator": { "type": "string" }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" + "value": { + "type": "string" }, - "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" - } - }, + "parameters": { "type": "object" - } - }, - "type": "object" - } - ] - }, - "ProductManufacturer": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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", @@ -28127,7 +27127,7 @@ }, "relationships": { "properties": { - "product": { + "productStream": { "properties": { "links": { "type": "object", @@ -28135,7 +27135,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/product" + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/productStream" } } }, @@ -28144,19 +27144,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, - "media": { + "parent": { "properties": { "links": { "type": "object", @@ -28164,7 +27164,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/parent" } } }, @@ -28173,19 +27173,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "product_stream_filter" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "coverProducts": { + "queries": { "properties": { "links": { "type": "object", @@ -28193,7 +27193,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/coverProducts" + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/queries" } } }, @@ -28204,11 +27204,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_stream_filter" }, "id": { "type": "string", - "example": "41f7b522ee6fd2f54469cf9ec8e1c8b0" + "example": "5da7eb4247add5dbd5776c9c0b38460a" } } } @@ -28224,11 +27224,12 @@ } ] }, - "ProductMedia": { + "ProductStreamFilter": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "mediaId", + "id", + "productStreamId", + "type", "createdAt" ], "properties": { @@ -28236,21 +27237,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" }, "position": { "type": "integer", @@ -28269,26 +27277,58 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "productStream": { + "$ref": "#/components/schemas/ProductStream" }, - "media": { - "$ref": "#/components/schemas/Media" + "parent": { + "$ref": "#/components/schemas/ProductStreamFilter" }, - "coverProducts": { + "queries": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductStreamFilter" } } }, "type": "object" }, - "ProductOption": { + "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", - "optionId" + "tagId" ], "properties": { "id": { @@ -28303,20 +27343,20 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "optionId": { + "tagId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "ProductPriceJsonApi": { + "ProductVisibilityJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -28324,10 +27364,10 @@ }, { "required": [ + "id", "productId", - "ruleId", - "price", - "quantityStart", + "salesChannelId", + "visibility", "createdAt" ], "properties": { @@ -28335,10 +27375,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -28347,24 +27383,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "object" - }, - "quantityStart": { - "type": "integer", - "format": "int64" - }, - "quantityEnd": { + "visibility": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -28377,7 +27403,7 @@ }, "relationships": { "properties": { - "product": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -28385,7 +27411,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" + "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" } } }, @@ -28394,19 +27420,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "rule": { + "product": { "properties": { "links": { "type": "object", @@ -28414,7 +27440,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" + "example": "/product-visibility/e965d09420555f52df9b20f904697d96/product" } } }, @@ -28423,12 +27449,12 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -28443,13 +27469,13 @@ } ] }, - "ProductPrice": { + "ProductVisibility": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "productId", - "ruleId", - "price", - "quantityStart", + "salesChannelId", + "visibility", "createdAt" ], "properties": { @@ -28457,10 +27483,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -28469,24 +27491,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "object" - }, - "quantityStart": { - "type": "integer", - "format": "int64" - }, - "quantityEnd": { + "visibility": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -28497,48 +27509,16 @@ "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}$" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, "product": { "$ref": "#/components/schemas/Product" - }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "ProductReviewJsonApi": { + "PromotionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -28546,60 +27526,88 @@ }, { "required": [ - "productId", - "salesChannelId", - "languageId", - "title", - "content", - "createdAt" + "id", + "active", + "priority", + "exclusive", + "useCodes", + "useIndividualCodes", + "useSetGroups", + "preventCombination", + "createdAt", + "name" ], "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}$" + "name": { + "type": "string" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "salesChannelId": { + "validFrom": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "languageId": { + "validUntil": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "externalUser": { - "type": "string" + "maxRedemptionsGlobal": { + "type": "integer", + "format": "int64" }, - "externalEmail": { - "type": "string" + "maxRedemptionsPerCustomer": { + "type": "integer", + "format": "int64" }, - "title": { - "type": "string" + "priority": { + "type": "integer", + "format": "int64" }, - "content": { + "exclusive": { + "type": "boolean" + }, + "code": { "type": "string" }, - "points": { - "type": "number", - "format": "float" + "useCodes": { + "type": "boolean" }, - "status": { + "useIndividualCodes": { "type": "boolean" }, - "comment": { + "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" }, @@ -28613,9 +27621,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "product": { + "setgroups": { "properties": { "links": { "type": "object", @@ -28623,28 +27634,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" + "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": { - "type": { - "type": "string", - "example": "product" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "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" }, - "customer": { + "discounts": { "properties": { "links": { "type": "object", @@ -28652,28 +27696,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review/0793b857a73beced20090eec19b11a3d/customer" + "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": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "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" }, - "salesChannel": { + "personaRules": { "properties": { "links": { "type": "object", @@ -28681,28 +27758,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review/0793b857a73beced20090eec19b11a3d/salesChannel" + "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": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" }, - "language": { + "orderRules": { "properties": { "links": { "type": "object", @@ -28710,21 +27820,85 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review/0793b857a73beced20090eec19b11a3d/language" + "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": { - "type": { + "related": { "type": "string", - "example": "language" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "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" + } } } } @@ -28739,63 +27913,91 @@ } ] }, - "ProductReview": { + "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "salesChannelId", - "languageId", - "title", - "content", - "createdAt" + "id", + "active", + "priority", + "exclusive", + "useCodes", + "useIndividualCodes", + "useSetGroups", + "preventCombination", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "customerId": { + "validFrom": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "salesChannelId": { + "validUntil": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "maxRedemptionsGlobal": { + "type": "integer", + "format": "int64" }, - "externalUser": { - "type": "string" + "maxRedemptionsPerCustomer": { + "type": "integer", + "format": "int64" }, - "externalEmail": { - "type": "string" + "priority": { + "type": "integer", + "format": "int64" }, - "title": { - "type": "string" + "exclusive": { + "type": "boolean" }, - "content": { + "code": { "type": "string" }, - "points": { - "type": "number", - "format": "float" + "useCodes": { + "type": "boolean" }, - "status": { + "useIndividualCodes": { "type": "boolean" }, - "comment": { + "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" }, @@ -28809,32 +28011,108 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "translated": { + "type": "object" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "setgroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } }, - "language": { - "$ref": "#/components/schemas/Language" + "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" }, - "ProductSearchConfigJsonApi": { - "description": "Added since version: 6.3.5.0", + "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": [ - "languageId", - "andLogic", - "minSearchLength", + "id", + "promotionId", + "scope", + "type", + "value", + "considerAdvancedRules", "createdAt" ], "properties": { @@ -28842,22 +28120,38 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "andLogic": { - "type": "boolean" + "scope": { + "type": "string" }, - "minSearchLength": { - "type": "integer", - "format": "int64" + "type": { + "type": "string" }, - "excludedTerms": { - "type": "array", - "items": { - "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", @@ -28871,7 +28165,7 @@ }, "relationships": { "properties": { - "language": { + "promotion": { "properties": { "links": { "type": "object", @@ -28879,7 +28173,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" + "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotion" } } }, @@ -28888,19 +28182,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "configFields": { + "discountRules": { "properties": { "links": { "type": "object", @@ -28908,7 +28202,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" + "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/discountRules" } } }, @@ -28919,11 +28213,42 @@ "properties": { "type": { "type": "string", - "example": "product_search_config_field" + "example": "rule" }, "id": { "type": "string", - "example": "5334117da647d3f2fb8a82948d56bcc3" + "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" } } } @@ -28939,12 +28264,15 @@ } ] }, - "ProductSearchConfig": { - "description": "Added since version: 6.3.5.0", + "PromotionDiscount": { + "description": "Added since version: 6.0.0.0", "required": [ - "languageId", - "andLogic", - "minSearchLength", + "id", + "promotionId", + "scope", + "type", + "value", + "considerAdvancedRules", "createdAt" ], "properties": { @@ -28952,22 +28280,38 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "andLogic": { + "scope": { + "type": "string" + }, + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + }, + "considerAdvancedRules": { "type": "boolean" }, - "minSearchLength": { - "type": "integer", - "format": "int64" + "maxValue": { + "type": "number", + "format": "float" }, - "excludedTerms": { - "type": "array", - "items": { - "type": "string" - } + "sorterKey": { + "type": "string" + }, + "applierKey": { + "type": "string" + }, + "usageKey": { + "type": "string" + }, + "pickerKey": { + "type": "string" }, "createdAt": { "type": "string", @@ -28979,31 +28323,36 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "configFields": { + "discountRules": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/Rule" + } + }, + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" } } }, "type": "object" }, - "ProductSearchConfigFieldJsonApi": { - "description": "Added since version: 6.3.5.0", + "PromotionDiscountPricesJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", + "id", + "discountId", + "currencyId", + "price", "createdAt" ], "properties": { @@ -29011,26 +28360,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "searchConfigId": { + "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "field": { - "type": "string" - }, - "tokenize": { - "type": "boolean" - }, - "searchable": { - "type": "boolean" - }, - "ranking": { - "type": "integer", - "format": "int64" + "price": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -29044,7 +28384,7 @@ }, "relationships": { "properties": { - "searchConfig": { + "promotionDiscount": { "properties": { "links": { "type": "object", @@ -29052,7 +28392,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" + "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" } } }, @@ -29061,19 +28401,19 @@ "properties": { "type": { "type": "string", - "example": "product_search_config" + "example": "promotion_discount" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "bc8281d44069ce8ffd34144fbad1bddd" + "example": "eaeedb5c09dfc7dbf130657ed44ef33f" } } } }, "type": "object" }, - "customField": { + "currency": { "properties": { "links": { "type": "object", @@ -29081,7 +28421,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" + "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" } } }, @@ -29090,12 +28430,12 @@ "properties": { "type": { "type": "string", - "example": "custom_field" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ed2028a1c479c7e0065da597452d9c11" + "example": "1af0389838508d7016a9841eb6273962" } } } @@ -29110,14 +28450,13 @@ } ] }, - "ProductSearchConfigField": { - "description": "Added since version: 6.3.5.0", + "PromotionDiscountPrices": { + "description": "Added since version: 6.0.0.0", "required": [ - "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", + "id", + "discountId", + "currencyId", + "price", "createdAt" ], "properties": { @@ -29125,26 +28464,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "searchConfigId": { + "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "field": { - "type": "string" - }, - "tokenize": { - "type": "boolean" - }, - "searchable": { - "type": "boolean" - }, - "ranking": { - "type": "integer", - "format": "int64" + "price": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -29156,16 +28486,44 @@ "format": "date-time", "readOnly": true }, - "searchConfig": { - "$ref": "#/components/schemas/ProductSearchConfig" + "promotionDiscount": { + "$ref": "#/components/schemas/PromotionDiscount" }, - "customField": { - "$ref": "#/components/schemas/CustomField" + "currency": { + "$ref": "#/components/schemas/Currency" } }, "type": "object" }, - "ProductSearchKeywordJsonApi": { + "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": [ { @@ -29173,10 +28531,9 @@ }, { "required": [ - "languageId", - "productId", - "keyword", - "ranking", + "id", + "promotionId", + "code", "createdAt" ], "properties": { @@ -29184,28 +28541,15 @@ "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": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "keyword": { + "code": { "type": "string" }, - "ranking": { - "type": "number", - "format": "float" + "payload": { + "type": "object" }, "createdAt": { "type": "string", @@ -29219,36 +28563,7 @@ }, "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": { + "promotion": { "properties": { "links": { "type": "object", @@ -29256,7 +28571,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" + "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" } } }, @@ -29265,12 +28580,12 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } @@ -29285,13 +28600,12 @@ } ] }, - "ProductSearchKeyword": { + "PromotionIndividualCode": { "description": "Added since version: 6.0.0.0", "required": [ - "languageId", - "productId", - "keyword", - "ranking", + "id", + "promotionId", + "code", "createdAt" ], "properties": { @@ -29299,28 +28613,15 @@ "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": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "keyword": { + "code": { "type": "string" }, - "ranking": { - "type": "number", - "format": "float" + "payload": { + "type": "object" }, "createdAt": { "type": "string", @@ -29332,123 +28633,97 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "language": { - "$ref": "#/components/schemas/Language" + "promotion": { + "$ref": "#/components/schemas/Promotion" } }, "type": "object" }, - "ProductSortingJsonApi": { - "description": "Added since version: 6.3.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "PromotionOrderRule": { + "description": "Added since version: 6.0.0.0", + "required": [ + "promotionId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "required": [ - "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" + "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" }, - "ProductSorting": { - "description": "Added since version: 6.3.2.0", + "PromotionPersonaCustomer": { + "description": "Added since version: 6.0.0.0", "required": [ - "key", - "priority", - "active", - "fields", - "createdAt", - "label" + "promotionId", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "locked": { - "type": "boolean" - }, - "key": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int64" + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "fields": { - "type": "object" + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "label": { - "type": "string" + "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}$" }, - "createdAt": { + "promotionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "ruleId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "rule": { + "$ref": "#/components/schemas/Rule" } }, "type": "object" }, - "ProductStreamJsonApi": { + "PromotionSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -29456,30 +28731,28 @@ }, { "required": [ - "createdAt", - "name" + "id", + "promotionId", + "salesChannelId", + "priority", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "apiFilter": { - "type": "object", - "readOnly": true + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "invalid": { - "type": "boolean", - "readOnly": true - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "priority": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -29491,48 +28764,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { - "filters": { + "promotion": { "properties": { "links": { "type": "object", @@ -29540,61 +28774,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/filters" + "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" } } }, "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": { "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" - } + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "productExports": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -29602,54 +28803,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productExports" + "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/salesChannel" } } }, "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": { "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" - } + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -29664,33 +28832,31 @@ } ] }, - "ProductStream": { + "PromotionSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", - "name" + "id", + "promotionId", + "salesChannelId", + "priority", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "apiFilter": { - "type": "object", - "readOnly": true - }, - "invalid": { - "type": "boolean", - "readOnly": true - }, - "name": { - "type": "string" + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "priority": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -29702,73 +28868,16 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "presentationCmsPages": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation_cms_page" - }, - "id": { - "type": "string", - "example": "30c725082807b69914fddd7e82d0d741" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - }, - "productCrossSellings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - }, - "productExports": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "ProductStreamFilterJsonApi": { + "PromotionSetgroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -29776,8 +28885,11 @@ }, { "required": [ - "productStreamId", - "type", + "id", + "promotionId", + "packagerKey", + "sorterKey", + "value", "createdAt" ], "properties": { @@ -29785,35 +28897,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "type": "string" - }, - "field": { + "packagerKey": { "type": "string" }, - "operator": { + "sorterKey": { "type": "string" }, "value": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -29827,36 +28923,7 @@ }, "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": { + "promotion": { "properties": { "links": { "type": "object", @@ -29864,7 +28931,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/parent" + "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" } } }, @@ -29873,19 +28940,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream_filter" + "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "queries": { + "setGroupRules": { "properties": { "links": { "type": "object", @@ -29893,7 +28960,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/queries" + "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" } } }, @@ -29904,11 +28971,11 @@ "properties": { "type": { "type": "string", - "example": "product_stream_filter" + "example": "rule" }, "id": { "type": "string", - "example": "5da7eb4247add5dbd5776c9c0b38460a" + "example": "a54c38d5a1d9180d689d11234afbbb32" } } } @@ -29924,11 +28991,14 @@ } ] }, - "ProductStreamFilter": { + "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", "required": [ - "productStreamId", - "type", + "id", + "promotionId", + "packagerKey", + "sorterKey", + "value", "createdAt" ], "properties": { @@ -29936,35 +29006,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "type": "string" - }, - "field": { + "packagerKey": { "type": "string" }, - "operator": { + "sorterKey": { "type": "string" }, "value": { - "type": "string" - }, - "parameters": { - "type": "object" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "customFields": { - "type": "object" + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -29976,86 +29030,47 @@ "format": "date-time", "readOnly": true }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" - }, - "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "queries": { + "setGroupRules": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/Rule" } } }, "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": { + "PromotionSetgroupRule": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "tagId" + "setgroupId", + "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "setgroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "product": { - "$ref": "#/components/schemas/Product" + "setgroup": { + "$ref": "#/components/schemas/PromotionSetgroup" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "rule": { + "$ref": "#/components/schemas/Rule" } }, "type": "object" }, - "ProductVisibilityJsonApi": { + "PropertyGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -30063,32 +29078,42 @@ }, { "required": [ - "productId", - "salesChannelId", - "visibility", - "createdAt" + "id", + "displayType", + "sortingType", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "displayType": { + "type": "string" }, - "visibility": { + "sortingType": { + "type": "string" + }, + "filterable": { + "type": "boolean" + }, + "visibleOnProductDetailPage": { + "type": "boolean" + }, + "position": { "type": "integer", "format": "int64" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -30099,9 +29124,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "salesChannel": { + "options": { "properties": { "links": { "type": "object", @@ -30109,50 +29137,297 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" + "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "93da65a9fd0004d9477aeac024e08e15" + } } } } }, "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" - }, + } + }, + "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": "f5bf48aa40cad7891eb709fcf1fde128" + "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" + } } } } @@ -30167,34 +29442,39 @@ } ] }, - "ProductVisibility": { + "PropertyGroupOption": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "salesChannelId", - "visibility", - "createdAt" + "id", + "groupId", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "salesChannelId": { + "position": { + "type": "integer", + "format": "int64" + }, + "colorHexCode": { + "type": "string" + }, + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "visibility": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -30206,16 +29486,37 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "translated": { + "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "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" }, - "PromotionJsonApi": { + "RuleJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -30223,15 +29524,10 @@ }, { "required": [ - "active", + "id", + "name", "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", - "name" + "createdAt" ], "properties": { "id": { @@ -30241,72 +29537,31 @@ "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": { + "description": { "type": "string" }, - "useSetGroups": { - "type": "boolean" - }, - "customerRestriction": { - "type": "boolean" - }, - "preventCombination": { - "type": "boolean" - }, - "orderCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "ordersPerCustomerCount": { - "type": "object", + "invalid": { + "type": "boolean", "readOnly": true }, - "exclusionIds": { + "areas": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "type": "object", + "additionalProperties": false + }, + "readOnly": true }, "customFields": { "type": "object" }, + "moduleTypes": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -30317,12 +29572,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "setgroups": { + "conditions": { "properties": { "links": { "type": "object", @@ -30330,7 +29582,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/setgroups" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/conditions" } } }, @@ -30341,11 +29593,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_setgroup" + "example": "rule_condition" }, "id": { "type": "string", - "example": "3c963571517f44e87274198cb8bb62a8" + "example": "b5b399ec1fcfe753f58dbafa197efdc1" } } } @@ -30353,7 +29605,7 @@ }, "type": "object" }, - "salesChannels": { + "productPrices": { "properties": { "links": { "type": "object", @@ -30361,7 +29613,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/salesChannels" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/productPrices" } } }, @@ -30372,11 +29624,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_sales_channel" + "example": "product_price" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "186169119da6d813def53830287d0b9a" } } } @@ -30384,7 +29636,7 @@ }, "type": "object" }, - "discounts": { + "shippingMethodPrices": { "properties": { "links": { "type": "object", @@ -30392,7 +29644,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/discounts" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPrices" } } }, @@ -30403,11 +29655,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount" + "example": "shipping_method_price" }, "id": { "type": "string", - "example": "9544fa2fae515081e7fc27ef2d268642" + "example": "3702bcc7b41585828b44acbbdcd83b23" } } } @@ -30415,7 +29667,7 @@ }, "type": "object" }, - "individualCodes": { + "shippingMethodPriceCalculations": { "properties": { "links": { "type": "object", @@ -30423,7 +29675,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/individualCodes" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPriceCalculations" } } }, @@ -30434,11 +29686,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_individual_code" + "example": "shipping_method_price" }, "id": { "type": "string", - "example": "c777247035736c9eae54f8e5dfdcd2aa" + "example": "b8ea8aac272229a90f9a6cb1fcada8d1" } } } @@ -30446,7 +29698,7 @@ }, "type": "object" }, - "personaRules": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -30454,7 +29706,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaRules" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" } } }, @@ -30465,11 +29717,11 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "shipping_method" }, "id": { "type": "string", - "example": "382af96335a79de564c412e6b493d7f3" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -30477,7 +29729,7 @@ }, "type": "object" }, - "personaCustomers": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -30485,7 +29737,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaCustomers" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/paymentMethods" } } }, @@ -30496,11 +29748,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "payment_method" }, "id": { "type": "string", - "example": "b969a9b0d5772d70ea83383c1be06c82" + "example": "b631b1ab565525e892f9cdc1242cca14" } } } @@ -30508,7 +29760,7 @@ }, "type": "object" }, - "orderRules": { + "personaPromotions": { "properties": { "links": { "type": "object", @@ -30516,7 +29768,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderRules" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/personaPromotions" } } }, @@ -30527,11 +29779,11 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "promotion" }, "id": { "type": "string", - "example": "ee517f71bf240d98dcf33db6e6ffa881" + "example": "e6c8f116c04f26f18410d2d0dbd677db" } } } @@ -30539,7 +29791,7 @@ }, "type": "object" }, - "cartRules": { + "flowSequences": { "properties": { "links": { "type": "object", @@ -30547,7 +29799,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/cartRules" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/flowSequences" } } }, @@ -30558,11 +29810,11 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "6549606ef529fde0a7628b4c0aa7c6ef" + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } @@ -30570,7 +29822,7 @@ }, "type": "object" }, - "orderLineItems": { + "taxProviders": { "properties": { "links": { "type": "object", @@ -30578,7 +29830,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderLineItems" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/taxProviders" } } }, @@ -30589,113 +29841,222 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "tax_provider" }, "id": { "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + "example": "01a1a9d428b6402dc8255d99c787a00e" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Promotion": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": { + }, + "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", - "format": "date-time" - }, - "maxRedemptionsGlobal": { - "type": "integer", - "format": "int64" + "pattern": "^[0-9a-f]{32}$" }, - "maxRedemptionsPerCustomer": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, "priority": { "type": "integer", "format": "int64" }, - "exclusive": { - "type": "boolean" - }, - "code": { - "type": "string" - }, - "useCodes": { - "type": "boolean" - }, - "useIndividualCodes": { - "type": "boolean" - }, - "individualCodePattern": { + "description": { "type": "string" }, - "useSetGroups": { - "type": "boolean" - }, - "customerRestriction": { - "type": "boolean" - }, - "preventCombination": { - "type": "boolean" - }, - "orderCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "ordersPerCustomerCount": { - "type": "object", + "invalid": { + "type": "boolean", "readOnly": true }, - "exclusionIds": { + "areas": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "type": "object", + "additionalProperties": false + }, + "readOnly": true }, "customFields": { "type": "object" }, + "moduleTypes": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -30706,95 +30067,94 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "conditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } }, - "setgroups": { + "productPrices": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/ProductPrice" } }, - "salesChannels": { + "shippingMethodPrices": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/ShippingMethodPrice" } }, - "discounts": { + "shippingMethodPriceCalculations": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ShippingMethodPrice" } }, - "individualCodes": { + "shippingMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/ShippingMethod" } }, - "personaRules": { + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PaymentMethod" } }, - "personaCustomers": { + "personaPromotions": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/Promotion" } }, - "orderRules": { + "flowSequences": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/FlowSequence" } }, - "cartRules": { + "taxProviders": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/TaxProvider" } }, - "orderLineItems": { + "tags": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/Tag" } - } - }, - "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}$" + "orderPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "cartPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } }, - "promotion": { - "$ref": "#/components/schemas/Promotion" + "promotionDiscounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } }, - "rule": { - "$ref": "#/components/schemas/Rule" + "promotionSetGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } } }, "type": "object" }, - "PromotionDiscountJsonApi": { + "RuleConditionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -30802,11 +30162,9 @@ }, { "required": [ - "promotionId", - "scope", + "id", "type", - "value", - "considerAdvancedRules", + "ruleId", "createdAt" ], "properties": { @@ -30814,38 +30172,30 @@ "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" + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "maxValue": { - "type": "number", - "format": "float" + "scriptId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sorterKey": { - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "applierKey": { - "type": "string" + "value": { + "type": "object" }, - "usageKey": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, - "pickerKey": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -30859,7 +30209,7 @@ }, "relationships": { "properties": { - "promotion": { + "rule": { "properties": { "links": { "type": "object", @@ -30867,7 +30217,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotion" + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" } } }, @@ -30876,19 +30226,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, - "discountRules": { + "appScriptCondition": { "properties": { "links": { "type": "object", @@ -30896,30 +30246,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/discountRules" + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/appScriptCondition" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "example": "d5a1e52263eb12172f7657376d7622c8" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_script_condition" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d84ccced9bafd192ec0c6b5a8a49bc07" } } } }, "type": "object" }, - "promotionDiscountPrices": { + "parent": { "properties": { "links": { "type": "object", @@ -30927,7 +30275,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotionDiscountPrices" + "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" } } }, @@ -30938,11 +30315,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount_prices" + "example": "rule_condition" }, "id": { "type": "string", - "example": "325723473ecab76b0f45e1554513f779" + "example": "268184c12df027f536154d099d497b31" } } } @@ -30958,14 +30335,12 @@ } ] }, - "PromotionDiscount": { + "RuleCondition": { "description": "Added since version: 6.0.0.0", "required": [ - "promotionId", - "scope", + "id", "type", - "value", - "considerAdvancedRules", + "ruleId", "createdAt" ], "properties": { @@ -30973,38 +30348,30 @@ "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" + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "maxValue": { - "type": "number", - "format": "float" + "scriptId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sorterKey": { - "type": "string" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "applierKey": { - "type": "string" + "value": { + "type": "object" }, - "usageKey": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, - "pickerKey": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -31016,43 +30383,88 @@ "format": "date-time", "readOnly": true }, - "promotion": { - "$ref": "#/components/schemas/Promotion" + "rule": { + "$ref": "#/components/schemas/Rule" }, - "discountRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" - } + "appScriptCondition": { + "$ref": "#/components/schemas/AppScriptCondition" }, - "promotionDiscountPrices": { + "parent": { + "$ref": "#/components/schemas/RuleCondition" + }, + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/RuleCondition" } } }, "type": "object" }, - "PromotionDiscountPricesJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "discountId", - "currencyId", - "price", - "createdAt" - ], - "properties": { + "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}$" }, - "discountId": { + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31060,9 +30472,125 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number", - "format": "float" + "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", @@ -31074,9 +30602,48 @@ "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": { - "promotionDiscount": { + "currencies": { "properties": { "links": { "type": "object", @@ -31084,28 +30651,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" + "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": { - "type": { + "related": { "type": "string", - "example": "promotion_discount" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "eaeedb5c09dfc7dbf130657ed44ef33f" + "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" }, - "currency": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -31113,7 +30744,69 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" + "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" } } }, @@ -31122,138 +30815,19 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "sales_channel_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionDiscountPrices": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "language": { "properties": { "links": { "type": "object", @@ -31261,7 +30835,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/language" } } }, @@ -31270,191 +30844,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionIndividualCode": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "customerGroup": { "properties": { "links": { "type": "object", @@ -31462,7 +30864,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroup" } } }, @@ -31471,19 +30873,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, - "salesChannel": { + "currency": { "properties": { "links": { "type": "object", @@ -31491,7 +30893,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/salesChannel" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currency" } } }, @@ -31500,116 +30902,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "paymentMethod": { "properties": { "links": { "type": "object", @@ -31617,7 +30922,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethod" } } }, @@ -31626,19 +30931,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, - "setGroupRules": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -31646,7 +30951,65 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" + "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" } } }, @@ -31657,163 +31020,19 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "order" }, "id": { "type": "string", - "example": "a54c38d5a1d9180d689d11234afbbb32" + "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionSetgroup": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "customers": { "properties": { "links": { "type": "object", @@ -31821,7 +31040,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customers" } } }, @@ -31832,140 +31051,19 @@ "properties": { "type": { "type": "string", - "example": "property_group_option" + "example": "customer" }, "id": { "type": "string", - "example": "93da65a9fd0004d9477aeac024e08e15" + "example": "4b6f7d34a58ba399f077685951d06738" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PropertyGroup": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "homeCmsPage": { "properties": { "links": { "type": "object", @@ -31973,7 +31071,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/media" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/homeCmsPage" } } }, @@ -31982,19 +31080,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "00bba78f79ca4792a3162942ac65c768" } } } }, "type": "object" }, - "group": { + "domains": { "properties": { "links": { "type": "object", @@ -32002,28 +31100,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/group" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/domains" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "e4e46deb7f9cc58c7abfb32e5570b6f3" + } } } } }, "type": "object" }, - "productConfiguratorSettings": { + "systemConfigs": { "properties": { "links": { "type": "object", @@ -32031,7 +31131,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productConfiguratorSettings" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/systemConfigs" } } }, @@ -32042,11 +31142,11 @@ "properties": { "type": { "type": "string", - "example": "product_configurator_setting" + "example": "system_config" }, "id": { "type": "string", - "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + "example": "dbcfb7a885e393eeb296543d06485547" } } } @@ -32054,7 +31154,7 @@ }, "type": "object" }, - "productProperties": { + "navigationCategory": { "properties": { "links": { "type": "object", @@ -32062,30 +31162,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productProperties" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/navigationCategory" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "bacd76b9cbbc26cb9854ec57f4d0fef3" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2194fe03b676158bb7a3a03f1b98b80e" } } } }, "type": "object" }, - "productOptions": { + "footerCategory": { "properties": { "links": { "type": "object", @@ -32093,168 +31191,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productOptions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/footerCategory" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "2e96cc7eba692416e31a6af3230ebf88" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a609a222a2767cf322ee21d72a0ddb3e" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PropertyGroupOption": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "serviceCategory": { "properties": { "links": { "type": "object", @@ -32262,30 +31220,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/conditions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/serviceCategory" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule_condition" - }, - "id": { - "type": "string", - "example": "b5b399ec1fcfe753f58dbafa197efdc1" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bc70a595d052072b5d94cffea6d8d5bb" } } } }, "type": "object" }, - "productPrices": { + "productVisibilities": { "properties": { "links": { "type": "object", @@ -32293,7 +31249,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/productPrices" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productVisibilities" } } }, @@ -32304,11 +31260,11 @@ "properties": { "type": { "type": "string", - "example": "product_price" + "example": "product_visibility" }, "id": { "type": "string", - "example": "186169119da6d813def53830287d0b9a" + "example": "a3534dc8df51f93286fcf577a5f8b153" } } } @@ -32316,7 +31272,7 @@ }, "type": "object" }, - "shippingMethodPrices": { + "hreflangDefaultDomain": { "properties": { "links": { "type": "object", @@ -32324,30 +31280,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPrices" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/hreflangDefaultDomain" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method_price" - }, - "id": { - "type": "string", - "example": "3702bcc7b41585828b44acbbdcd83b23" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7e80830860b9b8e5b8fc8d67262680b5" } } } }, "type": "object" }, - "shippingMethodPriceCalculations": { + "mailHeaderFooter": { "properties": { "links": { "type": "object", @@ -32355,30 +31309,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPriceCalculations" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mailHeaderFooter" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method_price" - }, - "id": { - "type": "string", - "example": "b8ea8aac272229a90f9a6cb1fcada8d1" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_header_footer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a21fbb0e023f5e68d5be77b969e1eb09" } } } }, "type": "object" }, - "shippingMethods": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -32386,7 +31338,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/newsletterRecipients" } } }, @@ -32397,11 +31349,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "newsletter_recipient" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "2217f01dc5cddfd5b60387c39867f58e" } } } @@ -32409,7 +31361,7 @@ }, "type": "object" }, - "paymentMethods": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -32417,7 +31369,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/paymentMethods" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/numberRangeSalesChannels" } } }, @@ -32428,11 +31380,11 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "number_range_sales_channel" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "62db021f1d56ae4688775365be68a04f" } } } @@ -32440,7 +31392,7 @@ }, "type": "object" }, - "personaPromotions": { + "promotionSalesChannels": { "properties": { "links": { "type": "object", @@ -32448,7 +31400,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/personaPromotions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/promotionSalesChannels" } } }, @@ -32459,11 +31411,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "promotion_sales_channel" }, "id": { "type": "string", - "example": "e6c8f116c04f26f18410d2d0dbd677db" + "example": "ede6dfd9f261361e1f3ada8c5385d064" } } } @@ -32471,7 +31423,7 @@ }, "type": "object" }, - "flowSequences": { + "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", @@ -32479,7 +31431,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/flowSequences" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/documentBaseConfigSalesChannels" } } }, @@ -32490,11 +31442,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "document_base_config_sales_channel" }, "id": { "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + "example": "9c990fde5b38ff70fc1a07bf84c12a17" } } } @@ -32502,7 +31454,7 @@ }, "type": "object" }, - "taxProviders": { + "productReviews": { "properties": { "links": { "type": "object", @@ -32510,7 +31462,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/taxProviders" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviews" } } }, @@ -32521,11 +31473,11 @@ "properties": { "type": { "type": "string", - "example": "tax_provider" + "example": "product_review" }, "id": { "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" + "example": "01e78541ea343ed72424a5222796a4cd" } } } @@ -32533,7 +31485,7 @@ }, "type": "object" }, - "tags": { + "seoUrls": { "properties": { "links": { "type": "object", @@ -32541,7 +31493,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/tags" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrls" } } }, @@ -32552,11 +31504,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "seo_url" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } @@ -32564,7 +31516,7 @@ }, "type": "object" }, - "orderPromotions": { + "seoUrlTemplates": { "properties": { "links": { "type": "object", @@ -32572,7 +31524,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/orderPromotions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrlTemplates" } } }, @@ -32583,11 +31535,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "seo_url_template" }, "id": { "type": "string", - "example": "82dea0f7981e729cd7f6303cc8a1c499" + "example": "02cde325fef3e680f529875e8abd60bb" } } } @@ -32595,7 +31547,7 @@ }, "type": "object" }, - "cartPromotions": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -32603,7 +31555,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/cartPromotions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mainCategories" } } }, @@ -32614,11 +31566,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "main_category" }, "id": { "type": "string", - "example": "2ce52c5be33293c67fb55f29fa4046a7" + "example": "1fb731fc4139cbb575429e28846f0c39" } } } @@ -32626,7 +31578,7 @@ }, "type": "object" }, - "promotionDiscounts": { + "productExports": { "properties": { "links": { "type": "object", @@ -32634,7 +31586,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionDiscounts" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" } } }, @@ -32645,11 +31597,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount" + "example": "product_export" }, "id": { "type": "string", - "example": "3ddb3f7d5ec4f032dc51f294409b68f9" + "example": "2cd8793787cda582174c0fc329fbc377" } } } @@ -32657,7 +31609,7 @@ }, "type": "object" }, - "promotionSetGroups": { + "analytics": { "properties": { "links": { "type": "object", @@ -32665,7 +31617,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionSetGroups" + "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" } } }, @@ -32676,11 +31657,104 @@ "properties": { "type": { "type": "string", - "example": "promotion_setgroup" + "example": "customer_group" }, "id": { "type": "string", - "example": "b71b82231d40fdedf42133c0e71384f8" + "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" } } } @@ -32696,46 +31770,164 @@ } ] }, - "Rule": { + "SalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "typeId", + "languageId", + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "accessKey", + "createdAt", "name", - "priority", - "createdAt" + "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "priority": { + "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" }, - "description": { + "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" }, - "invalid": { - "type": "boolean", - "readOnly": true + "shortName": { + "type": "string" }, - "areas": { + "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 - }, - "readOnly": true + } }, "customFields": { "type": "object" }, - "moduleTypes": { + "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", @@ -32746,28 +31938,67 @@ "format": "date-time", "readOnly": true }, - "conditions": { + "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/RuleCondition" + "$ref": "#/components/schemas/Currency" } }, - "productPrices": { + "languages": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/Language" } }, - "shippingMethodPrices": { + "countries": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Country" } }, - "shippingMethodPriceCalculations": { + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/PaymentMethod" } }, "shippingMethods": { @@ -32776,73 +32007,168 @@ "$ref": "#/components/schemas/ShippingMethod" } }, - "paymentMethods": { + "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/PaymentMethod" + "$ref": "#/components/schemas/Order" } }, - "personaPromotions": { + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/Customer" } }, - "flowSequences": { + "homeCmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "domains": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/SalesChannelDomain" } }, - "taxProviders": { + "systemConfigs": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/SystemConfig" } }, - "tags": { + "navigationCategory": { + "$ref": "#/components/schemas/Category" + }, + "footerCategory": { + "$ref": "#/components/schemas/Category" + }, + "serviceCategory": { + "$ref": "#/components/schemas/Category" + }, + "productVisibilities": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/ProductVisibility" } }, - "orderPromotions": { + "hreflangDefaultDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" + }, + "mailHeaderFooter": { + "$ref": "#/components/schemas/MailHeaderFooter" + }, + "newsletterRecipients": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/NewsletterRecipient" } }, - "cartPromotions": { + "numberRangeSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } }, - "promotionDiscounts": { + "promotionSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/PromotionSalesChannel" } }, - "promotionSetGroups": { + "documentBaseConfigSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$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" }, - "RuleConditionJsonApi": { - "description": "Added since version: 6.0.0.0", + "SalesChannelAnalyticsJsonApi": { + "description": "Added since version: 6.2.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "type", - "ruleId", + "id", "createdAt" ], "properties": { @@ -32850,30 +32176,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "trackingId": { "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" + "active": { + "type": "boolean" }, - "position": { - "type": "integer", - "format": "int64" + "trackOrders": { + "type": "boolean" }, - "customFields": { - "type": "object" + "anonymizeIp": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -32887,7 +32200,7 @@ }, "relationships": { "properties": { - "rule": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -32895,7 +32208,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" + "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/salesChannel" } } }, @@ -32904,101 +32217,12 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "sales_channel" }, "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" - } + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -33013,11 +32237,10 @@ } ] }, - "RuleCondition": { - "description": "Added since version: 6.0.0.0", + "SalesChannelAnalytics": { + "description": "Added since version: 6.2.0.0", "required": [ - "type", - "ruleId", + "id", "createdAt" ], "properties": { @@ -33025,30 +32248,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "trackingId": { "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" + "active": { + "type": "boolean" }, - "position": { - "type": "integer", - "format": "int64" + "trackOrders": { + "type": "boolean" }, - "customFields": { - "type": "object" + "anonymizeIp": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -33060,53 +32270,69 @@ "format": "date-time", "readOnly": true }, - "rule": { - "$ref": "#/components/schemas/Rule" + "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}$" }, - "appScriptCondition": { - "$ref": "#/components/schemas/AppScriptCondition" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "parent": { - "$ref": "#/components/schemas/RuleCondition" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "country": { + "$ref": "#/components/schemas/Country" } }, "type": "object" }, - "RuleTag": { - "description": "Added since version: 6.5.0.0", + "SalesChannelCurrency": { + "description": "Added since version: 6.0.0.0", "required": [ - "ruleId", - "tagId" + "salesChannelId", + "currencyId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "rule": { - "$ref": "#/components/schemas/Rule" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "currency": { + "$ref": "#/components/schemas/Currency" } }, "type": "object" }, - "SalesChannelJsonApi": { + "SalesChannelDomainJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -33114,33 +32340,27 @@ }, { "required": [ - "typeId", + "id", + "url", + "salesChannelId", "languageId", - "customerGroupId", "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "accessKey", - "createdAt", - "name", - "homeEnabled" + "snippetSetId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "typeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "url": { + "type": "string" }, - "languageId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerGroupId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33148,126 +32368,16 @@ "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": { + "snippetSetId": { "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": { + "hreflangUseOnlyLocale": { "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", @@ -33278,48 +32388,9 @@ "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": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -33327,92 +32398,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currencies" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannel" } } }, "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": { "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": { + "example": "sales_channel" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "paymentMethods": { + "language": { "properties": { "links": { "type": "object", @@ -33420,61 +32427,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethods" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" } } }, "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": { "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" - } + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "type": { + "currency": { "properties": { "links": { "type": "object", @@ -33482,7 +32456,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/type" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" } } }, @@ -33491,19 +32465,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_type" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "599dcce2998a6b40b1e38e8c6006cb0a" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "language": { + "snippetSet": { "properties": { "links": { "type": "object", @@ -33511,7 +32485,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/language" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" } } }, @@ -33520,19 +32494,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "543af5fd1912efc00742534f621046d3" } } } }, "type": "object" }, - "customerGroup": { + "salesChannelDefaultHreflang": { "properties": { "links": { "type": "object", @@ -33540,7 +32514,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroup" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" } } }, @@ -33549,19 +32523,19 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "115091b01a7299f28a5ce7e1b712a222" + "example": "8d7b798a77667d73c422fb222603234c" } } } }, "type": "object" }, - "currency": { + "productExports": { "properties": { "links": { "type": "object", @@ -33569,86 +32543,256 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currency" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" } } }, "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": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_export" + }, + "id": { + "type": "string", + "example": "2cd8793787cda582174c0fc329fbc377" + } } } } }, "type": "object" - }, - "country": { + } + }, + "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", @@ -33656,28 +32800,145 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/country" + "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } } } } }, "type": "object" - }, - "orders": { + } + }, + "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", @@ -33685,7 +32946,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/orders" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" } } }, @@ -33696,11 +32957,11 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "customer" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -33708,7 +32969,7 @@ }, "type": "object" }, - "customers": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -33716,7 +32977,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customers" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" } } }, @@ -33727,11 +32988,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "customer_address" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -33739,7 +33000,7 @@ }, "type": "object" }, - "homeCmsPage": { + "orderCustomers": { "properties": { "links": { "type": "object", @@ -33747,28 +33008,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/homeCmsPage" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "00bba78f79ca4792a3162942ac65c768" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } } } } }, "type": "object" }, - "domains": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -33776,7 +33039,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/domains" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" } } }, @@ -33787,11 +33050,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "order_address" }, "id": { "type": "string", - "example": "e4e46deb7f9cc58c7abfb32e5570b6f3" + "example": "c3182f0dc0cc20b4982616d3e0221747" } } } @@ -33799,7 +33062,7 @@ }, "type": "object" }, - "systemConfigs": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -33807,7 +33070,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/systemConfigs" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" } } }, @@ -33818,77 +33081,264 @@ "properties": { "type": { "type": "string", - "example": "system_config" + "example": "newsletter_recipient" }, "id": { "type": "string", - "example": "dbcfb7a885e393eeb296543d06485547" + "example": "2217f01dc5cddfd5b60387c39867f58e" } } } } }, "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": { + } + }, + "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", @@ -33896,7 +33346,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/serviceCategory" + "example": "/script/f907e651164789346ae0a1e257c462d8/app" } } }, @@ -33905,50 +33355,148 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "app" }, "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" - } + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" - }, - "hreflangDefaultDomain": { + } + }, + "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", @@ -33956,7 +33504,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/hreflangDefaultDomain" + "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" } } }, @@ -33965,19 +33513,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7e80830860b9b8e5b8fc8d67262680b5" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "mailHeaderFooter": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -33985,7 +33533,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mailHeaderFooter" + "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/salesChannel" } } }, @@ -33994,81 +33542,152 @@ "properties": { "type": { "type": "string", - "example": "mail_header_footer" + "example": "sales_channel" }, "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" - } + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "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": { + } + }, + "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", @@ -34076,30 +33695,159 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/promotionSalesChannels" + "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion_sales_channel" - }, - "id": { - "type": "string", - "example": "ede6dfd9f261361e1f3ada8c5385d064" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - }, - "documentBaseConfigSalesChannels": { + } + }, + "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", @@ -34107,30 +33855,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/documentBaseConfigSalesChannels" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/deliveryTime" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_base_config_sales_channel" - }, - "id": { - "type": "string", - "example": "9c990fde5b38ff70fc1a07bf84c12a17" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "delivery_time" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, - "productReviews": { + "availabilityRule": { "properties": { "links": { "type": "object", @@ -34138,30 +33884,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviews" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review" - }, - "id": { - "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, - "seoUrls": { + "prices": { "properties": { "links": { "type": "object", @@ -34169,7 +33913,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrls" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" } } }, @@ -34180,11 +33924,11 @@ "properties": { "type": { "type": "string", - "example": "seo_url" + "example": "shipping_method_price" }, "id": { "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" + "example": "afae32efe0f84fece3f96b377b768b33" } } } @@ -34192,7 +33936,7 @@ }, "type": "object" }, - "seoUrlTemplates": { + "media": { "properties": { "links": { "type": "object", @@ -34200,30 +33944,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrlTemplates" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "seo_url_template" - }, - "id": { - "type": "string", - "example": "02cde325fef3e680f529875e8abd60bb" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "mainCategories": { + "tags": { "properties": { "links": { "type": "object", @@ -34231,7 +33973,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mainCategories" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" } } }, @@ -34242,11 +33984,11 @@ "properties": { "type": { "type": "string", - "example": "main_category" + "example": "tag" }, "id": { "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -34254,7 +33996,7 @@ }, "type": "object" }, - "productExports": { + "orderDeliveries": { "properties": { "links": { "type": "object", @@ -34262,7 +34004,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/orderDeliveries" } } }, @@ -34273,11 +34015,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "order_delivery" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "0ba472de56dd7ba2e7bb878434321e26" } } } @@ -34285,36 +34027,7 @@ }, "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": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -34322,7 +34035,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroupsRegistrations" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannels" } } }, @@ -34333,11 +34046,11 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "sales_channel" }, "id": { "type": "string", - "example": "ea52a61e886aa27d777ef201c6fb7fff" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -34345,7 +34058,7 @@ }, "type": "object" }, - "landingPages": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -34353,7 +34066,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/landingPages" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannelDefaultAssignments" } } }, @@ -34364,11 +34077,11 @@ "properties": { "type": { "type": "string", - "example": "landing_page" + "example": "sales_channel" }, "id": { "type": "string", - "example": "d60b77f2b3bd69591e3d5e3100926b4d" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -34376,7 +34089,7 @@ }, "type": "object" }, - "boundCustomers": { + "tax": { "properties": { "links": { "type": "object", @@ -34384,30 +34097,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/boundCustomers" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "example": "770f1f7d01437434bcdf89eee15d4bd2" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, - "wishlists": { + "appShippingMethod": { "properties": { "links": { "type": "object", @@ -34415,23 +34126,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/wishlists" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/appShippingMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_wishlist" - }, - "id": { - "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "09f1214e961760dbae11d49b2bf9fa2c" } } } @@ -34446,161 +34155,59 @@ } ] }, - "SalesChannel": { + "ShippingMethod": { "description": "Added since version: 6.0.0.0", "required": [ - "typeId", - "languageId", - "customerGroupId", - "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "accessKey", + "id", + "deliveryTimeId", + "taxType", "createdAt", - "name", - "homeEnabled" + "name" ], "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}$" + "name": { + "type": "string" }, - "navigationCategoryVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "type": "boolean" }, - "navigationCategoryDepth": { + "position": { "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}$" + "customFields": { + "type": "object" }, - "serviceCategoryVersionId": { + "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailHeaderFooterId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hreflangDefaultDomainId": { + "deliveryTimeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "shortName": { - "type": "string" - }, - "taxCalculationType": { - "type": "string" - }, - "accessKey": { + "taxType": { "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": { + "taxId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "homeSlotConfig": { - "type": "object" - }, - "homeEnabled": { - "type": "boolean" - }, - "homeName": { - "type": "string" - }, - "homeMetaTitle": { + "description": { "type": "string" }, - "homeMetaDescription": { + "trackingUrl": { "type": "string" }, - "homeKeywords": { + "technicalName": { "type": "string" }, "createdAt": { @@ -34616,233 +34223,64 @@ "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" - } + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime" }, - "productReviews": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "availabilityRule": { + "$ref": "#/components/schemas/Rule" }, - "seoUrls": { + "prices": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ShippingMethodPrice" } }, - "seoUrlTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } + "media": { + "$ref": "#/components/schemas/Media" }, - "mainCategories": { + "tags": { "type": "array", "items": { - "$ref": "#/components/schemas/MainCategory" + "$ref": "#/components/schemas/Tag" } }, - "productExports": { + "orderDeliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/OrderDelivery" } }, - "analytics": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - }, - "customerGroupsRegistrations": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/SalesChannel" } }, - "landingPages": { + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/LandingPage" + "$ref": "#/components/schemas/SalesChannel" } }, - "boundCustomers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } + "tax": { + "$ref": "#/components/schemas/Tax" }, - "wishlists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } + "appShippingMethod": { + "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" }, - "SalesChannelAnalyticsJsonApi": { - "description": "Added since version: 6.2.0.0", + "ShippingMethodPriceJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", + "shippingMethodId", "createdAt" ], "properties": { @@ -34850,17 +34288,35 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "trackingId": { - "type": "string" + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "trackOrders": { - "type": "boolean" + "calculation": { + "type": "integer", + "format": "int64" }, - "anonymizeIp": { - "type": "boolean" + "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", @@ -34874,7 +34330,7 @@ }, "relationships": { "properties": { - "salesChannel": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -34882,7 +34338,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/salesChannel" + "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/shippingMethod" } } }, @@ -34891,12 +34347,70 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" } } } @@ -34911,9 +34425,11 @@ } ] }, - "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "ShippingMethodPrice": { + "description": "Added since version: 6.0.0.0", "required": [ + "id", + "shippingMethodId", "createdAt" ], "properties": { @@ -34921,17 +34437,35 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "trackingId": { - "type": "string" + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "trackOrders": { - "type": "boolean" + "calculation": { + "type": "integer", + "format": "int64" }, - "anonymizeIp": { - "type": "boolean" + "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", @@ -34943,69 +34477,47 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "calculationRule": { + "$ref": "#/components/schemas/Rule" } }, "type": "object" }, - "SalesChannelCountry": { + "ShippingMethodTag": { "description": "Added since version: 6.0.0.0", "required": [ - "salesChannelId", - "countryId" + "shippingMethodId", + "tagId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "tagId": { "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" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" }, - "currency": { - "$ref": "#/components/schemas/Currency" + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "SalesChannelDomainJsonApi": { + "SnippetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -35013,11 +34525,11 @@ }, { "required": [ - "url", - "salesChannelId", - "languageId", - "currencyId", - "snippetSetId", + "id", + "setId", + "translationKey", + "value", + "author", "createdAt" ], "properties": { @@ -35025,27 +34537,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { - "type": "string" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { + "setId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "translationKey": { + "type": "string" }, - "snippetSetId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "value": { + "type": "string" }, - "hreflangUseOnlyLocale": { - "type": "boolean" + "author": { + "type": "string" }, "customFields": { "type": "object" @@ -35060,45 +34563,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "guidedShoppingAppointmentGuideSalesChannelDomain": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/guidedShoppingAppointmentGuideSalesChannelDomain" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "9d35c5d56efd23115cc9ea665c63ad99" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, "relationships": { "properties": { - "salesChannel": { + "set": { "properties": { "links": { "type": "object", @@ -35106,7 +34573,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannel" + "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" } } }, @@ -35115,19 +34582,117 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" } } } }, "type": "object" - }, - "language": { + } + }, + "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", @@ -35135,28 +34700,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" + "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "snippet" + }, + "id": { + "type": "string", + "example": "67be68a348da3b850fb7daa10b034528" + } } } } }, "type": "object" }, - "currency": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -35164,28 +34731,135 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" + "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "example": "b60ab8d110194bfe34ef9928ba48ab6d" + } } } } }, "type": "object" - }, - "snippetSet": { + } + }, + "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", @@ -35193,28 +34867,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" + "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/states" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "snippet_set" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "543af5fd1912efc00742534f621046d3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" + } } } } }, "type": "object" }, - "salesChannelDefaultHreflang": { + "transitions": { "properties": { "links": { "type": "object", @@ -35222,28 +34898,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" + "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/transitions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8d7b798a77667d73c422fb222603234c" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_transition" + }, + "id": { + "type": "string", + "example": "34fe3c1def90f54754c23fb8df6dbeb0" + } } } } }, "type": "object" }, - "productExports": { + "historyEntries": { "properties": { "links": { "type": "object", @@ -35251,7 +34929,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" + "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/historyEntries" } } }, @@ -35262,11 +34940,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "state_machine_history" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "83f6d6b77ef224687b7b34cfe4296bea" } } } @@ -35282,46 +34960,32 @@ } ] }, - "SalesChannelDomain": { + "StateMachine": { "description": "Added since version: 6.0.0.0", "required": [ - "url", - "salesChannelId", - "languageId", - "currencyId", - "snippetSetId", - "createdAt" + "id", + "technicalName", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { + "technicalName": { "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "snippetSetId": { + "initialStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hreflangUseOnlyLocale": { - "type": "boolean" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -35332,151 +34996,31 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "guidedShoppingAppointmentGuideSalesChannelDomain": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/guidedShoppingAppointmentGuideSalesChannelDomain" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "9d35c5d56efd23115cc9ea665c63ad99" - } - } - } - } - }, - "type": "object" - } - }, + "translated": { "type": "object" }, - "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" + "states": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } }, - "productExports": { + "transitions": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/StateMachineTransition" } - } - }, - "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" + "historyEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } } }, "type": "object" }, - "SalesChannelTypeJsonApi": { + "StateMachineHistoryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -35484,40 +35028,49 @@ }, { "required": [ - "createdAt", - "name" + "id", + "referencedId", + "referencedVersionId", + "stateMachineId", + "entityName", + "fromStateId", + "toStateId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverUrl": { - "type": "string" + "referencedId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iconName": { - "type": "string" + "referencedVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "screenshotUrls": { - "type": "array", - "items": { - "type": "string" - } + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "entityName": { "type": "string" }, - "manufacturer": { - "type": "string" + "fromStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "toStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "descriptionLong": { + "transitionActionName": { "type": "string" }, - "customFields": { - "type": "object" + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -35529,12 +35082,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannels": { + "stateMachine": { "properties": { "links": { "type": "object", @@ -35542,23 +35092,108 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/stateMachine" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "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" } } } @@ -35573,43 +35208,52 @@ } ] }, - "SalesChannelType": { + "StateMachineHistory": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", - "name" + "id", + "referencedId", + "referencedVersionId", + "stateMachineId", + "entityName", + "fromStateId", + "toStateId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverUrl": { - "type": "string" + "referencedId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iconName": { - "type": "string" + "referencedVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "screenshotUrls": { - "type": "array", - "items": { - "type": "string" - } + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "entityName": { "type": "string" }, - "manufacturer": { - "type": "string" + "fromStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "toStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "descriptionLong": { + "transitionActionName": { "type": "string" }, - "customFields": { - "type": "object" + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -35621,19 +35265,22 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "stateMachine": { + "$ref": "#/components/schemas/StateMachine" }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "user": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "SalutationJsonApi": { + "StateMachineStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -35641,24 +35288,26 @@ }, { "required": [ - "salutationKey", + "id", + "technicalName", + "stateMachineId", "createdAt", - "displayName", - "letterName" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationKey": { + "technicalName": { "type": "string" }, - "displayName": { + "name": { "type": "string" }, - "letterName": { - "type": "string" + "stateMachineId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" @@ -35678,7 +35327,7 @@ }, "relationships": { "properties": { - "customers": { + "stateMachine": { "properties": { "links": { "type": "object", @@ -35686,7 +35335,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" + "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" } } }, @@ -35697,11 +35375,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "state_machine_transition" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "80afc3e35f99674237f602b393d3b2ba" } } } @@ -35709,7 +35387,7 @@ }, "type": "object" }, - "customerAddresses": { + "toStateMachineTransitions": { "properties": { "links": { "type": "object", @@ -35717,7 +35395,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineTransitions" } } }, @@ -35728,11 +35406,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "state_machine_transition" }, "id": { "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" + "example": "eb2ca150be27264985d0fcf20d53408d" } } } @@ -35740,7 +35418,7 @@ }, "type": "object" }, - "orderCustomers": { + "orderTransactions": { "properties": { "links": { "type": "object", @@ -35748,7 +35426,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactions" } } }, @@ -35759,11 +35437,11 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "order_transaction" }, "id": { "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" + "example": "3bdb6a464fb3330bd1935325493c5f2c" } } } @@ -35771,7 +35449,7 @@ }, "type": "object" }, - "orderAddresses": { + "orderDeliveries": { "properties": { "links": { "type": "object", @@ -35779,7 +35457,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderDeliveries" } } }, @@ -35790,11 +35468,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "order_delivery" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "0ba472de56dd7ba2e7bb878434321e26" } } } @@ -35802,7 +35480,7 @@ }, "type": "object" }, - "newsletterRecipients": { + "orders": { "properties": { "links": { "type": "object", @@ -35810,7 +35488,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orders" } } }, @@ -35821,258 +35499,19 @@ "properties": { "type": { "type": "string", - "example": "newsletter_recipient" + "example": "order" }, "id": { "type": "string", - "example": "2217f01dc5cddfd5b60387c39867f58e" + "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Salutation": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "name", - "scheduledTaskClass", - "runInterval", - "status", - "nextExecutionTime", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "scheduledTaskClass": { - "type": "string" - }, - "runInterval": { - "type": "integer", - "format": "int64" - }, - "status": { - "type": "string" - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time" - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time" - }, - "defaultRunInterval": { - "type": "integer", - "format": "int64" - }, - "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": [ - "name", - "scheduledTaskClass", - "runInterval", - "status", - "nextExecutionTime", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "scheduledTaskClass": { - "type": "string" - }, - "runInterval": { - "type": "integer", - "format": "int64" - }, - "status": { - "type": "string" - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time" - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time" - }, - "defaultRunInterval": { - "type": "integer", - "format": "int64" - }, - "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": [ - "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": { + }, + "orderTransactionCaptures": { "properties": { "links": { "type": "object", @@ -36080,21 +35519,116 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/script/f907e651164789346ae0a1e257c462d8/app" + "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": { - "type": { + "related": { "type": "string", - "example": "app" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "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" + } } } } @@ -36109,36 +35643,33 @@ } ] }, - "Script": { - "description": "Added since version: 6.4.7.0", + "StateMachineState": { + "description": "Added since version: 6.0.0.0", "required": [ - "script", - "hook", - "name", - "active", - "createdAt" + "id", + "technicalName", + "stateMachineId", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "script": { - "type": "string" - }, - "hook": { + "technicalName": { "type": "string" }, "name": { "type": "string" }, - "active": { - "type": "boolean" - }, - "appId": { + "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -36149,13 +35680,70 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "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" }, - "SeoUrlJsonApi": { + "StateMachineTransitionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -36163,11 +35751,11 @@ }, { "required": [ - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo", + "id", + "actionName", + "stateMachineId", + "fromStateId", + "toStateId", "createdAt" ], "properties": { @@ -36175,47 +35763,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "actionName": { + "type": "string" + }, + "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "fromStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { + "toStateId": { "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" - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, "customFields": { "type": "object" }, - "isValid": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36228,7 +35793,7 @@ }, "relationships": { "properties": { - "language": { + "stateMachine": { "properties": { "links": { "type": "object", @@ -36236,7 +35801,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" + "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/stateMachine" } } }, @@ -36245,19 +35810,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "state_machine" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "341364a811428a3ed8c355c2c4fe6990" } } } }, "type": "object" }, - "salesChannel": { + "fromStateMachineState": { "properties": { "links": { "type": "object", @@ -36265,7 +35830,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/salesChannel" + "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/fromStateMachineState" } } }, @@ -36274,12 +35839,41 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" } } } @@ -36294,14 +35888,14 @@ } ] }, - "SeoUrl": { + "StateMachineTransition": { "description": "Added since version: 6.0.0.0", "required": [ - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo", + "id", + "actionName", + "stateMachineId", + "fromStateId", + "toStateId", "createdAt" ], "properties": { @@ -36309,47 +35903,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "actionName": { + "type": "string" + }, + "stateMachineId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "fromStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { + "toStateId": { "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" - }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" - }, "customFields": { "type": "object" }, - "isValid": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -36360,16 +35931,19 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "stateMachine": { + "$ref": "#/components/schemas/StateMachine" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "fromStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "toStateMachineState": { + "$ref": "#/components/schemas/StateMachineState" } }, "type": "object" }, - "SeoUrlTemplateJsonApi": { + "SystemConfigJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -36377,8 +35951,9 @@ }, { "required": [ - "entityName", - "routeName", + "id", + "configurationKey", + "configurationValue", "createdAt" ], "properties": { @@ -36386,25 +35961,21 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityName": { - "type": "string" - }, - "routeName": { - "type": "string" - }, - "template": { + "configurationKey": { "type": "string" }, - "isValid": { - "type": "boolean" - }, - "customFields": { + "configurationValue": { + "properties": { + "_value": { + "type": "object" + } + }, "type": "object" }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -36425,7 +35996,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/salesChannel" + "example": "/system-config/a59948b9e45358eaaaa1b13d9cedc248/salesChannel" } } }, @@ -36454,37 +36025,34 @@ } ] }, - "SeoUrlTemplate": { + "SystemConfig": { "description": "Added since version: 6.0.0.0", "required": [ - "entityName", - "routeName", - "createdAt" + "id", + "configurationKey", + "configurationValue", + "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": { + "configurationKey": { "type": "string" }, - "isValid": { - "type": "boolean" - }, - "customFields": { + "configurationValue": { + "properties": { + "_value": { + "type": "object" + } + }, "type": "object" }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -36501,7 +36069,7 @@ }, "type": "object" }, - "ShippingMethodJsonApi": { + "TagJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -36509,11 +36077,9 @@ }, { "required": [ - "availabilityRuleId", - "deliveryTimeId", - "taxType", - "createdAt", - "name" + "id", + "name", + "createdAt" ], "properties": { "id": { @@ -36523,44 +36089,6 @@ "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", @@ -36571,41 +36099,9 @@ "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": { + "products": { "properties": { "links": { "type": "object", @@ -36613,28 +36109,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/availabilityRule" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/products" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9fbb7961d1cb158094924c679e1b302c" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } }, "type": "object" }, - "prices": { + "media": { "properties": { "links": { "type": "object", @@ -36642,7 +36140,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/prices" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/media" } } }, @@ -36653,11 +36151,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method_price" + "example": "media" }, "id": { "type": "string", - "example": "afae32efe0f84fece3f96b377b768b33" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -36665,7 +36163,7 @@ }, "type": "object" }, - "media": { + "categories": { "properties": { "links": { "type": "object", @@ -36673,28 +36171,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/media" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/categories" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } } } } }, "type": "object" }, - "tags": { + "customers": { "properties": { "links": { "type": "object", @@ -36702,7 +36202,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tags" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/customers" } } }, @@ -36713,11 +36213,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "customer" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -36725,7 +36225,7 @@ }, "type": "object" }, - "orderDeliveries": { + "orders": { "properties": { "links": { "type": "object", @@ -36733,7 +36233,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/orderDeliveries" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/orders" } } }, @@ -36744,11 +36244,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "order" }, "id": { "type": "string", - "example": "0ba472de56dd7ba2e7bb878434321e26" + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -36756,7 +36256,7 @@ }, "type": "object" }, - "salesChannels": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -36764,7 +36264,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannels" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/shippingMethods" } } }, @@ -36775,11 +36275,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "shipping_method" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -36787,7 +36287,7 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -36795,7 +36295,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannelDefaultAssignments" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/newsletterRecipients" } } }, @@ -36806,11 +36306,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "newsletter_recipient" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "2217f01dc5cddfd5b60387c39867f58e" } } } @@ -36818,7 +36318,7 @@ }, "type": "object" }, - "tax": { + "landingPages": { "properties": { "links": { "type": "object", @@ -36826,28 +36326,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/tax" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/landingPages" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tax" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "landing_page" + }, + "id": { + "type": "string", + "example": "d60b77f2b3bd69591e3d5e3100926b4d" + } } } } }, "type": "object" }, - "appShippingMethod": { + "rules": { "properties": { "links": { "type": "object", @@ -36855,21 +36357,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/appShippingMethod" + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/rules" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "09f1214e961760dbae11d49b2bf9fa2c" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } } } } @@ -36884,14 +36388,12 @@ } ] }, - "ShippingMethod": { + "Tag": { "description": "Added since version: 6.0.0.0", "required": [ - "availabilityRuleId", - "deliveryTimeId", - "taxType", - "createdAt", - "name" + "id", + "name", + "createdAt" ], "properties": { "id": { @@ -36901,44 +36403,6 @@ "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", @@ -36949,58 +36413,64 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" - }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" - }, - "prices": { + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/Product" } }, "media": { - "$ref": "#/components/schemas/Media" + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } }, - "tags": { + "categories": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/Category" } }, - "orderDeliveries": { + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/Customer" } }, - "salesChannels": { + "orders": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Order" } }, - "salesChannelDefaultAssignments": { + "shippingMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/ShippingMethod" } }, - "tax": { - "$ref": "#/components/schemas/Tax" + "newsletterRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } }, - "appShippingMethod": { - "$ref": "#/components/schemas/AppShippingMethod" + "landingPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } } }, "type": "object" }, - "ShippingMethodPriceJsonApi": { + "TaxJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -37008,7 +36478,10 @@ }, { "required": [ - "shippingMethodId", + "id", + "taxRate", + "name", + "position", "createdAt" ], "properties": { @@ -37016,32 +36489,17 @@ "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": { + "taxRate": { "type": "number", "format": "float" }, - "quantityEnd": { - "type": "number", - "format": "float" + "name": { + "type": "string" }, - "currencyPrice": { - "type": "object" + "position": { + "description": "Added since version: 6.4.0.0.", + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -37058,7 +36516,7 @@ }, "relationships": { "properties": { - "shippingMethod": { + "products": { "properties": { "links": { "type": "object", @@ -37066,28 +36524,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/shippingMethod" + "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/products" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } }, "type": "object" }, - "rule": { + "rules": { "properties": { "links": { "type": "object", @@ -37095,28 +36555,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/rule" + "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/rules" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } } } } }, "type": "object" }, - "calculationRule": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -37124,21 +36586,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/calculationRule" + "example": "/tax/4b78ac8eb158840e9638a3aeb26c4a9d/shippingMethods" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "01b78fd34df634d784131ceefffbac99" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } } } } @@ -37153,10 +36617,13 @@ } ] }, - "ShippingMethodPrice": { + "Tax": { "description": "Added since version: 6.0.0.0", "required": [ - "shippingMethodId", + "id", + "taxRate", + "name", + "position", "createdAt" ], "properties": { @@ -37164,32 +36631,17 @@ "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": { + "taxRate": { "type": "number", "format": "float" }, - "quantityEnd": { - "type": "number", - "format": "float" + "name": { + "type": "string" }, - "currencyPrice": { - "type": "object" + "position": { + "description": "Added since version: 6.4.0.0.", + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -37204,78 +36656,70 @@ "format": "date-time", "readOnly": true }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "rule": { - "$ref": "#/components/schemas/Rule" + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "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" + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } }, - "tag": { - "$ref": "#/components/schemas/Tag" + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } } }, "type": "object" }, - "SnippetJsonApi": { - "description": "Added since version: 6.0.0.0", + "TaxProviderJsonApi": { + "description": "Added since version: 6.5.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "setId", - "translationKey", - "value", - "author", - "createdAt" + "id", + "identifier", + "priority", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "setId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationKey": { + "identifier": { "type": "string" }, - "value": { + "active": { + "type": "boolean" + }, + "name": { "type": "string" }, - "author": { + "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" }, @@ -37289,9 +36733,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "set": { + "availabilityRule": { "properties": { "links": { "type": "object", @@ -37299,7 +36746,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" + "example": "/tax-provider/c948e3fe09fafe2aa0da1b75ebbd211b/availabilityRule" } } }, @@ -37308,12 +36755,41 @@ "properties": { "type": { "type": "string", - "example": "snippet_set" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" + "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" } } } @@ -37328,33 +36804,44 @@ } ] }, - "Snippet": { - "description": "Added since version: 6.0.0.0", + "TaxProvider": { + "description": "Added since version: 6.5.0.0", "required": [ - "setId", - "translationKey", - "value", - "author", - "createdAt" + "id", + "identifier", + "priority", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "setId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationKey": { + "identifier": { "type": "string" }, - "value": { + "active": { + "type": "boolean" + }, + "name": { "type": "string" }, - "author": { + "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" }, @@ -37368,23 +36855,31 @@ "format": "date-time", "readOnly": true }, - "set": { - "$ref": "#/components/schemas/SnippetSet" + "translated": { + "type": "object" + }, + "availabilityRule": { + "$ref": "#/components/schemas/Rule" + }, + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "SnippetSetJsonApi": { - "description": "Added since version: 6.0.0.0", + "TaxRuleJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", - "baseFile", - "iso", + "id", + "taxRuleTypeId", + "countryId", + "taxRate", + "taxId", "createdAt" ], "properties": { @@ -37392,18 +36887,47 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "taxRuleTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "baseFile": { - "type": "string" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iso": { - "type": "string" + "taxRate": { + "type": "number", + "format": "float" }, - "customFields": { + "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", @@ -37416,7 +36940,7 @@ }, "relationships": { "properties": { - "snippets": { + "type": { "properties": { "links": { "type": "object", @@ -37424,30 +36948,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" + "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/type" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "snippet" - }, - "id": { - "type": "string", - "example": "67be68a348da3b850fb7daa10b034528" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_rule_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, - "salesChannelDomains": { + "country": { "properties": { "links": { "type": "object", @@ -37455,23 +36977,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" + "example": "/tax-rule/0c7d1b4f3382a39cbbf06af100fd4dc9/country" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel_domain" - }, - "id": { - "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" - } + "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" } } } @@ -37486,12 +37035,14 @@ } ] }, - "SnippetSet": { - "description": "Added since version: 6.0.0.0", + "TaxRule": { + "description": "Added since version: 6.1.0.0", "required": [ - "name", - "baseFile", - "iso", + "id", + "taxRuleTypeId", + "countryId", + "taxRate", + "taxId", "createdAt" ], "properties": { @@ -37499,18 +37050,47 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "taxRuleTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "baseFile": { - "type": "string" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iso": { - "type": "string" + "taxRate": { + "type": "number", + "format": "float" }, - "customFields": { + "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", @@ -37521,32 +37101,31 @@ "format": "date-time", "readOnly": true }, - "snippets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } + "type": { + "$ref": "#/components/schemas/TaxRuleType" }, - "salesChannelDomains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } + "country": { + "$ref": "#/components/schemas/Country" + }, + "tax": { + "$ref": "#/components/schemas/Tax" } }, "type": "object" }, - "StateMachineJsonApi": { - "description": "Added since version: 6.0.0.0", + "TaxRuleTypeJsonApi": { + "description": "Added since version: 6.1.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", "technicalName", + "position", "createdAt", - "name" + "typeName" ], "properties": { "id": { @@ -37554,17 +37133,15 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "readOnly": true }, - "customFields": { - "type": "object" + "position": { + "type": "integer", + "format": "int64" }, - "initialStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "typeName": { + "type": "string" }, "createdAt": { "type": "string", @@ -37581,69 +37158,7 @@ }, "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": { + "rules": { "properties": { "links": { "type": "object", @@ -37651,7 +37166,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine/e33d8b3de97b8246976dde33ff4abd48/historyEntries" + "example": "/tax-rule-type/ebbaa02c602593b9fea23bc0256355fc/rules" } } }, @@ -37662,11 +37177,11 @@ "properties": { "type": { "type": "string", - "example": "state_machine_history" + "example": "tax_rule" }, "id": { "type": "string", - "example": "83f6d6b77ef224687b7b34cfe4296bea" + "example": "a4f86f7bfc24194b276c22e0ef158197" } } } @@ -37682,12 +37197,14 @@ } ] }, - "StateMachine": { - "description": "Added since version: 6.0.0.0", + "TaxRuleType": { + "description": "Added since version: 6.1.0.0", "required": [ + "id", "technicalName", + "position", "createdAt", - "name" + "typeName" ], "properties": { "id": { @@ -37695,17 +37212,15 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "readOnly": true }, - "customFields": { - "type": "object" + "position": { + "type": "integer", + "format": "int64" }, - "initialStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "typeName": { + "type": "string" }, "createdAt": { "type": "string", @@ -37720,28 +37235,16 @@ "translated": { "type": "object" }, - "states": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - }, - "transitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - }, - "historyEntries": { + "rules": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/TaxRule" } } }, "type": "object" }, - "StateMachineHistoryJsonApi": { + "ThemeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -37749,11 +37252,10 @@ }, { "required": [ - "stateMachineId", - "entityName", - "fromStateId", - "toStateId", - "entityId", + "id", + "name", + "author", + "active", "createdAt" ], "properties": { @@ -37761,40 +37263,47 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateMachineId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityName": { + "technicalName": { "type": "string" }, - "fromStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "toStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "author": { + "type": "string" }, - "transitionActionName": { + "description": { "type": "string" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "labels": { + "type": "object" }, - "entityId": { - "type": "object", - "deprecated": true + "helpTexts": { + "type": "object" }, - "referencedId": { + "customFields": { + "type": "object" + }, + "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "referencedVersionId": { + "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", @@ -37805,9 +37314,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "stateMachine": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -37815,28 +37327,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-history/2981354377022484094791c3f19ffec8/stateMachine" + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/salesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "341364a811428a3ed8c355c2c4fe6990" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } } } } }, "type": "object" }, - "fromStateMachineState": { + "media": { "properties": { "links": { "type": "object", @@ -37844,28 +37358,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-history/2981354377022484094791c3f19ffec8/fromStateMachineState" + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/media" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b108a2a0d303fafc83ef06f6790722e8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } } } } }, "type": "object" }, - "toStateMachineState": { + "previewMedia": { "properties": { "links": { "type": "object", @@ -37873,7 +37389,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-history/2981354377022484094791c3f19ffec8/toStateMachineState" + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/previewMedia" } } }, @@ -37882,19 +37398,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" + "example": "a7a817fb0e422cff87e878b8ff7ca914" } } } }, "type": "object" }, - "user": { + "dependentThemes": { "properties": { "links": { "type": "object", @@ -37902,21 +37418,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-history/2981354377022484094791c3f19ffec8/user" + "example": "/theme/d721757161f7f70c5b0949fdb6ec2c30/dependentThemes" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "f0608e2d62b88d9b9da8d6d715b6439c" + } } } } @@ -37931,14 +37449,13 @@ } ] }, - "StateMachineHistory": { + "Theme": { "description": "Added since version: 6.0.0.0", "required": [ - "stateMachineId", - "entityName", - "fromStateId", - "toStateId", - "entityId", + "id", + "name", + "author", + "active", "createdAt" ], "properties": { @@ -37946,40 +37463,47 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateMachineId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityName": { + "technicalName": { "type": "string" }, - "fromStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "toStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "author": { + "type": "string" }, - "transitionActionName": { + "description": { "type": "string" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "labels": { + "type": "object" }, - "entityId": { - "type": "object", - "deprecated": true + "helpTexts": { + "type": "object" }, - "referencedId": { + "customFields": { + "type": "object" + }, + "previewMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "referencedVersionId": { + "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", @@ -37990,22 +37514,118 @@ "format": "date-time", "readOnly": true }, - "stateMachine": { - "$ref": "#/components/schemas/StateMachine" + "translated": { + "type": "object" }, - "fromStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "toStateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } }, - "user": { - "$ref": "#/components/schemas/User" + "previewMedia": { + "$ref": "#/components/schemas/Media" + }, + "dependentThemes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } } }, "type": "object" }, - "StateMachineStateJsonApi": { + "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": [ { @@ -38013,9 +37633,9 @@ }, { "required": [ - "technicalName", - "stateMachineId", + "id", "createdAt", + "shortCode", "name" ], "properties": { @@ -38023,16 +37643,12 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { + "shortCode": { "type": "string" }, "name": { "type": "string" }, - "stateMachineId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "customFields": { "type": "object" }, @@ -38051,7 +37667,7 @@ }, "relationships": { "properties": { - "stateMachine": { + "products": { "properties": { "links": { "type": "object", @@ -38059,28 +37675,155 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/stateMachine" + "example": "/unit/19c562a36aeb455d09534f93b4f5236f/products" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "341364a811428a3ed8c355c2c4fe6990" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } } } } }, "type": "object" - }, - "fromStateMachineTransitions": { + } + }, + "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", @@ -38088,7 +37831,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineTransitions" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" } } }, @@ -38099,19 +37842,24 @@ "properties": { "type": { "type": "string", - "example": "state_machine_transition" + "example": "notification" }, "id": { "type": "string", - "example": "80afc3e35f99674237f602b393d3b2ba" + "example": "04f88ea12127fe03b65beffbc2c96954" } } } } }, "type": "object" - }, - "toStateMachineTransitions": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "locale": { "properties": { "links": { "type": "object", @@ -38119,30 +37867,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineTransitions" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/locale" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_transition" - }, - "id": { - "type": "string", - "example": "eb2ca150be27264985d0fcf20d53408d" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, - "orderTransactions": { + "avatarMedia": { "properties": { "links": { "type": "object", @@ -38150,30 +37896,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactions" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/avatarMedia" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction" - }, - "id": { - "type": "string", - "example": "3bdb6a464fb3330bd1935325493c5f2c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "117ab0b986d2b792c775e3beeacca7c7" } } } }, "type": "object" }, - "orderDeliveries": { + "media": { "properties": { "links": { "type": "object", @@ -38181,7 +37925,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderDeliveries" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/media" } } }, @@ -38192,11 +37936,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "media" }, "id": { "type": "string", - "example": "0ba472de56dd7ba2e7bb878434321e26" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -38204,7 +37948,7 @@ }, "type": "object" }, - "orders": { + "accessKeys": { "properties": { "links": { "type": "object", @@ -38212,7 +37956,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orders" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/accessKeys" } } }, @@ -38223,11 +37967,11 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "user_access_key" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "d11944e47e101a4aaa8d7947faa56b16" } } } @@ -38235,7 +37979,7 @@ }, "type": "object" }, - "orderTransactionCaptures": { + "configs": { "properties": { "links": { "type": "object", @@ -38243,7 +37987,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptures" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/configs" } } }, @@ -38254,11 +37998,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture" + "example": "user_config" }, "id": { "type": "string", - "example": "a32c8bdb9e1154cf4e138a0c8faa7159" + "example": "c23f7ab876ac167e05468ef79f046cb7" } } } @@ -38266,7 +38010,7 @@ }, "type": "object" }, - "orderTransactionCaptureRefunds": { + "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", @@ -38274,7 +38018,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/orderTransactionCaptureRefunds" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/stateMachineHistoryEntries" } } }, @@ -38285,11 +38029,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund" + "example": "state_machine_history" }, "id": { "type": "string", - "example": "24fe1cc759f5450a1d5984a61ad20bda" + "example": "c78c7ea361b7def0876b75bd1bd37879" } } } @@ -38297,7 +38041,7 @@ }, "type": "object" }, - "toStateMachineHistoryEntries": { + "importExportLogEntries": { "properties": { "links": { "type": "object", @@ -38305,7 +38049,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/toStateMachineHistoryEntries" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/importExportLogEntries" } } }, @@ -38316,11 +38060,11 @@ "properties": { "type": { "type": "string", - "example": "state_machine_history" + "example": "import_export_log" }, "id": { "type": "string", - "example": "01326b3b7d7c9c9182eb3940bb456c50" + "example": "72ec794255f368c7a704e177fa9a4967" } } } @@ -38328,7 +38072,7 @@ }, "type": "object" }, - "fromStateMachineHistoryEntries": { + "aclRoles": { "properties": { "links": { "type": "object", @@ -38336,7 +38080,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/fromStateMachineHistoryEntries" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/aclRoles" } } }, @@ -38347,204 +38091,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_history" + "example": "acl_role" }, "id": { "type": "string", - "example": "6e4fe8b42b9cffa16c3e7b7e4a2a836d" + "example": "e050a8081a3eb1d193c23cf0ef761183" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "StateMachineState": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + "recoveryUser": { "properties": { "links": { "type": "object", @@ -38552,7 +38111,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/fromStateMachineState" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/recoveryUser" } } }, @@ -38561,19 +38120,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "user_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b108a2a0d303fafc83ef06f6790722e8" + "example": "bf6cdb5c30f0f0d234b96e50f2953109" } } } }, "type": "object" }, - "toStateMachineState": { + "createdOrders": { "properties": { "links": { "type": "object", @@ -38581,134 +38140,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/state-machine-transition/72d87bcb11bdd3adcb321d14ee8c6515/toStateMachineState" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdOrders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d04a8a7ce57fa3ec0bc44aa1cb095713" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "20509127ddf2655eb49e3db3b1d710c0" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "StateMachineTransition": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "updatedOrders": { "properties": { "links": { "type": "object", @@ -38716,110 +38171,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/system-config/a59948b9e45358eaaaa1b13d9cedc248/salesChannel" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedOrders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "example": "9ce34a8be6d860e8bd92feaf79e9a4a2" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "SystemConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "createdCustomers": { "properties": { "links": { "type": "object", @@ -38827,7 +38202,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/products" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdCustomers" } } }, @@ -38838,11 +38213,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "customer" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "c0caccfe18ce8c277f15d100818139a6" } } } @@ -38850,7 +38225,7 @@ }, "type": "object" }, - "media": { + "updatedCustomers": { "properties": { "links": { "type": "object", @@ -38858,69 +38233,7 @@ "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" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedCustomers" } } }, @@ -38935,389 +38248,7 @@ }, "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": [ - "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": [ - "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" + "example": "dddac98f88e37eb31b56e7e1d455fd75" } } } @@ -39333,4394 +38264,1219 @@ } ] }, - "Tax": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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" - }, - "guidedShoppingAppointmentGuideUser": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/guidedShoppingAppointmentGuideUser" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "d1927976a522fb34b836497d28ee7037" - } - } - } - } - }, - "type": "object" - }, - "createdPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "d1e11035d87216918d95e78a7ac396da" - } - } - } - } - }, - "type": "object" - }, - "updatedPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "49fb9c4fad69d4a3da998a936016c88d" - } - } - } - } - }, - "type": "object" - }, - "createdAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "888e350c3c9a465bc4d7c8a80840b2aa" - } - } - } - } - }, - "type": "object" - }, - "updatedAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "b64277a1e650794e2c57924c07825014" - } - } - } - } - }, - "type": "object" - }, - "createdLayouts": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "example": "22b76a69d00feab60733ea096895a432" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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": [ - "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" - }, - "guidedShoppingAppointmentGuideUser": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/guidedShoppingAppointmentGuideUser" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "d1927976a522fb34b836497d28ee7037" - } - } - } - } - }, - "type": "object" - }, - "createdPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "d1e11035d87216918d95e78a7ac396da" - } - } - } - } - }, - "type": "object" - }, - "updatedPresentations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_presentation" - }, - "id": { - "type": "string", - "example": "49fb9c4fad69d4a3da998a936016c88d" - } - } - } - } - }, - "type": "object" - }, - "createdAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "888e350c3c9a465bc4d7c8a80840b2aa" - } - } - } - } - }, - "type": "object" - }, - "updatedAppointments": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "guided_shopping_appointment" - }, - "id": { - "type": "string", - "example": "b64277a1e650794e2c57924c07825014" - } - } - } - } - }, - "type": "object" - }, - "createdLayouts": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "example": "22b76a69d00feab60733ea096895a432" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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": [ - "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" - }, - "flowBulderActionsResponse": { - "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" - } - } - } - }, - "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" - } - } - } - } - }, - "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." - } - } - } - } - }, - "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" - ] - } - } - }, - "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" - ] - } - ] - }, - "GuidePresentationStateResponse": { - "type": "object", - "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" - }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" - } - }, - "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "allowUserActionsForGuide": true, - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "guideCartPermissionsGranted": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "guideCartPermissionsGranted": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "guideCartPermissionsGranted": false - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } - } - }, - "JoinAppointmentResponse": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "mercureSubscriberTopics": { - "type": "array", - "items": { - "type": "string", - "description": "mercure topic" - }, - "description": "The topics to which the attendee/guide can subscribe for" - }, - "mercurePublisherTopic": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" - }, - "JWTMercureSubscriberToken": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to publish updates" - }, - "mercureHubPublicUrl": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The mercure hub url to connect for subscribing and updating" - }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The JWT mercure token to subscribe for updates" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" - }, - "newContextToken": { - "type": "string", - "description": "The new context token" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" - }, - "presentationGuideMode": { - "type": "string", - "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" - }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" - } - }, - "example": { - "mercureSubscriberTopics": [ - "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" - ], - "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", - "JWTMercureSubscriberToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6WyJncy1ndWlkZS1hY3Rpb25zLTJkMmMzNThmMWNhMDQwOThhYWNmMTI4NzNjMmVlZDgyIiwiZ3MtcHJlc2VudGF0aW9uLXN0YXRlLWZvci1jbGllbnQtMmQyYzM1OGYxY2EwNDA5OGFhY2YxMjg3M2MyZWVkODIiLCJncy1wcmVzZW50YXRpb24tc3RhdGUtZm9yLWFsbC0yZDJjMzU4ZjFjYTA0MDk4YWFjZjEyODczYzJlZWQ4MiJdLCJwdWJsaXNoIjpbXX19.UUkrRCu9PT2FOhkxhWKLo8nUGzwI7l3zqVo74laI-D8", - "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", - "JWTMercurePublisherToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InN1YnNjcmliZSI6W10sInB1Ymxpc2giOlsiZ3MtY2xpZW50LWFjdGlvbnMtMmQyYzM1OGYxY2EwNDA5OGFhY2YxMjg3M2MyZWVkODIiXX19.g5-_JrB2xdeByr40t7XnnK_qxqOclaY5MKBpTytdFmY", - "id": "2d2c358f1ca04098aacf12873c2eed82", - "newContextToken": "VR9yWqI2ovhNpdRFWbbn6Z5Fy4wUmDsm", - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", - "presentationGuideMode": "guided", - "isPreview": false, - "apiAlias": "swag_guided_shopping_content_appointment_struct_appointment_join_struct" - } - }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" - }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" - }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" - } - }, - "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - } - }, - "VideoChat": { - "type": "object", + "User": { + "description": "Added since version: 6.0.0.0", "required": [ - "appointmentId" + "id", + "localeId", + "username", + "firstName", + "lastName", + "email", + "timeZone", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointment": { - "$ref": "#/components/schemas/Appointment" + "username": { + "type": "string" }, - "ownerToken": { + "firstName": { "type": "string" }, - "userToken": { + "lastName": { "type": "string" }, - "url": { + "title": { + "type": "string" + }, + "email": { "type": "string" }, - "startAsBroadcast": { + "active": { "type": "boolean" - } - } - }, - "StateForAll": { - "type": "object", - "properties": { - "currentGuideProductId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] }, - "lastActiveGuideSection": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "admin": { + "type": "boolean" }, - "currentPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] + "lastUpdatedPasswordAt": { + "type": "string", + "format": "date-time" }, - "currentSectionId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" + "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" }, - "currentSlideAlias": { - "type": "integer", - "default": 0 + "locale": { + "$ref": "#/components/schemas/Locale" }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" + "avatarMedia": { + "$ref": "#/components/schemas/Media" }, - "started": { - "type": "boolean", - "default": false + "media": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } }, - "running": { - "type": "boolean", - "default": false + "accessKeys": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } }, - "ended": { - "type": "boolean", - "default": false + "configs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } }, - "startedAt": { - "anyOf": [ - { + "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", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ] - }, - "endedAt": { - "anyOf": [ - { + "userId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ] - }, - "accessibleFrom": { - "anyOf": [ - { + "accessKey": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" + }, + "lastUsageAt": { "type": "string", "format": "date-time" }, - { - "type": "null" - } - ] - }, - "accessibleTo": { - "anyOf": [ - { + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", - "format": "date-time" + "format": "date-time", + "readOnly": true }, - { - "type": "null" + "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}$" }, - "appointmentMode": { + "userId": { "type": "string", - "enum": [ - "guided", - "self" - ] + "pattern": "^[0-9a-f]{32}$" + }, + "accessKey": { + "type": "string" + }, + "secretAccessKey": { + "type": "string" }, - "videoAudioSettings": { + "lastUsageAt": { "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" + "format": "date-time" + }, + "customFields": { + "type": "object" }, - "videoRoomUrl": { + "createdAt": { "type": "string", - "default": "" + "format": "date-time", + "readOnly": true }, - "attendeeRestrictionType": { - "anyOf": [ - { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] - }, - { - "type": "null" - } - ] + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "productDetailDefaultPageId": { - "anyOf": [ - { + "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}$" }, - { - "type": "null" - } - ] - }, - "quickviewPageId": { - "anyOf": [ - { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - { - "type": "null" - } - ] - }, - "productListingDefaultPageId": { - "anyOf": [ - { + "key": { + "type": "string" + }, + "value": { + "type": "object" + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - { - "type": "null" + "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" } - ] - }, - "allowUserActionsForGuide": { - "type": "boolean", - "default": false - }, - "broadcastMode": { - "type": "boolean", - "default": false - }, - "extensions": { - "type": "array", - "default": [] + }, + "type": "object" } - } + ] }, - "AttendeeProductCollection": { - "type": "object", + "UserConfig": { + "description": "Added since version: 6.3.5.0", "required": [ - "attendeeId", - "productId", - "productVersionId", - "alias" + "id", + "userId", + "key", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "attendeeId": { + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "attendee": { - "$ref": "#/components/schemas/Attendee" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "key": { + "type": "string" }, - "product": { - "$ref": "#/components/schemas/Product" + "value": { + "type": "object" }, - "productVersionId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "alias": { + "updatedAt": { "type": "string", - "enum": [ - "liked", - "disliked" - ] + "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" } - } + ] }, - "Interaction": { - "type": "object", + "UserRecovery": { + "description": "Added since version: 6.0.0.0", "required": [ - "name", - "triggeredAt", - "attendeeId" + "id", + "hash", + "userId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "hash": { "type": "string" }, - "expiresAt": { + "userId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "triggeredAt": { + "createdAt": { "type": "string", - "format": "date-time" - }, - "payload": { - "type": "string" + "format": "date-time", + "readOnly": true }, - "attendeeId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "attendee": { - "$ref": "#/components/schemas/Attendee" + "user": { + "$ref": "#/components/schemas/User" } - } + }, + "type": "object" }, - "Presentation": { - "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": [ - "name" + "id", + "name", + "eventName", + "url", + "errorCount", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "active": { - "type": "boolean" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "eventName": { + "type": "string" }, - "createdBy": { - "$ref": "#/components/schemas/User" + "url": { + "type": "string" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "onlyLiveVersion": { + "type": "boolean" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "errorCount": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "translations": { - "type": "array", - "items": { - "type": "object" - } + "active": { + "type": "boolean" }, - "appointment": { - "$ref": "#/components/schemas/Appointment" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsPages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PresentationCmsPage" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "translated": { - "type": "object" - } - } - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "updatedAt": { "type": "string", - "description": "The type of the current dynamic page" + "format": "date-time", + "readOnly": true }, - "opened": { - "type": "boolean", - "default": true + "app": { + "$ref": "#/components/schemas/App" } - } + }, + "type": "object" }, - "StateForGuides": { - "type": "object", - "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "guides": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "WebhookEventLogJsonApi": { + "description": "Added since version: 6.4.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "videoGuideToken": { - "anyOf": [ - { + { + "required": [ + "id", + "webhookName", + "eventName", + "deliveryStatus", + "url", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { "type": "string" }, - { - "type": "null" + "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 } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" }, - "default": [] - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "VideoChatCreateStruct": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { - "type": "string", - "description": "Name of the video room in daily" - }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" - }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" - }, - "startAsBroadcast": { - "type": "boolean", - "default": false - } - }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "eyJhbGciOiJIUzI1NbIsInR5cCI6IkpXVCJ9.eyJyIjoiclNx4jBtcmd3Umo0ZUlYbzF1OTUiLCJvIjpmYWxzZSwiZCI6ImE2MmJkMTUzLTI2ZjYtNDc4OC04NGRjLWMzZjdkZDcyZGIxMiIsImlhdCI6MTY5MTc0MTgwOH0.jDdnfL2h9_mDoME2_CESbzUXYFQEgQLizXr47vUD6_c", - "ownerToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyIjoiclN3djBtcmd3Umo0ZUlYbzF1OTUiLCJvIjp0cnVlLCJkIjoiYTYyYmQxNTMtMjZmNi00Nzg4LTg0ZGMtYzNmN2RkNzJkYjEyIiwiaWF0IjoxNjkfNzQxODA4fQ.6hS8LKZndPBNRXBwHtF7pdeTBt02PIzeRNYamBJPo9E", - "roomName": "rSq20mrgwsj4eIXo1u95", - "startAsBroadcast": false, - "extensions": [] - } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" + "type": "object" } - } + ] }, - "Attendee": { - "type": "object", + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", "required": [ - "appointmentId", - "type" + "id", + "webhookName", + "eventName", + "deliveryStatus", + "url", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appointmentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appointment": { - "$ref": "#/components/schemas/Appointment" - }, - "type": { - "type": "string", - "enum": [ - "CLIENT", - "GUIDE" - ] + "appName": { + "type": "string" }, - "attendeeName": { + "webhookName": { "type": "string" }, - "attendeeEmail": { + "eventName": { "type": "string" }, - "videoUserId": { + "deliveryStatus": { "type": "string" }, - "guideCartPermissionsGranted": { - "type": "boolean" + "timestamp": { + "type": "integer", + "format": "int64" }, - "attendeeSubmittedAt": { - "type": "string", - "format": "date-timme" + "processingTime": { + "type": "integer", + "format": "int64" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "appVersion": { + "type": "string" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "requestContent": { + "type": "object" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "responseContent": { + "type": "object" }, - "user": { - "$ref": "#/components/schemas/User" + "responseStatusCode": { + "type": "integer", + "format": "int64" }, - "invitationStatus": { + "responseReasonPhrase": { "type": "string" }, - "joinedAt": { - "type": "string", - "format": "date-timme" + "url": { + "type": "string" }, - "lastActive": { - "type": "string", - "format": "date-timme" + "onlyLiveVersion": { + "type": "boolean" }, - "interaction": { - "$ref": "#/components/schemas/Interaction" + "customFields": { + "type": "object" }, - "productCollections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeProductCollection" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } - } + }, + "type": "object" }, - "GetCartInsightsResponse": { + "infoConfigResponse": { "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" - }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" - }, - "currencyId": { + "version": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" + "description": "The Shopware version." }, - "currencySymbol": { + "versionRevision": { "type": "string", - "description": "The currency symbol from the shown currency" + "description": "The Shopware version revision." }, - "topProducts": { + "adminWorker": { "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], + "description": "Information about the admin worker.", "properties": { - "byQuantity": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] - } + "enableAdminWorker": { + "type": "boolean", + "description": "State of the admin worker." }, - "byRevenue": { + "transports": { "type": "array", - "uniqueItems": true, + "description": "Configured transports.", "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The net revenue in the shown currency in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] + "type": "string" } } } - } - }, - "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 + }, + "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." + } + } } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 - }, - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 + } + }, + "settings": { + "type": "object", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." } - ] + } } } }, - "GetAttendeeInsightsResponse": { + "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", - "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "attendees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencySymbol": { + "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" } }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } } }, - "DynamicPageOpenedPayload": { + "OAuthClientCredentialsGrant": { "allOf": [ { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, - "PresentationCmsPage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation cms page id" + "$ref": "#/components/schemas/OAuthGrant" }, - "title": { - "anyOf": [ - { + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", "type": "string" }, - { - "type": "null" + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" } - ], - "description": "The title of presentation cms page" - }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation using this presentation cms page" - }, - "guidedShoppingPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page id the presentation using" - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page version id the presentation using" + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "productId": { - "anyOf": [ - { + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "administration" + ] }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product detail" - }, - "productStreamId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" }, - { - "type": "null" - } - ], - "description": "The product stream id is assigned to presentation if it's product listing" - }, - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" }, - { - "type": "null" + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" - }, - "position": { - "type": "integer", - "description": "The position of slide" - }, - "isInstantListing": { - "type": "boolean", - "description": "True if this slide is an instant listing" - }, - "createdAt": { - "type": "string", - "format": "date-time" + }, + "required": [ + "client_id", + "scopes", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" }, - "updatedAt": { - "anyOf": [ - { + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", "type": "string", - "format": "date-time" + "enum": [ + "administration" + ] }, - { - "type": "null" - } - ] - }, - "customFields": { - "anyOf": [ - { - "type": "object" + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" }, - { - "type": "null" + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" } + }, + "required": [ + "client_id", + "scopes", + "refresh_token" ] - }, - "translated": { - "type": "object", - "properties": { - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + } + ] + }, + "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" } } } } }, - "Appointment": { + "Criteria": { "type": "object", - "required": [ - "name", - "guideUserId", - "salesChannelDomainId", - "presentationPath" - ], + "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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "presentation": { - "$ref": "#/components/schemas/Presentation" - }, - "active": { - "type": "boolean" - }, - "isPreview": { - "type": "boolean" - }, - "default": { - "type": "boolean" - }, - "guideUserId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "guideUser": { - "$ref": "#/components/schemas/User" + "page": { + "description": "Search result page", + "type": "integer" }, - "mode": { - "type": "string", - "enum": [ - "guide", - "self" - ] + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "salesChannelDomainId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + ] + } }, - "presentationPath": { - "type": "string" + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + }, + "naturalSorting": { + "type": "boolean" + } + }, + "required": [ + "field" + ] + } }, - "attendeeRestrictionType": { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] + "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" + ] + } }, - "accessibleFrom": { - "type": "string", - "format": "date-time" + "associations": { + "type": "object", + "description": "Used to fetch associations which are not fetched by default." }, - "accessibleTo": { - "type": "string", - "format": "date-time" + "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" + ] + } }, - "attendeeRuleIds": { + "grouping": { "type": "array", + "description": "Perform groupings over certain fields", "items": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Name of a field" } }, - "attendees": { + "fields": { "type": "array", + "description": "Fields which should be returned in the search result.", "items": { - "$ref": "#/components/schemas/Attendee" + "type": "string", + "description": "Name of a field" } }, - "message": { - "type": "string" - }, - "videoAudioSettings": { + "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", - "both", - "audio_only" + "exact", + "next-pages" ] - }, - "videoChat": { - "$ref": "#/components/schemas/VideoChat" - }, - "startedAt": { - "type": "string", - "format": "date-time" - }, - "endedAt": { - "type": "string", - "format": "date-time" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" + } + } + }, + "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" + } } } } @@ -43860,6 +39616,195 @@ }, "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": { @@ -44047,34 +39992,6 @@ "name": "Flow Template", "description": "The endpoint for operations on Flow Template" }, - { - "name": "Guided Shopping Appointment", - "description": "The endpoint for operations on Guided Shopping Appointment" - }, - { - "name": "Guided Shopping Appointment Attendee", - "description": "The endpoint for operations on Guided Shopping Appointment Attendee" - }, - { - "name": "Guided Shopping Appointment Video Chat", - "description": "The endpoint for operations on Guided Shopping Appointment Video Chat" - }, - { - "name": "Guided Shopping Attendee Product Collection", - "description": "The endpoint for operations on Guided Shopping Attendee Product Collection" - }, - { - "name": "Guided Shopping Interaction", - "description": "The endpoint for operations on Guided Shopping Interaction" - }, - { - "name": "Guided Shopping Presentation", - "description": "The endpoint for operations on Guided Shopping Presentation" - }, - { - "name": "Guided Shopping Presentation Cms Page", - "description": "The endpoint for operations on Guided Shopping Presentation Cms Page" - }, { "name": "Import Export File", "description": "The endpoint for operations on Import Export File" From 25b8b73c3606db5b4094c89ede2de63a71e768d9 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 27 Sep 2024 08:04:31 +0200 Subject: [PATCH 23/63] [create-pull-request] automated change (#307) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 57602 ++++++++++++++++++++++++--------- 1 file changed, 41651 insertions(+), 15951 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 5380491..c862467 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -3,7 +3,11 @@ "info": { "title": "Shopware Admin API", "description": "This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.\n\nFor a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints\nadd the query parameter `type=jsonapi`.", - "version": "6.5.7.3" + "license": { + "name": "MIT", + "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" + }, + "version": "6.6.6.1" }, "servers": [ { @@ -11,6 +15,80 @@ } ], "paths": { + "/search/acl-role": { + "post": { + "tags": [ + "Acl Role" + ], + "summary": "Search for the Acl Role resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchAclRole", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-action": { "get": { "tags": [ @@ -193,7 +271,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchAction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-action": { + "post": { + "tags": [ + "Advanced Search Action" + ], + "summary": "Search for the Advanced Search Action resources.", + "description": "", + "operationId": "searchAdvancedSearchAction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } } } } @@ -250,7 +410,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchAction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } } } } @@ -381,7 +549,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchAction" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } } } } @@ -580,7 +756,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-action-search-term": { + "post": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Search for the Advanced Search Action Search Term resources.", + "description": "", + "operationId": "searchAdvancedSearchActionSearchTerm", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } } } } @@ -637,7 +895,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } } } } @@ -768,7 +1034,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } } } } @@ -967,64 +1241,154 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/advanced-search-boosting/{id}": { - "get": { - "tags": [ - "Advanced Search Boosting" - ], - "summary": "Detailed information about a Advanced Search Boosting resource.", - "description": "", - "operationId": "getAdvancedSearchBoosting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the advanced_search_boosting", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AdvancedSearchBoosting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-boosting": { + "post": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "Search for the Advanced Search Boosting resources.", + "description": "", + "operationId": "searchAdvancedSearchBoosting", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchBoosting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-boosting/{id}": { + "get": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "Detailed information about a Advanced Search Boosting resource.", + "description": "", + "operationId": "getAdvancedSearchBoosting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_boosting", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchBoosting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } } } } @@ -1155,7 +1519,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } } } } @@ -1354,7 +1726,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-config": { + "post": { + "tags": [ + "Advanced Search Config" + ], + "summary": "Search for the Advanced Search Config resources.", + "description": "", + "operationId": "searchAdvancedSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } } } } @@ -1411,7 +1865,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } } } } @@ -1542,7 +2004,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchConfig" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } } } } @@ -1741,64 +2211,154 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/advanced-search-config-field/{id}": { - "get": { - "tags": [ - "Advanced Search Config Field" - ], - "summary": "Detailed information about a Advanced Search Config Field resource.", - "description": "", - "operationId": "getAdvancedSearchConfigField", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the advanced_search_config_field", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AdvancedSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-config-field": { + "post": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "Search for the Advanced Search Config Field resources.", + "description": "", + "operationId": "searchAdvancedSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-config-field/{id}": { + "get": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "Detailed information about a Advanced Search Config Field resource.", + "description": "", + "operationId": "getAdvancedSearchConfigField", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_config_field", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } } } } @@ -1929,7 +2489,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } } } } @@ -2128,7 +2696,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-entity-stream": { + "post": { + "tags": [ + "Advanced Search Entity Stream" + ], + "summary": "Search for the Advanced Search Entity Stream resources.", + "description": "", + "operationId": "searchAdvancedSearchEntityStream", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchEntityStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } } } } @@ -2185,7 +2835,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } } } } @@ -2316,7 +2974,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } } } } @@ -2515,64 +3181,154 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/advanced-search-entity-stream-filter/{id}": { - "get": { - "tags": [ - "Advanced Search Entity Stream Filter" - ], - "summary": "Detailed information about a Advanced Search Entity Stream Filter resource.", - "description": "", - "operationId": "getAdvancedSearchEntityStreamFilter", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the advanced_search_entity_stream_filter", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of AdvancedSearchEntityStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-entity-stream-filter": { + "post": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Search for the Advanced Search Entity Stream Filter resources.", + "description": "", + "operationId": "searchAdvancedSearchEntityStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchEntityStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/advanced-search-entity-stream-filter/{id}": { + "get": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Detailed information about a Advanced Search Entity Stream Filter resource.", + "description": "", + "operationId": "getAdvancedSearchEntityStreamFilter", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the advanced_search_entity_stream_filter", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of AdvancedSearchEntityStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } } } } @@ -2703,7 +3459,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } } } } @@ -2902,7 +3666,89 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchSynonym" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/advanced-search-synonym": { + "post": { + "tags": [ + "Advanced Search Synonym" + ], + "summary": "Search for the Advanced Search Synonym resources.", + "description": "", + "operationId": "searchAdvancedSearchSynonym", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AdvancedSearchSynonym", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } } } } @@ -2959,7 +3805,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchSynonym" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } } } } @@ -3090,7 +3944,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AdvancedSearchSynonym" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } } } } @@ -3107,43 +3969,32 @@ } } }, - "/app-shipping-method": { - "get": { + "/search/app": { + "post": { "tags": [ - "App Shipping Method" + "App" ], - "summary": "List with basic information of App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "getAppShippingMethodList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the App resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchApp", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of App Shipping Method resources.", + "description": "List of App", "content": { "application/vnd.api+json": { "schema": { @@ -3155,41 +4006,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/app-shipping-method?limit=25" - }, - "last": { - "example": "/app-shipping-method?limit=25&page=11" - }, - "next": { - "example": "/app-shipping-method?limit=25&page=4" - }, - "prev": { - "example": "/app-shipping-method?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -3206,7 +4026,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/App" } } } @@ -3214,61 +4034,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/app-action-button": { "post": { "tags": [ - "App Shipping Method" - ], - "summary": "Create a new App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "createAppShippingMethod", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App Action Button" ], + "summary": "Search for the App Action Button resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchAppActionButton", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "List of AppActionButton", "content": { "application/vnd.api+json": { "schema": { @@ -3280,7 +4080,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } } } } @@ -3289,7 +4092,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } } } } @@ -3303,29 +4117,32 @@ } } }, - "/app-shipping-method/{id}": { - "get": { + "/search/app-administration-snippet": { + "post": { "tags": [ - "App Shipping Method" + "App Administration Snippet" ], - "summary": "Detailed information about a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "getAppShippingMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_shipping_method", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the App Administration Snippet resources.", + "description": "Available since: 6.4.15.0", + "operationId": "searchAppAdministrationSnippet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "List of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { @@ -3337,7 +4154,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } @@ -3346,117 +4166,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "App Shipping Method" - ], - "summary": "Delete a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "deleteAppShippingMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_shipping_method", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/app-cms-block": { + "post": { "tags": [ - "App Shipping Method" - ], - "summary": "Partially update information about a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "updateAppShippingMethod", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the app_shipping_method", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Cms Block" ], + "summary": "Search for the App Cms Block resources.", + "description": "Available since: 6.4.2.0", + "operationId": "searchAppCmsBlock", "requestBody": { - "description": "Partially update information about a App Shipping Method resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "List of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -3468,7 +4228,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -3477,7 +4240,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } } } } @@ -3485,52 +4259,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/b2b-business-partner": { - "get": { + "/search/app-flow-action": { + "post": { "tags": [ - "B2b Business Partner" + "App Flow Action" ], - "summary": "List with basic information of B2b Business Partner resources.", - "description": "", - "operationId": "getB2bBusinessPartnerList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the App Flow Action resources.", + "description": "Available since: 6.4.10.0", + "operationId": "searchAppFlowAction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of B2b Business Partner resources.", + "description": "List of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { @@ -3542,41 +4302,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bBusinessPartner" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/b2b-business-partner?limit=25" - }, - "last": { - "example": "/b2b-business-partner?limit=25&page=11" - }, - "next": { - "example": "/b2b-business-partner?limit=25&page=4" - }, - "prev": { - "example": "/b2b-business-partner?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } } } } @@ -3593,7 +4322,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/AppFlowAction" } } } @@ -3601,61 +4330,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/app-flow-event": { "post": { "tags": [ - "B2b Business Partner" - ], - "summary": "Create a new B2b Business Partner resources.", - "description": "", - "operationId": "createB2bBusinessPartner", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App Flow Event" ], + "summary": "Search for the App Flow Event resources.", + "description": "Available since: 6.5.2.0", + "operationId": "searchAppFlowEvent", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of B2bBusinessPartner", + "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { @@ -3667,7 +4376,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -3676,7 +4388,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } } } } @@ -3690,29 +4413,32 @@ } } }, - "/b2b-business-partner/{id}": { - "get": { + "/search/app-payment-method": { + "post": { "tags": [ - "B2b Business Partner" + "App Payment Method" ], - "summary": "Detailed information about a B2b Business Partner resource.", - "description": "", - "operationId": "getB2bBusinessPartner", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the b2b_business_partner", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the App Payment Method resources.", + "description": "Available since: 6.4.1.0", + "operationId": "searchAppPaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of B2bBusinessPartner", + "description": "List of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -3724,7 +4450,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } } } } @@ -3733,117 +4462,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "B2b Business Partner" - ], - "summary": "Delete a B2b Business Partner resource.", - "description": "", - "operationId": "deleteB2bBusinessPartner", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the b2b_business_partner", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/app-script-condition": { + "post": { "tags": [ - "B2b Business Partner" - ], - "summary": "Partially update information about a B2b Business Partner resource.", - "description": "", - "operationId": "updateB2bBusinessPartner", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the b2b_business_partner", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Script Condition" ], + "summary": "Search for the App Script Condition resources.", + "description": "Available since: 6.4.10.3", + "operationId": "searchAppScriptCondition", "requestBody": { - "description": "Partially update information about a B2b Business Partner resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of B2bBusinessPartner", + "description": "List of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -3855,7 +4524,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } @@ -3864,7 +4536,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } } } } @@ -3872,23 +4555,20 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/b2b-components-role": { + "/app-shipping-method": { "get": { "tags": [ - "B2b Components Role" + "App Shipping Method" ], - "summary": "List with basic information of B2b Components Role resources.", - "description": "", - "operationId": "getB2bComponentsRoleList", + "summary": "List with basic information of App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "getAppShippingMethodList", "parameters": [ { "name": "limit", @@ -3917,7 +4597,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Role resources.", + "description": "List of App Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3936,7 +4616,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } ] @@ -3950,16 +4630,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-role?limit=25" + "example": "/app-shipping-method?limit=25" }, "last": { - "example": "/b2b-components-role?limit=25&page=11" + "example": "/app-shipping-method?limit=25&page=11" }, "next": { - "example": "/b2b-components-role?limit=25&page=4" + "example": "/app-shipping-method?limit=25&page=4" }, "prev": { - "example": "/b2b-components-role?limit=25&page=2" + "example": "/app-shipping-method?limit=25&page=2" } } } @@ -3980,7 +4660,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -3995,11 +4675,11 @@ }, "post": { "tags": [ - "B2b Components Role" + "App Shipping Method" ], - "summary": "Create a new B2b Components Role resources.", - "description": "", - "operationId": "createB2bComponentsRole", + "summary": "Create a new App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "createAppShippingMethod", "parameters": [ { "name": "_response", @@ -4021,7 +4701,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" }, "included": { "type": "array", @@ -4035,14 +4715,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -4054,7 +4734,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -4063,7 +4743,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } } } } @@ -4077,19 +4765,93 @@ } } }, - "/b2b-components-role/{id}": { + "/search/app-shipping-method": { + "post": { + "tags": [ + "App Shipping Method" + ], + "summary": "Search for the App Shipping Method resources.", + "description": "Available since: 6.5.7.0", + "operationId": "searchAppShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/app-shipping-method/{id}": { "get": { "tags": [ - "B2b Components Role" + "App Shipping Method" ], - "summary": "Detailed information about a B2b Components Role resource.", - "description": "", - "operationId": "getB2bComponentsRole", + "summary": "Detailed information about a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "getAppShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", @@ -4099,7 +4861,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -4111,7 +4873,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -4120,7 +4882,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } } } } @@ -4135,16 +4905,16 @@ }, "delete": { "tags": [ - "B2b Components Role" + "App Shipping Method" ], - "summary": "Delete a B2b Components Role resource.", - "description": "", - "operationId": "deleteB2bComponentsRole", + "summary": "Delete a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "deleteAppShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", @@ -4175,16 +4945,16 @@ }, "patch": { "tags": [ - "B2b Components Role" + "App Shipping Method" ], - "summary": "Partially update information about a B2b Components Role resource.", - "description": "", - "operationId": "updateB2bComponentsRole", + "summary": "Partially update information about a App Shipping Method resource.", + "description": "Available since: 6.5.7.0", + "operationId": "updateAppShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the app_shipping_method", "required": true, "schema": { "type": "string", @@ -4202,14 +4972,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Role resource.", + "description": "Partially update information about a App Shipping Method resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" }, "included": { "type": "array", @@ -4223,14 +4993,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -4242,7 +5012,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/AppShippingMethod" } } } @@ -4251,7 +5021,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } } } } @@ -4268,14 +5046,88 @@ } } }, - "/b2b-employee": { + "/search/app-template": { + "post": { + "tags": [ + "App Template" + ], + "summary": "Search for the App Template resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchAppTemplate", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-business-partner": { "get": { "tags": [ - "B2b Employee" + "B2b Business Partner" ], - "summary": "List with basic information of B2b Employee resources.", + "summary": "List with basic information of B2b Business Partner resources.", "description": "", - "operationId": "getB2bEmployeeList", + "operationId": "getB2bBusinessPartnerList", "parameters": [ { "name": "limit", @@ -4304,7 +5156,7 @@ ], "responses": { "200": { - "description": "List of B2b Employee resources.", + "description": "List of B2b Business Partner resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4323,7 +5175,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } ] @@ -4337,16 +5189,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-employee?limit=25" + "example": "/b2b-business-partner?limit=25" }, "last": { - "example": "/b2b-employee?limit=25&page=11" + "example": "/b2b-business-partner?limit=25&page=11" }, "next": { - "example": "/b2b-employee?limit=25&page=4" + "example": "/b2b-business-partner?limit=25&page=4" }, "prev": { - "example": "/b2b-employee?limit=25&page=2" + "example": "/b2b-business-partner?limit=25&page=2" } } } @@ -4367,7 +5219,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4382,11 +5234,11 @@ }, "post": { "tags": [ - "B2b Employee" + "B2b Business Partner" ], - "summary": "Create a new B2b Employee resources.", + "summary": "Create a new B2b Business Partner resources.", "description": "", - "operationId": "createB2bEmployee", + "operationId": "createB2bBusinessPartner", "parameters": [ { "name": "_response", @@ -4408,7 +5260,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" }, "included": { "type": "array", @@ -4422,14 +5274,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4441,7 +5293,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4450,7 +5302,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } } } } @@ -4464,19 +5324,93 @@ } } }, - "/b2b-employee/{id}": { + "/search/b2b-business-partner": { + "post": { + "tags": [ + "B2b Business Partner" + ], + "summary": "Search for the B2b Business Partner resources.", + "description": "", + "operationId": "searchB2bBusinessPartner", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bBusinessPartner", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-business-partner/{id}": { "get": { "tags": [ - "B2b Employee" + "B2b Business Partner" ], - "summary": "Detailed information about a B2b Employee resource.", + "summary": "Detailed information about a B2b Business Partner resource.", "description": "", - "operationId": "getB2bEmployee", + "operationId": "getB2bBusinessPartner", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_business_partner", "required": true, "schema": { "type": "string", @@ -4486,7 +5420,7 @@ ], "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4498,7 +5432,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4507,7 +5441,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } } } } @@ -4522,16 +5464,16 @@ }, "delete": { "tags": [ - "B2b Employee" + "B2b Business Partner" ], - "summary": "Delete a B2b Employee resource.", + "summary": "Delete a B2b Business Partner resource.", "description": "", - "operationId": "deleteB2bEmployee", + "operationId": "deleteB2bBusinessPartner", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_business_partner", "required": true, "schema": { "type": "string", @@ -4562,16 +5504,16 @@ }, "patch": { "tags": [ - "B2b Employee" + "B2b Business Partner" ], - "summary": "Partially update information about a B2b Employee resource.", + "summary": "Partially update information about a B2b Business Partner resource.", "description": "", - "operationId": "updateB2bEmployee", + "operationId": "updateB2bBusinessPartner", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_business_partner", "required": true, "schema": { "type": "string", @@ -4589,14 +5531,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Employee resource.", + "description": "Partially update information about a B2b Business Partner resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" }, "included": { "type": "array", @@ -4610,14 +5552,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4629,7 +5571,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4638,7 +5580,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } } } } @@ -4655,14 +5605,14 @@ } } }, - "/b2b-order-employee": { + "/b2b-components-approval-rule": { "get": { "tags": [ - "B2b Order Employee" + "B2b Components Approval Rule" ], - "summary": "List with basic information of B2b Order Employee resources.", - "description": "", - "operationId": "getB2bOrderEmployeeList", + "summary": "List with basic information of B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRuleList", "parameters": [ { "name": "limit", @@ -4691,7 +5641,7 @@ ], "responses": { "200": { - "description": "List of B2b Order Employee resources.", + "description": "List of B2b Components Approval Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4710,7 +5660,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } ] @@ -4724,16 +5674,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-order-employee?limit=25" + "example": "/b2b-components-approval-rule?limit=25" }, "last": { - "example": "/b2b-order-employee?limit=25&page=11" + "example": "/b2b-components-approval-rule?limit=25&page=11" }, "next": { - "example": "/b2b-order-employee?limit=25&page=4" + "example": "/b2b-components-approval-rule?limit=25&page=4" }, "prev": { - "example": "/b2b-order-employee?limit=25&page=2" + "example": "/b2b-components-approval-rule?limit=25&page=2" } } } @@ -4754,7 +5704,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4769,11 +5719,11 @@ }, "post": { "tags": [ - "B2b Order Employee" + "B2b Components Approval Rule" ], - "summary": "Create a new B2b Order Employee resources.", - "description": "", - "operationId": "createB2bOrderEmployee", + "summary": "Create a new B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsApprovalRule", "parameters": [ { "name": "_response", @@ -4795,7 +5745,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" }, "included": { "type": "array", @@ -4809,14 +5759,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -4828,7 +5778,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4837,7 +5787,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } } } } @@ -4851,19 +5809,93 @@ } } }, - "/b2b-order-employee/{id}": { + "/search/b2b-components-approval-rule": { + "post": { + "tags": [ + "B2b Components Approval Rule" + ], + "summary": "Search for the B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsApprovalRule", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsApprovalRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-approval-rule/{id}": { "get": { "tags": [ - "B2b Order Employee" + "B2b Components Approval Rule" ], - "summary": "Detailed information about a B2b Order Employee resource.", - "description": "", - "operationId": "getB2bOrderEmployee", + "summary": "Detailed information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -4873,7 +5905,7 @@ ], "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -4885,7 +5917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4894,7 +5926,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } } } } @@ -4909,16 +5949,16 @@ }, "delete": { "tags": [ - "B2b Order Employee" + "B2b Components Approval Rule" ], - "summary": "Delete a B2b Order Employee resource.", - "description": "", - "operationId": "deleteB2bOrderEmployee", + "summary": "Delete a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -4949,16 +5989,16 @@ }, "patch": { "tags": [ - "B2b Order Employee" + "B2b Components Approval Rule" ], - "summary": "Partially update information about a B2b Order Employee resource.", - "description": "", - "operationId": "updateB2bOrderEmployee", + "summary": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -4976,14 +6016,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Order Employee resource.", + "description": "Partially update information about a B2b Components Approval Rule resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" }, "included": { "type": "array", @@ -4997,14 +6037,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5016,7 +6056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5025,7 +6065,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } } } } @@ -5042,14 +6090,14 @@ } } }, - "/b2b-permission": { + "/b2b-components-approval-rule-app-script-condition": { "get": { "tags": [ - "B2b Permission" + "B2b Components Approval Rule App Script Condition" ], - "summary": "List with basic information of B2b Permission resources.", - "description": "", - "operationId": "getB2bPermissionList", + "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", "parameters": [ { "name": "limit", @@ -5078,7 +6126,7 @@ ], "responses": { "200": { - "description": "List of B2b Permission resources.", + "description": "List of B2b Components Approval Rule App Script Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5097,7 +6145,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } ] @@ -5111,16 +6159,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-permission?limit=25" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25" }, "last": { - "example": "/b2b-permission?limit=25&page=11" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" }, "next": { - "example": "/b2b-permission?limit=25&page=4" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" }, "prev": { - "example": "/b2b-permission?limit=25&page=2" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" } } } @@ -5141,7 +6189,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5156,11 +6204,11 @@ }, "post": { "tags": [ - "B2b Permission" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Create a new B2b Permission resources.", - "description": "", - "operationId": "createB2bPermission", + "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "_response", @@ -5182,7 +6230,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" }, "included": { "type": "array", @@ -5196,14 +6244,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5215,7 +6263,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5224,7 +6272,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } } } } @@ -5238,19 +6294,93 @@ } } }, - "/b2b-permission/{id}": { + "/search/b2b-components-approval-rule-app-script-condition": { + "post": { + "tags": [ + "B2b Components Approval Rule App Script Condition" + ], + "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsApprovalRuleAppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-approval-rule-app-script-condition/{id}": { "get": { "tags": [ - "B2b Permission" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Detailed information about a B2b Permission resource.", - "description": "", - "operationId": "getB2bPermission", + "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -5260,7 +6390,7 @@ ], "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5272,7 +6402,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5281,7 +6411,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } } } } @@ -5296,16 +6434,16 @@ }, "delete": { "tags": [ - "B2b Permission" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Delete a B2b Permission resource.", - "description": "", - "operationId": "deleteB2bPermission", + "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -5336,16 +6474,16 @@ }, "patch": { "tags": [ - "B2b Permission" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Partially update information about a B2b Permission resource.", - "description": "", - "operationId": "updateB2bPermission", + "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -5363,14 +6501,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Permission resource.", + "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" }, "included": { "type": "array", @@ -5384,14 +6522,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5403,7 +6541,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5412,7 +6550,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } } } } @@ -5429,14 +6575,14 @@ } } }, - "/custom-price": { + "/b2b-components-pending-order": { "get": { "tags": [ - "Custom Price" + "B2b Components Pending Order" ], - "summary": "List with basic information of Custom Price resources.", - "description": "", - "operationId": "getCustomPriceList", + "summary": "List with basic information of B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderList", "parameters": [ { "name": "limit", @@ -5465,7 +6611,7 @@ ], "responses": { "200": { - "description": "List of Custom Price resources.", + "description": "List of B2b Components Pending Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5484,7 +6630,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } ] @@ -5498,16 +6644,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-price?limit=25" + "example": "/b2b-components-pending-order?limit=25" }, "last": { - "example": "/custom-price?limit=25&page=11" + "example": "/b2b-components-pending-order?limit=25&page=11" }, "next": { - "example": "/custom-price?limit=25&page=4" + "example": "/b2b-components-pending-order?limit=25&page=4" }, "prev": { - "example": "/custom-price?limit=25&page=2" + "example": "/b2b-components-pending-order?limit=25&page=2" } } } @@ -5528,7 +6674,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5543,11 +6689,11 @@ }, "post": { "tags": [ - "Custom Price" + "B2b Components Pending Order" ], - "summary": "Create a new Custom Price resources.", - "description": "", - "operationId": "createCustomPrice", + "summary": "Create a new B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrder", "parameters": [ { "name": "_response", @@ -5569,7 +6715,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, "included": { "type": "array", @@ -5583,14 +6729,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5602,7 +6748,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5611,7 +6757,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } } } } @@ -5625,19 +6779,93 @@ } } }, - "/custom-price/{id}": { + "/search/b2b-components-pending-order": { + "post": { + "tags": [ + "B2b Components Pending Order" + ], + "summary": "Search for the B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrder", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsPendingOrder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-pending-order/{id}": { "get": { "tags": [ - "Custom Price" + "B2b Components Pending Order" ], - "summary": "Detailed information about a Custom Price resource.", - "description": "", - "operationId": "getCustomPrice", + "summary": "Detailed information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -5647,7 +6875,7 @@ ], "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5659,7 +6887,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5668,7 +6896,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } } } } @@ -5683,16 +6919,16 @@ }, "delete": { "tags": [ - "Custom Price" + "B2b Components Pending Order" ], - "summary": "Delete a Custom Price resource.", - "description": "", - "operationId": "deleteCustomPrice", + "summary": "Delete a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -5723,16 +6959,16 @@ }, "patch": { "tags": [ - "Custom Price" + "B2b Components Pending Order" ], - "summary": "Partially update information about a Custom Price resource.", - "description": "", - "operationId": "updateCustomPrice", + "summary": "Partially update information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -5750,14 +6986,14 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Price resource.", + "description": "Partially update information about a B2b Components Pending Order resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, "included": { "type": "array", @@ -5771,14 +7007,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5790,7 +7026,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5799,7 +7035,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } } } } @@ -5816,14 +7060,14 @@ } } }, - "/customer-specific-features": { + "/b2b-components-pending-order-address": { "get": { "tags": [ - "Customer Specific Features" + "B2b Components Pending Order Address" ], - "summary": "List with basic information of Customer Specific Features resources.", - "description": "", - "operationId": "getCustomerSpecificFeaturesList", + "summary": "List with basic information of B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderAddressList", "parameters": [ { "name": "limit", @@ -5852,7 +7096,7 @@ ], "responses": { "200": { - "description": "List of Customer Specific Features resources.", + "description": "List of B2b Components Pending Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5871,7 +7115,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } ] @@ -5885,16 +7129,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-specific-features?limit=25" + "example": "/b2b-components-pending-order-address?limit=25" }, "last": { - "example": "/customer-specific-features?limit=25&page=11" + "example": "/b2b-components-pending-order-address?limit=25&page=11" }, "next": { - "example": "/customer-specific-features?limit=25&page=4" + "example": "/b2b-components-pending-order-address?limit=25&page=4" }, "prev": { - "example": "/customer-specific-features?limit=25&page=2" + "example": "/b2b-components-pending-order-address?limit=25&page=2" } } } @@ -5915,7 +7159,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5930,11 +7174,11 @@ }, "post": { "tags": [ - "Customer Specific Features" + "B2b Components Pending Order Address" ], - "summary": "Create a new Customer Specific Features resources.", - "description": "", - "operationId": "createCustomerSpecificFeatures", + "summary": "Create a new B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrderAddress", "parameters": [ { "name": "_response", @@ -5956,7 +7200,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" }, "included": { "type": "array", @@ -5970,14 +7214,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -5989,7 +7233,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5998,7 +7242,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } } } } @@ -6012,19 +7264,93 @@ } } }, - "/customer-specific-features/{id}": { + "/search/b2b-components-pending-order-address": { + "post": { + "tags": [ + "B2b Components Pending Order Address" + ], + "summary": "Search for the B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsPendingOrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-pending-order-address/{id}": { "get": { "tags": [ - "Customer Specific Features" + "B2b Components Pending Order Address" ], - "summary": "Detailed information about a Customer Specific Features resource.", - "description": "", - "operationId": "getCustomerSpecificFeatures", + "summary": "Detailed information about a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -6034,7 +7360,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -6046,7 +7372,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -6055,7 +7381,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } } } } @@ -6070,16 +7404,16 @@ }, "delete": { "tags": [ - "Customer Specific Features" + "B2b Components Pending Order Address" ], - "summary": "Delete a Customer Specific Features resource.", - "description": "", - "operationId": "deleteCustomerSpecificFeatures", + "summary": "Delete a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -6110,16 +7444,16 @@ }, "patch": { "tags": [ - "Customer Specific Features" + "B2b Components Pending Order Address" ], - "summary": "Partially update information about a Customer Specific Features resource.", - "description": "", - "operationId": "updateCustomerSpecificFeatures", + "summary": "Partially update information about a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -6137,14 +7471,14 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Specific Features resource.", + "description": "Partially update information about a B2b Components Pending Order Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" }, "included": { "type": "array", @@ -6158,14 +7492,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -6177,7 +7511,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -6186,7 +7520,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } } } } @@ -6203,14 +7545,14 @@ } } }, - "/media-ai-tag": { + "/b2b-components-role": { "get": { "tags": [ - "Media Ai Tag" + "B2b Components Role" ], - "summary": "List with basic information of Media Ai Tag resources.", + "summary": "List with basic information of B2b Components Role resources.", "description": "", - "operationId": "getMediaAiTagList", + "operationId": "getB2bComponentsRoleList", "parameters": [ { "name": "limit", @@ -6239,7 +7581,7 @@ ], "responses": { "200": { - "description": "List of Media Ai Tag resources.", + "description": "List of B2b Components Role resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6258,7 +7600,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } ] @@ -6272,16 +7614,16 @@ "type": "object", "properties": { "first": { - "example": "/media-ai-tag?limit=25" + "example": "/b2b-components-role?limit=25" }, "last": { - "example": "/media-ai-tag?limit=25&page=11" + "example": "/b2b-components-role?limit=25&page=11" }, "next": { - "example": "/media-ai-tag?limit=25&page=4" + "example": "/b2b-components-role?limit=25&page=4" }, "prev": { - "example": "/media-ai-tag?limit=25&page=2" + "example": "/b2b-components-role?limit=25&page=2" } } } @@ -6302,7 +7644,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6317,11 +7659,11 @@ }, "post": { "tags": [ - "Media Ai Tag" + "B2b Components Role" ], - "summary": "Create a new Media Ai Tag resources.", + "summary": "Create a new B2b Components Role resources.", "description": "", - "operationId": "createMediaAiTag", + "operationId": "createB2bComponentsRole", "parameters": [ { "name": "_response", @@ -6343,7 +7685,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" }, "included": { "type": "array", @@ -6357,14 +7699,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6376,7 +7718,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6385,7 +7727,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } } } } @@ -6399,19 +7749,93 @@ } } }, - "/media-ai-tag/{id}": { + "/search/b2b-components-role": { + "post": { + "tags": [ + "B2b Components Role" + ], + "summary": "Search for the B2b Components Role resources.", + "description": "", + "operationId": "searchB2bComponentsRole", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-role/{id}": { "get": { "tags": [ - "Media Ai Tag" + "B2b Components Role" ], - "summary": "Detailed information about a Media Ai Tag resource.", + "summary": "Detailed information about a B2b Components Role resource.", "description": "", - "operationId": "getMediaAiTag", + "operationId": "getB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -6421,7 +7845,7 @@ ], "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6433,7 +7857,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6442,7 +7866,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } } } } @@ -6457,16 +7889,16 @@ }, "delete": { "tags": [ - "Media Ai Tag" + "B2b Components Role" ], - "summary": "Delete a Media Ai Tag resource.", + "summary": "Delete a B2b Components Role resource.", "description": "", - "operationId": "deleteMediaAiTag", + "operationId": "deleteB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -6497,16 +7929,16 @@ }, "patch": { "tags": [ - "Media Ai Tag" + "B2b Components Role" ], - "summary": "Partially update information about a Media Ai Tag resource.", + "summary": "Partially update information about a B2b Components Role resource.", "description": "", - "operationId": "updateMediaAiTag", + "operationId": "updateB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -6524,14 +7956,14 @@ } ], "requestBody": { - "description": "Partially update information about a Media Ai Tag resource.", + "description": "Partially update information about a B2b Components Role resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" }, "included": { "type": "array", @@ -6545,14 +7977,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6564,7 +7996,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6573,7 +8005,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } } } } @@ -6590,14 +8030,15 @@ } } }, - "/order-product-warehouse": { + "/b2b-components-shopping-list": { "get": { "tags": [ - "Order Product Warehouse" + "B2b Components Shopping List", + "Experimental" ], - "summary": "List with basic information of Order Product Warehouse resources.", - "description": "", - "operationId": "getOrderProductWarehouseList", + "summary": "List with basic information of B2b Components Shopping List 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.2.0", + "operationId": "getB2bComponentsShoppingListList", "parameters": [ { "name": "limit", @@ -6626,7 +8067,7 @@ ], "responses": { "200": { - "description": "List of Order Product Warehouse resources.", + "description": "List of B2b Components Shopping List resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6645,7 +8086,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } ] @@ -6659,16 +8100,16 @@ "type": "object", "properties": { "first": { - "example": "/order-product-warehouse?limit=25" + "example": "/b2b-components-shopping-list?limit=25" }, "last": { - "example": "/order-product-warehouse?limit=25&page=11" + "example": "/b2b-components-shopping-list?limit=25&page=11" }, "next": { - "example": "/order-product-warehouse?limit=25&page=4" + "example": "/b2b-components-shopping-list?limit=25&page=4" }, "prev": { - "example": "/order-product-warehouse?limit=25&page=2" + "example": "/b2b-components-shopping-list?limit=25&page=2" } } } @@ -6689,7 +8130,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6704,11 +8145,12 @@ }, "post": { "tags": [ - "Order Product Warehouse" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Create a new Order Product Warehouse resources.", - "description": "", - "operationId": "createOrderProductWarehouse", + "summary": "Create a new B2b Components Shopping List 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.2.0", + "operationId": "createB2bComponentsShoppingList", "parameters": [ { "name": "_response", @@ -6730,7 +8172,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, "included": { "type": "array", @@ -6744,14 +8186,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -6763,7 +8205,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6772,7 +8214,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } } } } @@ -6786,19 +8236,95 @@ } } }, - "/order-product-warehouse/{id}": { + "/search/b2b-components-shopping-list": { + "post": { + "tags": [ + "B2b Components Shopping List", + "Experimental" + ], + "summary": "Search for the B2b Components Shopping List 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.2.0", + "operationId": "searchB2bComponentsShoppingList", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsShoppingList", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-shopping-list/{id}": { "get": { "tags": [ - "Order Product Warehouse" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Detailed information about a Order Product Warehouse resource.", - "description": "", - "operationId": "getOrderProductWarehouse", + "summary": "Detailed information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -6808,7 +8334,7 @@ ], "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -6820,7 +8346,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6829,7 +8355,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } } } } @@ -6844,16 +8378,17 @@ }, "delete": { "tags": [ - "Order Product Warehouse" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Delete a Order Product Warehouse resource.", - "description": "", - "operationId": "deleteOrderProductWarehouse", + "summary": "Delete a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -6884,16 +8419,17 @@ }, "patch": { "tags": [ - "Order Product Warehouse" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Partially update information about a Order Product Warehouse resource.", - "description": "", - "operationId": "updateOrderProductWarehouse", + "summary": "Partially update information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -6911,14 +8447,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Product Warehouse resource.", + "description": "Partially update information about a B2b Components Shopping List resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, "included": { "type": "array", @@ -6932,14 +8468,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -6951,7 +8487,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6960,7 +8496,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } } } } @@ -6977,14 +8521,15 @@ } } }, - "/order-return": { + "/b2b-components-shopping-list-line-item": { "get": { "tags": [ - "Order Return" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "List with basic information of Order Return resources.", - "description": "", - "operationId": "getOrderReturnList", + "summary": "List with basic information of B2b Components Shopping List Line Item 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.2.0", + "operationId": "getB2bComponentsShoppingListLineItemList", "parameters": [ { "name": "limit", @@ -7013,7 +8558,7 @@ ], "responses": { "200": { - "description": "List of Order Return resources.", + "description": "List of B2b Components Shopping List Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7032,7 +8577,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } ] @@ -7046,16 +8591,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return?limit=25" + "example": "/b2b-components-shopping-list-line-item?limit=25" }, "last": { - "example": "/order-return?limit=25&page=11" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" }, "next": { - "example": "/order-return?limit=25&page=4" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" }, "prev": { - "example": "/order-return?limit=25&page=2" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" } } } @@ -7076,7 +8621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7091,11 +8636,12 @@ }, "post": { "tags": [ - "Order Return" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Create a new Order Return resources.", - "description": "", - "operationId": "createOrderReturn", + "summary": "Create a new B2b Components Shopping List Line Item 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.2.0", + "operationId": "createB2bComponentsShoppingListLineItem", "parameters": [ { "name": "_response", @@ -7117,7 +8663,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" }, "included": { "type": "array", @@ -7131,14 +8677,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7150,7 +8696,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7159,7 +8705,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } } } } @@ -7173,19 +8727,95 @@ } } }, - "/order-return/{id}": { + "/search/b2b-components-shopping-list-line-item": { + "post": { + "tags": [ + "B2b Components Shopping List Line Item", + "Experimental" + ], + "summary": "Search for the B2b Components Shopping List Line Item 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.2.0", + "operationId": "searchB2bComponentsShoppingListLineItem", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bComponentsShoppingListLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-shopping-list-line-item/{id}": { "get": { "tags": [ - "Order Return" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Detailed information about a Order Return resource.", - "description": "", - "operationId": "getOrderReturn", + "summary": "Detailed information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -7195,7 +8825,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7207,7 +8837,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7216,7 +8846,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } } } } @@ -7231,16 +8869,17 @@ }, "delete": { "tags": [ - "Order Return" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Delete a Order Return resource.", - "description": "", - "operationId": "deleteOrderReturn", + "summary": "Delete a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -7271,16 +8910,17 @@ }, "patch": { "tags": [ - "Order Return" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Partially update information about a Order Return resource.", - "description": "", - "operationId": "updateOrderReturn", + "summary": "Partially update information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -7298,14 +8938,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return resource.", + "description": "Partially update information about a B2b Components Shopping List Line Item resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" }, "included": { "type": "array", @@ -7319,14 +8959,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7338,7 +8978,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7347,7 +8987,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } } } } @@ -7364,14 +9012,14 @@ } } }, - "/order-return-line-item": { + "/b2b-employee": { "get": { "tags": [ - "Order Return Line Item" + "B2b Employee" ], - "summary": "List with basic information of Order Return Line Item resources.", + "summary": "List with basic information of B2b Employee resources.", "description": "", - "operationId": "getOrderReturnLineItemList", + "operationId": "getB2bEmployeeList", "parameters": [ { "name": "limit", @@ -7400,7 +9048,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item resources.", + "description": "List of B2b Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7419,7 +9067,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } ] @@ -7433,16 +9081,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item?limit=25" + "example": "/b2b-employee?limit=25" }, "last": { - "example": "/order-return-line-item?limit=25&page=11" + "example": "/b2b-employee?limit=25&page=11" }, "next": { - "example": "/order-return-line-item?limit=25&page=4" + "example": "/b2b-employee?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item?limit=25&page=2" + "example": "/b2b-employee?limit=25&page=2" } } } @@ -7463,7 +9111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7478,11 +9126,11 @@ }, "post": { "tags": [ - "Order Return Line Item" + "B2b Employee" ], - "summary": "Create a new Order Return Line Item resources.", + "summary": "Create a new B2b Employee resources.", "description": "", - "operationId": "createOrderReturnLineItem", + "operationId": "createB2bEmployee", "parameters": [ { "name": "_response", @@ -7504,7 +9152,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" }, "included": { "type": "array", @@ -7518,14 +9166,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7537,7 +9185,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7546,7 +9194,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + } + } } } } @@ -7560,19 +9216,93 @@ } } }, - "/order-return-line-item/{id}": { + "/search/b2b-employee": { + "post": { + "tags": [ + "B2b Employee" + ], + "summary": "Search for the B2b Employee resources.", + "description": "", + "operationId": "searchB2bEmployee", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-employee/{id}": { "get": { "tags": [ - "Order Return Line Item" + "B2b Employee" ], - "summary": "Detailed information about a Order Return Line Item resource.", + "summary": "Detailed information about a B2b Employee resource.", "description": "", - "operationId": "getOrderReturnLineItem", + "operationId": "getB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -7582,7 +9312,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7594,7 +9324,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7603,7 +9333,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + } + } } } } @@ -7618,16 +9356,16 @@ }, "delete": { "tags": [ - "Order Return Line Item" + "B2b Employee" ], - "summary": "Delete a Order Return Line Item resource.", + "summary": "Delete a B2b Employee resource.", "description": "", - "operationId": "deleteOrderReturnLineItem", + "operationId": "deleteB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -7658,16 +9396,16 @@ }, "patch": { "tags": [ - "Order Return Line Item" + "B2b Employee" ], - "summary": "Partially update information about a Order Return Line Item resource.", + "summary": "Partially update information about a B2b Employee resource.", "description": "", - "operationId": "updateOrderReturnLineItem", + "operationId": "updateB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -7685,14 +9423,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item resource.", + "description": "Partially update information about a B2b Employee resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" }, "included": { "type": "array", @@ -7706,14 +9444,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7725,7 +9463,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7734,7 +9472,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bEmployee" + } + } } } } @@ -7751,14 +9497,14 @@ } } }, - "/order-return-line-item-reason": { + "/b2b-order-employee": { "get": { "tags": [ - "Order Return Line Item Reason" + "B2b Order Employee" ], - "summary": "List with basic information of Order Return Line Item Reason resources.", + "summary": "List with basic information of B2b Order Employee resources.", "description": "", - "operationId": "getOrderReturnLineItemReasonList", + "operationId": "getB2bOrderEmployeeList", "parameters": [ { "name": "limit", @@ -7787,7 +9533,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item Reason resources.", + "description": "List of B2b Order Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7806,7 +9552,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } ] @@ -7820,16 +9566,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item-reason?limit=25" + "example": "/b2b-order-employee?limit=25" }, "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" + "example": "/b2b-order-employee?limit=25&page=11" }, "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" + "example": "/b2b-order-employee?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" + "example": "/b2b-order-employee?limit=25&page=2" } } } @@ -7850,7 +9596,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -7865,11 +9611,11 @@ }, "post": { "tags": [ - "Order Return Line Item Reason" + "B2b Order Employee" ], - "summary": "Create a new Order Return Line Item Reason resources.", + "summary": "Create a new B2b Order Employee resources.", "description": "", - "operationId": "createOrderReturnLineItemReason", + "operationId": "createB2bOrderEmployee", "parameters": [ { "name": "_response", @@ -7891,7 +9637,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" }, "included": { "type": "array", @@ -7905,14 +9651,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7924,7 +9670,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -7933,7 +9679,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } } } } @@ -7947,19 +9701,93 @@ } } }, - "/order-return-line-item-reason/{id}": { + "/search/b2b-order-employee": { + "post": { + "tags": [ + "B2b Order Employee" + ], + "summary": "Search for the B2b Order Employee resources.", + "description": "", + "operationId": "searchB2bOrderEmployee", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bOrderEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-order-employee/{id}": { "get": { "tags": [ - "Order Return Line Item Reason" + "B2b Order Employee" ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", + "summary": "Detailed information about a B2b Order Employee resource.", "description": "", - "operationId": "getOrderReturnLineItemReason", + "operationId": "getB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -7969,7 +9797,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7981,7 +9809,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -7990,7 +9818,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } } } } @@ -8005,16 +9841,16 @@ }, "delete": { "tags": [ - "Order Return Line Item Reason" + "B2b Order Employee" ], - "summary": "Delete a Order Return Line Item Reason resource.", + "summary": "Delete a B2b Order Employee resource.", "description": "", - "operationId": "deleteOrderReturnLineItemReason", + "operationId": "deleteB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -8045,16 +9881,16 @@ }, "patch": { "tags": [ - "Order Return Line Item Reason" + "B2b Order Employee" ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", + "summary": "Partially update information about a B2b Order Employee resource.", "description": "", - "operationId": "updateOrderReturnLineItemReason", + "operationId": "updateB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -8072,14 +9908,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item Reason resource.", + "description": "Partially update information about a B2b Order Employee resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" }, "included": { "type": "array", @@ -8093,14 +9929,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -8112,7 +9948,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8121,7 +9957,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } } } } @@ -8138,14 +9982,14 @@ } } }, - "/order-warehouse-group": { + "/b2b-permission": { "get": { "tags": [ - "Order Warehouse Group" + "B2b Permission" ], - "summary": "List with basic information of Order Warehouse Group resources.", + "summary": "List with basic information of B2b Permission resources.", "description": "", - "operationId": "getOrderWarehouseGroupList", + "operationId": "getB2bPermissionList", "parameters": [ { "name": "limit", @@ -8174,7 +10018,7 @@ ], "responses": { "200": { - "description": "List of Order Warehouse Group resources.", + "description": "List of B2b Permission resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8193,7 +10037,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } ] @@ -8207,16 +10051,16 @@ "type": "object", "properties": { "first": { - "example": "/order-warehouse-group?limit=25" + "example": "/b2b-permission?limit=25" }, "last": { - "example": "/order-warehouse-group?limit=25&page=11" + "example": "/b2b-permission?limit=25&page=11" }, "next": { - "example": "/order-warehouse-group?limit=25&page=4" + "example": "/b2b-permission?limit=25&page=4" }, "prev": { - "example": "/order-warehouse-group?limit=25&page=2" + "example": "/b2b-permission?limit=25&page=2" } } } @@ -8237,7 +10081,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8252,11 +10096,11 @@ }, "post": { "tags": [ - "Order Warehouse Group" + "B2b Permission" ], - "summary": "Create a new Order Warehouse Group resources.", + "summary": "Create a new B2b Permission resources.", "description": "", - "operationId": "createOrderWarehouseGroup", + "operationId": "createB2bPermission", "parameters": [ { "name": "_response", @@ -8278,7 +10122,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" }, "included": { "type": "array", @@ -8292,14 +10136,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8311,7 +10155,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8320,7 +10164,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + } + } } } } @@ -8334,19 +10186,93 @@ } } }, - "/order-warehouse-group/{id}": { + "/search/b2b-permission": { + "post": { + "tags": [ + "B2b Permission" + ], + "summary": "Search for the B2b Permission resources.", + "description": "", + "operationId": "searchB2bPermission", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of B2bPermission", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-permission/{id}": { "get": { "tags": [ - "Order Warehouse Group" + "B2b Permission" ], - "summary": "Detailed information about a Order Warehouse Group resource.", + "summary": "Detailed information about a B2b Permission resource.", "description": "", - "operationId": "getOrderWarehouseGroup", + "operationId": "getB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -8356,7 +10282,7 @@ ], "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8368,7 +10294,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8377,7 +10303,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + } + } } } } @@ -8392,16 +10326,16 @@ }, "delete": { "tags": [ - "Order Warehouse Group" + "B2b Permission" ], - "summary": "Delete a Order Warehouse Group resource.", + "summary": "Delete a B2b Permission resource.", "description": "", - "operationId": "deleteOrderWarehouseGroup", + "operationId": "deleteB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -8432,16 +10366,16 @@ }, "patch": { "tags": [ - "Order Warehouse Group" + "B2b Permission" ], - "summary": "Partially update information about a Order Warehouse Group resource.", + "summary": "Partially update information about a B2b Permission resource.", "description": "", - "operationId": "updateOrderWarehouseGroup", + "operationId": "updateB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -8459,14 +10393,14 @@ } ], "requestBody": { - "description": "Partially update information about a Order Warehouse Group resource.", + "description": "Partially update information about a B2b Permission resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" }, "included": { "type": "array", @@ -8480,14 +10414,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8499,7 +10433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8508,7 +10442,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bPermission" + } + } } } } @@ -8525,43 +10467,32 @@ } } }, - "/product-review-summary": { - "get": { + "/search/category": { + "post": { "tags": [ - "Product Review Summary" + "Category" ], - "summary": "List with basic information of Product Review Summary resources.", - "description": "", - "operationId": "getProductReviewSummaryList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Category resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCategory", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Product Review Summary resources.", + "description": "List of Category", "content": { "application/vnd.api+json": { "schema": { @@ -8573,41 +10504,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-review-summary?limit=25" - }, - "last": { - "example": "/product-review-summary?limit=25&page=11" - }, - "next": { - "example": "/product-review-summary?limit=25&page=4" - }, - "prev": { - "example": "/product-review-summary?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } } } } @@ -8624,7 +10524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/Category" } } } @@ -8632,61 +10532,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/cms-block": { "post": { "tags": [ - "Product Review Summary" - ], - "summary": "Create a new Product Review Summary resources.", - "description": "", - "operationId": "createProductReviewSummary", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Cms Block" ], + "summary": "Search for the Cms Block resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsBlock", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "List of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -8698,7 +10578,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } } } } @@ -8707,7 +10590,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } } } } @@ -8721,29 +10615,32 @@ } } }, - "/product-review-summary/{id}": { - "get": { + "/search/cms-page": { + "post": { "tags": [ - "Product Review Summary" + "Cms Page" ], - "summary": "Detailed information about a Product Review Summary resource.", - "description": "", - "operationId": "getProductReviewSummary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review_summary", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsPage", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "List of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -8755,7 +10652,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } } } } @@ -8764,117 +10664,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Review Summary" - ], - "summary": "Delete a Product Review Summary resource.", - "description": "", - "operationId": "deleteProductReviewSummary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review_summary", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/cms-section": { + "post": { "tags": [ - "Product Review Summary" - ], - "summary": "Partially update information about a Product Review Summary resource.", - "description": "", - "operationId": "updateProductReviewSummary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review_summary", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Cms Section" ], + "summary": "Search for the Cms Section resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsSection", "requestBody": { - "description": "Partially update information about a Product Review Summary resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "List of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -8886,7 +10726,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } } } } @@ -8895,7 +10738,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } } } } @@ -8903,52 +10757,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/product-warehouse": { - "get": { + "/search/cms-slot": { + "post": { "tags": [ - "Product Warehouse" + "Cms Slot" ], - "summary": "List with basic information of Product Warehouse resources.", - "description": "", - "operationId": "getProductWarehouseList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Cms Slot resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsSlot", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Product Warehouse resources.", + "description": "List of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -8960,41 +10800,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-warehouse?limit=25" - }, - "last": { - "example": "/product-warehouse?limit=25&page=11" - }, - "next": { - "example": "/product-warehouse?limit=25&page=4" - }, - "prev": { - "example": "/product-warehouse?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } } } } @@ -9011,7 +10820,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -9019,61 +10828,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/country": { "post": { "tags": [ - "Product Warehouse" - ], - "summary": "Create a new Product Warehouse resources.", - "description": "", - "operationId": "createProductWarehouse", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Country" ], + "summary": "Search for the Country resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCountry", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "List of Country", "content": { "application/vnd.api+json": { "schema": { @@ -9085,7 +10874,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } } } } @@ -9094,7 +10886,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } } } } @@ -9108,29 +10911,32 @@ } } }, - "/product-warehouse/{id}": { - "get": { + "/search/country-state": { + "post": { "tags": [ - "Product Warehouse" + "Country State" ], - "summary": "Detailed information about a Product Warehouse resource.", - "description": "", - "operationId": "getProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_warehouse", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Country State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCountryState", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "List of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -9142,7 +10948,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } } } } @@ -9151,117 +10960,131 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/search/currency": { + "post": { "tags": [ - "Product Warehouse" + "Currency" ], - "summary": "Delete a Product Warehouse resource.", - "description": "", - "operationId": "deleteProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_warehouse", - "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" + "summary": "Search for the Currency resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCurrency", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { - "204": { - "$ref": "#/components/responses/204" + "200": { + "description": "List of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + } + } }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/currency-country-rounding": { + "post": { "tags": [ - "Product Warehouse" - ], - "summary": "Partially update information about a Product Warehouse resource.", - "description": "", - "operationId": "updateProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_warehouse", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Currency Country Rounding" ], + "summary": "Search for the Currency Country Rounding resources.", + "description": "Available since: 6.4.0.0", + "operationId": "searchCurrencyCountryRounding", "requestBody": { - "description": "Partially update information about a Product Warehouse resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "List of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -9273,7 +11096,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } } } @@ -9282,7 +11108,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } } } } @@ -9290,52 +11127,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/quote": { - "get": { + "/search/custom-entity": { + "post": { "tags": [ - "Quote" + "Custom Entity" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Custom Entity resources.", + "description": "Available since: 6.4.9.0", + "operationId": "searchCustomEntity", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -9347,41 +11170,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Quote" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/quote?limit=25" - }, - "last": { - "example": "/quote?limit=25&page=11" - }, - "next": { - "example": "/quote?limit=25&page=4" - }, - "prev": { - "example": "/quote?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } } } } @@ -9398,7 +11190,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -9406,61 +11198,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/custom-field": { "post": { "tags": [ - "Quote" - ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Custom Field" ], + "summary": "Search for the Custom Field resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomField", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Quote" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "List of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -9472,7 +11244,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } } } } @@ -9481,7 +11256,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } } } } @@ -9495,29 +11281,32 @@ } } }, - "/quote/{id}": { - "get": { + "/search/custom-field-set": { + "post": { "tags": [ - "Quote" + "Custom Field Set" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Custom Field Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomFieldSet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of Quote", + "description": "List of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -9529,7 +11318,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } } } } @@ -9538,117 +11330,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Quote" - ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/custom-field-set-relation": { + "post": { "tags": [ - "Quote" - ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote", - "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" - } - } + "Custom Field Set Relation" ], + "summary": "Search for the Custom Field Set Relation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomFieldSetRelation", "requestBody": { - "description": "Partially update information about a Quote resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Quote" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "List of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -9660,7 +11392,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } } } } @@ -9669,7 +11404,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } } } } @@ -9677,23 +11423,20 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/quote-comment": { + "/custom-price": { "get": { "tags": [ - "Quote Comment" + "Custom Price" ], - "summary": "List with basic information of Quote Comment resources.", + "summary": "List with basic information of Custom Price resources.", "description": "", - "operationId": "getQuoteCommentList", + "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", @@ -9722,7 +11465,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9741,7 +11484,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" } } ] @@ -9755,16 +11498,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/custom-price?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/custom-price?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/custom-price?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/custom-price?limit=25&page=2" } } } @@ -9785,7 +11528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9800,11 +11543,11 @@ }, "post": { "tags": [ - "Quote Comment" + "Custom Price" ], - "summary": "Create a new Quote Comment resources.", + "summary": "Create a new Custom Price resources.", "description": "", - "operationId": "createQuoteComment", + "operationId": "createCustomPrice", "parameters": [ { "name": "_response", @@ -9826,7 +11569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" }, "included": { "type": "array", @@ -9840,14 +11583,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -9859,7 +11602,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9868,7 +11611,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } } } } @@ -9882,29 +11633,32 @@ } } }, - "/quote-comment/{id}": { - "get": { + "/search/custom-price": { + "post": { "tags": [ - "Quote Comment" + "Custom Price" ], - "summary": "Detailed information about a Quote Comment resource.", + "summary": "Search for the Custom Price resources.", "description": "", - "operationId": "getQuoteComment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_comment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "operationId": "searchCustomPrice", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -9916,7 +11670,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPrice" + } } } } @@ -9925,49 +11682,125 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/custom-price/{id}": { + "get": { "tags": [ - "Quote Comment" + "Custom Price" ], - "summary": "Delete a Quote Comment resource.", + "summary": "Detailed information about a Custom Price resource.", "description": "", - "operationId": "deleteQuoteComment", + "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the custom_price", "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": { + "200": { + "description": "Detail of CustomPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Custom Price" + ], + "summary": "Delete a Custom Price resource.", + "description": "", + "operationId": "deleteCustomPrice", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the custom_price", + "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": { @@ -9980,16 +11813,16 @@ }, "patch": { "tags": [ - "Quote Comment" + "Custom Price" ], - "summary": "Partially update information about a Quote Comment resource.", + "summary": "Partially update information about a Custom Price resource.", "description": "", - "operationId": "updateQuoteComment", + "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -10007,14 +11840,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Custom Price resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" }, "included": { "type": "array", @@ -10028,14 +11861,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -10047,7 +11880,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -10056,7 +11889,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomPrice" + } + } } } } @@ -10073,43 +11914,32 @@ } } }, - "/quote-delivery": { - "get": { + "/search/customer": { + "post": { "tags": [ - "Quote Delivery" + "Customer" ], - "summary": "List with basic information of Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -10121,41 +11951,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDelivery" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/quote-delivery?limit=25" - }, - "last": { - "example": "/quote-delivery?limit=25&page=11" - }, - "next": { - "example": "/quote-delivery?limit=25&page=4" - }, - "prev": { - "example": "/quote-delivery?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } } } } @@ -10172,7 +11971,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Customer" } } } @@ -10180,61 +11979,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/customer-address": { "post": { "tags": [ - "Quote Delivery" - ], - "summary": "Create a new Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Customer Address" ], + "summary": "Search for the Customer Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomerAddress", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "List of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -10246,7 +12025,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } } } } @@ -10255,7 +12037,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } } } } @@ -10269,29 +12062,32 @@ } } }, - "/quote-delivery/{id}": { - "get": { + "/search/customer-group": { + "post": { "tags": [ - "Quote Delivery" + "Customer Group" ], - "summary": "Detailed information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_delivery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Customer Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCustomerGroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "List of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -10303,7 +12099,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } } } } @@ -10312,117 +12111,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Quote Delivery" - ], - "summary": "Delete a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_delivery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/customer-recovery": { + "post": { "tags": [ - "Quote Delivery" - ], - "summary": "Partially update information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_delivery", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Customer Recovery" ], + "summary": "Search for the Customer Recovery resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchCustomerRecovery", "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "List of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -10434,7 +12173,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } } } } @@ -10443,7 +12185,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } } } } @@ -10451,23 +12204,20 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/quote-delivery-position": { + "/customer-specific-features": { "get": { "tags": [ - "Quote Delivery Position" + "Customer Specific Features" ], - "summary": "List with basic information of Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPositionList", + "summary": "List with basic information of Customer Specific Features resources.", + "description": "", + "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", @@ -10496,7 +12246,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10515,7 +12265,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] @@ -10529,16 +12279,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/customer-specific-features?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/customer-specific-features?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/customer-specific-features?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/customer-specific-features?limit=25&page=2" } } } @@ -10559,7 +12309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -10574,11 +12324,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Customer Specific Features" ], - "summary": "Create a new Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "summary": "Create a new Customer Specific Features resources.", + "description": "", + "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", @@ -10600,7 +12350,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" }, "included": { "type": "array", @@ -10614,14 +12364,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -10633,7 +12383,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -10642,7 +12392,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } } } } @@ -10656,19 +12414,93 @@ } } }, - "/quote-delivery-position/{id}": { + "/search/customer-specific-features": { + "post": { + "tags": [ + "Customer Specific Features" + ], + "summary": "Search for the Customer Specific Features resources.", + "description": "", + "operationId": "searchCustomerSpecificFeatures", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerSpecificFeatures", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-specific-features/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Customer Specific Features" ], - "summary": "Detailed information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "summary": "Detailed information about a Customer Specific Features resource.", + "description": "", + "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -10678,7 +12510,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -10690,7 +12522,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -10699,7 +12531,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } } } } @@ -10714,16 +12554,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Customer Specific Features" ], - "summary": "Delete a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", - "parameters": [ - { + "summary": "Delete a Customer Specific Features resource.", + "description": "", + "operationId": "deleteCustomerSpecificFeatures", + "parameters": [ + { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -10754,16 +12594,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Customer Specific Features" ], - "summary": "Partially update information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDeliveryPosition", + "summary": "Partially update information about a Customer Specific Features resource.", + "description": "", + "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -10781,14 +12621,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Customer Specific Features resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" }, "included": { "type": "array", @@ -10802,14 +12642,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -10821,7 +12661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -10830,7 +12670,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } } } } @@ -10847,43 +12695,32 @@ } } }, - "/quote-employee": { - "get": { + "/search/customer-wishlist": { + "post": { "tags": [ - "Quote Employee" + "Customer Wishlist" ], - "summary": "List with basic information of Quote Employee resources.", - "description": "", - "operationId": "getQuoteEmployeeList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Customer Wishlist resources.", + "description": "Available since: 6.3.4.0", + "operationId": "searchCustomerWishlist", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -10895,41 +12732,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteEmployee" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/quote-employee?limit=25" - }, - "last": { - "example": "/quote-employee?limit=25&page=11" - }, - "next": { - "example": "/quote-employee?limit=25&page=4" - }, - "prev": { - "example": "/quote-employee?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } } } } @@ -10946,7 +12752,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/CustomerWishlist" } } } @@ -10954,61 +12760,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/customer-wishlist-product": { "post": { "tags": [ - "Quote Employee" - ], - "summary": "Create a new Quote Employee resources.", - "description": "", - "operationId": "createQuoteEmployee", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Customer Wishlist Product" ], + "summary": "Search for the Customer Wishlist Product resources.", + "description": "Available since: 6.3.4.0", + "operationId": "searchCustomerWishlistProduct", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "List of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -11020,7 +12806,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } } } } @@ -11029,7 +12818,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } } } } @@ -11043,29 +12843,32 @@ } } }, - "/quote-employee/{id}": { - "get": { + "/search/delivery-time": { + "post": { "tags": [ - "Quote Employee" + "Delivery Time" ], - "summary": "Detailed information about a Quote Employee resource.", - "description": "", - "operationId": "getQuoteEmployee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_employee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Delivery Time resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDeliveryTime", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "List of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -11077,7 +12880,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } } } } @@ -11086,117 +12892,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Quote Employee" - ], - "summary": "Delete a Quote Employee resource.", - "description": "", - "operationId": "deleteQuoteEmployee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_employee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/document": { + "post": { "tags": [ - "Quote Employee" - ], - "summary": "Partially update information about a Quote Employee resource.", - "description": "", - "operationId": "updateQuoteEmployee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_employee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Document" ], + "summary": "Search for the Document resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocument", "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "List of Document", "content": { "application/vnd.api+json": { "schema": { @@ -11208,7 +12954,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } } } } @@ -11217,7 +12966,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } } } } @@ -11225,52 +12985,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/quote-line-item": { - "get": { + "/search/document-base-config": { + "post": { "tags": [ - "Quote Line Item" + "Document Base Config" ], - "summary": "List with basic information of Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItemList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Document Base Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentBaseConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -11282,41 +13028,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteLineItem" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/quote-line-item?limit=25" - }, - "last": { - "example": "/quote-line-item?limit=25&page=11" - }, - "next": { - "example": "/quote-line-item?limit=25&page=4" - }, - "prev": { - "example": "/quote-line-item?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } } } } @@ -11333,7 +13048,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -11341,61 +13056,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/document-base-config-sales-channel": { "post": { "tags": [ - "Quote Line Item" - ], - "summary": "Create a new Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Document Base Config Sales Channel" ], + "summary": "Search for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentBaseConfigSalesChannel", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "List of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -11407,7 +13102,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } } } @@ -11416,7 +13114,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } } } } @@ -11430,29 +13139,32 @@ } } }, - "/quote-line-item/{id}": { - "get": { + "/search/document-type": { + "post": { "tags": [ - "Quote Line Item" + "Document Type" ], - "summary": "Detailed information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_line_item", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Document Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "List of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -11464,7 +13176,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } } } } @@ -11473,117 +13188,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/search/flow": { + "post": { "tags": [ - "Quote Line Item" - ], - "summary": "Delete a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_line_item", - "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": [ - "Quote Line Item" - ], - "summary": "Partially update information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_line_item", - "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" - } - } + "Flow" ], + "summary": "Search for the Flow resources.", + "description": "Available since: 6.4.6.0", + "operationId": "searchFlow", "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "List of Flow", "content": { "application/vnd.api+json": { "schema": { @@ -11595,7 +13250,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } } } } @@ -11604,7 +13262,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } } } } @@ -11612,52 +13281,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/quote-transaction": { - "get": { + "/search/flow-sequence": { + "post": { "tags": [ - "Quote Transaction" + "Flow Sequence" ], - "summary": "List with basic information of Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransactionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Flow Sequence resources.", + "description": "Available since: 6.4.6.0", + "operationId": "searchFlowSequence", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of FlowSequence", "content": { "application/vnd.api+json": { "schema": { @@ -11669,41 +13324,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteTransaction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/quote-transaction?limit=25" - }, - "last": { - "example": "/quote-transaction?limit=25&page=11" - }, - "next": { - "example": "/quote-transaction?limit=25&page=4" - }, - "prev": { - "example": "/quote-transaction?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } } } } @@ -11720,7 +13344,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/FlowSequence" } } } @@ -11728,61 +13352,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/flow-template": { "post": { "tags": [ - "Quote Transaction" - ], - "summary": "Create a new Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Flow Template" ], + "summary": "Search for the Flow Template resources.", + "description": "Available since: 6.4.18.0", + "operationId": "searchFlowTemplate", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "List of FlowTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -11794,7 +13398,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } } } } @@ -11803,7 +13410,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } } } } @@ -11817,29 +13435,32 @@ } } }, - "/quote-transaction/{id}": { - "get": { + "/search/import-export-file": { + "post": { "tags": [ - "Quote Transaction" + "Import Export File" ], - "summary": "Detailed information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_transaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Import Export File resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchImportExportFile", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "List of ImportExportFile", "content": { "application/vnd.api+json": { "schema": { @@ -11851,7 +13472,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } } } } @@ -11860,117 +13484,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Quote Transaction" - ], - "summary": "Delete a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_transaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/import-export-log": { + "post": { "tags": [ - "Quote Transaction" - ], - "summary": "Partially update information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteTransaction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the quote_transaction", - "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" - } - } + "Import Export Log" ], + "summary": "Search for the Import Export Log resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchImportExportLog", "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "List of ImportExportLog", "content": { "application/vnd.api+json": { "schema": { @@ -11982,7 +13546,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } } } } @@ -11991,7 +13558,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } } } } @@ -11999,52 +13577,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/subscription": { - "get": { + "/search/import-export-profile": { + "post": { "tags": [ - "Subscription" + "Import Export Profile" ], - "summary": "List with basic information of Subscription resources.", - "description": "", - "operationId": "getSubscriptionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Import Export Profile resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchImportExportProfile", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of ImportExportProfile", "content": { "application/vnd.api+json": { "schema": { @@ -12056,41 +13620,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Subscription" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/subscription?limit=25" - }, - "last": { - "example": "/subscription?limit=25&page=11" - }, - "next": { - "example": "/subscription?limit=25&page=4" - }, - "prev": { - "example": "/subscription?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } } } } @@ -12107,7 +13640,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/ImportExportProfile" } } } @@ -12115,61 +13648,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/integration": { "post": { "tags": [ - "Subscription" - ], - "summary": "Create a new Subscription resources.", - "description": "", - "operationId": "createSubscription", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Integration" ], + "summary": "Search for the Integration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchIntegration", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Subscription" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "List of Integration", "content": { "application/vnd.api+json": { "schema": { @@ -12181,7 +13694,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } } } } @@ -12190,7 +13706,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } } } } @@ -12204,29 +13731,32 @@ } } }, - "/subscription/{id}": { - "get": { + "/search/landing-page": { + "post": { "tags": [ - "Subscription" + "Landing Page" ], - "summary": "Detailed information about a Subscription resource.", - "description": "", - "operationId": "getSubscription", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Landing Page resources.", + "description": "Available since: 6.4.0.0", + "operationId": "searchLandingPage", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "List of LandingPage", "content": { "application/vnd.api+json": { "schema": { @@ -12238,7 +13768,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } } } } @@ -12247,117 +13780,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Subscription" - ], - "summary": "Delete a Subscription resource.", - "description": "", - "operationId": "deleteSubscription", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/language": { + "post": { "tags": [ - "Subscription" - ], - "summary": "Partially update information about a Subscription resource.", - "description": "", - "operationId": "updateSubscription", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription", - "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" - } - } + "Language" ], + "summary": "Search for the Language resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchLanguage", "requestBody": { - "description": "Partially update information about a Subscription resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Subscription" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "List of Language", "content": { "application/vnd.api+json": { "schema": { @@ -12369,7 +13842,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } } } } @@ -12378,7 +13854,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } } } } @@ -12386,52 +13873,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/subscription-address": { - "get": { + "/search/locale": { + "post": { "tags": [ - "Subscription Address" + "Locale" ], - "summary": "List with basic information of Subscription Address resources.", - "description": "", - "operationId": "getSubscriptionAddressList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Locale resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchLocale", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Locale", "content": { "application/vnd.api+json": { "schema": { @@ -12443,41 +13916,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionAddress" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/subscription-address?limit=25" - }, - "last": { - "example": "/subscription-address?limit=25&page=11" - }, - "next": { - "example": "/subscription-address?limit=25&page=4" - }, - "prev": { - "example": "/subscription-address?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } } } } @@ -12494,7 +13936,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/Locale" } } } @@ -12502,61 +13944,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/log-entry": { "post": { "tags": [ - "Subscription Address" - ], - "summary": "Create a new Subscription Address resources.", - "description": "", - "operationId": "createSubscriptionAddress", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Log Entry" ], + "summary": "Search for the Log Entry resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchLogEntry", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "List of LogEntry", "content": { "application/vnd.api+json": { "schema": { @@ -12568,7 +13990,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } } } } @@ -12577,7 +14002,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } } } } @@ -12591,29 +14027,32 @@ } } }, - "/subscription-address/{id}": { - "get": { + "/search/mail-header-footer": { + "post": { "tags": [ - "Subscription Address" + "Mail Header Footer" ], - "summary": "Detailed information about a Subscription Address resource.", - "description": "", - "operationId": "getSubscriptionAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_address", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Mail Header Footer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMailHeaderFooter", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "List of MailHeaderFooter", "content": { "application/vnd.api+json": { "schema": { @@ -12625,7 +14064,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } } } } @@ -12634,117 +14076,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Subscription Address" - ], - "summary": "Delete a Subscription Address resource.", - "description": "", - "operationId": "deleteSubscriptionAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_address", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/mail-template": { + "post": { "tags": [ - "Subscription Address" - ], - "summary": "Partially update information about a Subscription Address resource.", - "description": "", - "operationId": "updateSubscriptionAddress", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_address", - "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" - } - } + "Mail Template" ], + "summary": "Search for the Mail Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMailTemplate", "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "List of MailTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -12756,7 +14138,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } } } } @@ -12765,7 +14150,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } } } } @@ -12773,52 +14169,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/subscription-customer": { - "get": { + "/search/mail-template-type": { + "post": { "tags": [ - "Subscription Customer" + "Mail Template Type" ], - "summary": "List with basic information of Subscription Customer resources.", - "description": "", - "operationId": "getSubscriptionCustomerList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Mail Template Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMailTemplateType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of MailTemplateType", "content": { "application/vnd.api+json": { "schema": { @@ -12830,41 +14212,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/subscription-customer?limit=25" - }, - "last": { - "example": "/subscription-customer?limit=25&page=11" - }, - "next": { - "example": "/subscription-customer?limit=25&page=4" - }, - "prev": { - "example": "/subscription-customer?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } } } } @@ -12881,7 +14232,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/MailTemplateType" } } } @@ -12889,61 +14240,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/main-category": { "post": { "tags": [ - "Subscription Customer" - ], - "summary": "Create a new Subscription Customer resources.", - "description": "", - "operationId": "createSubscriptionCustomer", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Main Category" ], + "summary": "Search for the Main Category resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchMainCategory", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "List of MainCategory", "content": { "application/vnd.api+json": { "schema": { @@ -12955,7 +14286,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } } } } @@ -12964,7 +14298,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } } } } @@ -12978,160 +14323,32 @@ } } }, - "/subscription-customer/{id}": { - "get": { - "tags": [ - "Subscription Customer" - ], - "summary": "Detailed information about a Subscription Customer resource.", - "description": "", - "operationId": "getSubscriptionCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SubscriptionCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Subscription Customer" - ], - "summary": "Delete a Subscription Customer resource.", - "description": "", - "operationId": "deleteSubscriptionCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { + "/search/media": { + "post": { "tags": [ - "Subscription Customer" - ], - "summary": "Partially update information about a Subscription Customer resource.", - "description": "", - "operationId": "updateSubscriptionCustomer", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the subscription_customer", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Media" ], + "summary": "Search for the Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMedia", "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "List of Media", "content": { "application/vnd.api+json": { "schema": { @@ -13143,7 +14360,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } } } } @@ -13152,7 +14372,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } } } } @@ -13160,23 +14391,20 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/subscription-interval": { + "/media-ai-tag": { "get": { "tags": [ - "Subscription Interval" + "Media Ai Tag" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -13205,7 +14433,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13224,7 +14452,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -13238,16 +14466,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -13268,7 +14496,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -13283,11 +14511,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Media Ai Tag" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -13309,7 +14537,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" }, "included": { "type": "array", @@ -13323,14 +14551,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -13342,7 +14570,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -13351,7 +14579,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + } + } } } } @@ -13365,19 +14601,93 @@ } } }, - "/subscription-interval/{id}": { + "/search/media-ai-tag": { + "post": { + "tags": [ + "Media Ai Tag" + ], + "summary": "Search for the Media Ai Tag resources.", + "description": "", + "operationId": "searchMediaAiTag", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaAiTag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-ai-tag/{id}": { "get": { "tags": [ - "Subscription Interval" + "Media Ai Tag" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -13387,7 +14697,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -13399,7 +14709,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -13408,7 +14718,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + } + } } } } @@ -13423,16 +14741,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Media Ai Tag" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -13463,16 +14781,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Media Ai Tag" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -13490,14 +14808,14 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" }, "included": { "type": "array", @@ -13511,14 +14829,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -13530,7 +14848,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -13539,7 +14857,15 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaAiTag" + } + } } } } @@ -13556,43 +14882,32 @@ } } }, - "/subscription-plan": { - "get": { + "/search/media-default-folder": { + "post": { "tags": [ - "Subscription Plan" + "Media Default Folder" ], - "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" + "summary": "Search for the Media Default Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaDefaultFolder", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -13604,41 +14919,10 @@ "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" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } } } } @@ -13655,7 +14939,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -13663,61 +14947,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/media-folder": { "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" - ] - } - } + "Media Folder" ], + "summary": "Search for the Media Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaFolder", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "List of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -13729,7 +14993,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } } } } @@ -13738,7 +15005,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } } } } @@ -13752,29 +15030,32 @@ } } }, - "/subscription-plan/{id}": { - "get": { + "/search/media-folder-configuration": { + "post": { "tags": [ - "Subscription Plan" + "Media Folder Configuration" ], - "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}$" + "summary": "Search for the Media Folder Configuration resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaFolderConfiguration", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "List of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -13786,7 +15067,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } } } } @@ -13795,117 +15079,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } } } } }, - "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" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/media-thumbnail": { + "post": { "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" - } - } + "Media Thumbnail" ], + "summary": "Search for the Media Thumbnail resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaThumbnail", "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "List of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -13917,7 +15141,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } } } } @@ -13926,7 +15153,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } } } } @@ -13934,52 +15172,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/swag-delay-action": { - "get": { + "/search/media-thumbnail-size": { + "post": { "tags": [ - "Swag Delay Action" + "Media Thumbnail Size" ], - "summary": "List with basic information of Swag Delay Action resources.", - "description": "", - "operationId": "getSwagDelayActionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaThumbnailSize", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -13991,41 +15215,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagDelayAction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-delay-action?limit=25" - }, - "last": { - "example": "/swag-delay-action?limit=25&page=11" - }, - "next": { - "example": "/swag-delay-action?limit=25&page=4" - }, - "prev": { - "example": "/swag-delay-action?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } } } } @@ -14042,7 +15235,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -14050,61 +15243,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/newsletter-recipient": { "post": { "tags": [ - "Swag Delay Action" - ], - "summary": "Create a new Swag Delay Action resources.", - "description": "", - "operationId": "createSwagDelayAction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Newsletter Recipient" ], + "summary": "Search for the Newsletter Recipient resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNewsletterRecipient", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagDelayAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "List of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -14116,7 +15289,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } } } } @@ -14125,7 +15301,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } } } } @@ -14139,29 +15326,32 @@ } } }, - "/swag-delay-action/{id}": { - "get": { + "/search/notification": { + "post": { "tags": [ - "Swag Delay Action" + "Notification" ], - "summary": "Detailed information about a Swag Delay Action resource.", - "description": "", - "operationId": "getSwagDelayAction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_delay_action", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchNotification", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "List of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -14173,7 +15363,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } } } } @@ -14182,117 +15375,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Delay Action" - ], - "summary": "Delete a Swag Delay Action resource.", - "description": "", - "operationId": "deleteSwagDelayAction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_delay_action", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/number-range": { + "post": { "tags": [ - "Swag Delay Action" - ], - "summary": "Partially update information about a Swag Delay Action resource.", - "description": "", - "operationId": "updateSwagDelayAction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_delay_action", - "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" - } - } + "Number Range" ], + "summary": "Search for the Number Range resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRange", "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagDelayAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "List of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -14304,7 +15437,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } } } } @@ -14313,7 +15449,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } } } } @@ -14321,52 +15468,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/warehouse": { - "get": { + "/search/number-range-sales-channel": { + "post": { "tags": [ - "Warehouse" + "Number Range Sales Channel" ], - "summary": "List with basic information of Warehouse resources.", - "description": "", - "operationId": "getWarehouseList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Search for the Number Range Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRangeSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -14378,41 +15511,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/Warehouse" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/warehouse?limit=25" - }, - "last": { - "example": "/warehouse?limit=25&page=11" - }, - "next": { - "example": "/warehouse?limit=25&page=4" - }, - "prev": { - "example": "/warehouse?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } } } } @@ -14429,7 +15531,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -14437,61 +15539,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/number-range-state": { "post": { "tags": [ - "Warehouse" - ], - "summary": "Create a new Warehouse resources.", - "description": "", - "operationId": "createWarehouse", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Number Range State" ], + "summary": "Search for the Number Range State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRangeState", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Warehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "List of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -14503,7 +15585,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } } } } @@ -14512,7 +15597,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } } } } @@ -14526,29 +15622,32 @@ } } }, - "/warehouse/{id}": { - "get": { + "/search/number-range-type": { + "post": { "tags": [ - "Warehouse" + "Number Range Type" ], - "summary": "Detailed information about a Warehouse resource.", - "description": "", - "operationId": "getWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Number Range Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchNumberRangeType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "List of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -14560,7 +15659,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } } } } @@ -14569,117 +15671,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Warehouse" - ], - "summary": "Delete a Warehouse resource.", - "description": "", - "operationId": "deleteWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/order": { + "post": { "tags": [ - "Warehouse" - ], - "summary": "Partially update information about a Warehouse resource.", - "description": "", - "operationId": "updateWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse", - "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" - } - } + "Order" ], + "summary": "Search for the Order resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrder", "requestBody": { - "description": "Partially update information about a Warehouse resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Warehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "List of Order", "content": { "application/vnd.api+json": { "schema": { @@ -14691,7 +15733,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } } } } @@ -14700,7 +15745,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } } } } @@ -14708,52 +15764,38 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/warehouse-group": { - "get": { + "/search/order-address": { + "post": { "tags": [ - "Warehouse Group" + "Order Address" ], - "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" + "summary": "Search for the Order Address resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "List of Warehouse Group resources.", + "description": "List of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -14765,41 +15807,10 @@ "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" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } } } } @@ -14816,7 +15827,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -14824,61 +15835,41 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/search/order-customer": { "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" - ] - } - } + "Order Customer" ], + "summary": "Search for the Order Customer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderCustomer", "requestBody": { + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "List of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -14890,7 +15881,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } } } } @@ -14899,7 +15893,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } } } } @@ -14913,29 +15918,32 @@ } } }, - "/warehouse-group/{id}": { - "get": { + "/search/order-delivery": { + "post": { "tags": [ - "Warehouse Group" + "Order Delivery" ], - "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": "Search for the Order Delivery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderDelivery", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "List of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -14947,7 +15955,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } } } } @@ -14956,117 +15967,57 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Warehouse Group" - ], - "summary": "Delete a Warehouse Group resource.", - "description": "", - "operationId": "deleteWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/order-delivery-position": { + "post": { "tags": [ - "Warehouse Group" - ], - "summary": "Partially update information about a Warehouse Group resource.", - "description": "", - "operationId": "updateWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", - "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" - } - } + "Order Delivery Position" ], + "summary": "Search for the Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderDeliveryPosition", "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "required": true, "content": { "application/vnd.api+json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } + "$ref": "#/components/schemas/Criteria" } }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "List of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -15078,7 +16029,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } } } } @@ -15087,7 +16041,18 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } } } } @@ -15095,923 +16060,22071 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/_action/custom-price": { + "/search/order-line-item": { "post": { "tags": [ - "Bulk Operations" + "Order Line Item" ], - "summary": "Bulk edit custom prices", - "description": "An emulation of Sync API implementation", - "operationId": "customPriceImport", + "summary": "Search for the Order Line Item resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderLineItem", "requestBody": { "required": true, "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, "application/json": { "schema": { - "type": "array", - "items": { - "oneOf": [ - { - "$ref": "#/components/schemas/CustomPricingUpsertOperation" - }, - { - "$ref": "#/components/schemas/CustomPricingDeleteOperation" - } - ] - } + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Returns a JSON result containing information about the updated entities", + "description": "List of OrderLineItem", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPricingResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/api/_admin/rule-builder-preview/{orderId}": { + "/search/order-line-item-download": { "post": { "tags": [ - "Rule Preview" - ], - "summary": "Preview results of a rule evaluating an order", - "description": "Evaluate the conditions of a rule based on a pre-selected order.", - "operationId": "rulePreview", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "Identifier of the order the preview should be generated for", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Order Line Item Download" ], + "summary": "Search for the Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "searchOrderLineItemDownload", "requestBody": { "required": true, "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, "application/json": { "schema": { - "required": [ - "conditions" - ], - "properties": { - "conditions": { - "description": "Array of nested rule condition payloads.", - "items": { - "type": "object" - }, - "type": "array" - }, - "dateTime": { - "description": "A date and time to be mocked in the preview evaluation.", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Returns the results of the evaluated rule conditions as an object.", + "description": "List of OrderLineItemDownload", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "array", - "items": { - "properties": { - "match": { - "description": "Evaluation of the condition", - "type": "boolean" - }, - "name": { - "description": "The technical name of the condition", - "type": "string" - }, - "ruleReferenceId": { - "description": "The id of the corresponding rule_condition entity", - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/api/_action/invite-employee": { + "/order-product-warehouse": { + "get": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "List with basic information of Order Product Warehouse resources.", + "description": "", + "operationId": "getOrderProductWarehouseList", + "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 Order Product Warehouse 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/OrderProductWarehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-product-warehouse?limit=25" + }, + "last": { + "example": "/order-product-warehouse?limit=25&page=11" + }, + "next": { + "example": "/order-product-warehouse?limit=25&page=4" + }, + "prev": { + "example": "/order-product-warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, "post": { "tags": [ - "B2B" + "Order Product Warehouse" + ], + "summary": "Create a new Order Product Warehouse resources.", + "description": "", + "operationId": "createOrderProductWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Sends an invite email to employee", - "description": "This route is used to send an invite email to an employee", - "operationId": "inviteEmployee", - "parameters": [], "requestBody": { - "required": true, "content": { - "application/json": { + "application/vnd.api+json": { "schema": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true } - }, - "type": "object" + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { - "204": { - "description": "No content response" - } - }, - "security": [ - { - "ApiKey": [] + "200": { + "description": "Detail of OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - ] + } } }, - "/api/_action/create-employee": { + "/search/order-product-warehouse": { "post": { "tags": [ - "B2B" + "Order Product Warehouse" ], - "summary": "Creates an employee", - "description": "This route is used to create an employee", - "operationId": "createEmployee", - "parameters": [], + "summary": "Search for the Order Product Warehouse resources.", + "description": "", + "operationId": "searchOrderProductWarehouse", "requestBody": { "required": true, "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, "application/json": { "schema": { - "properties": { - "firstName": { - "description": "First name of the new employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the new employee", - "type": "string" - }, - "email": { - "description": "Email of the new employee", - "type": "string" - }, - "roleId": { - "description": "Id of the role of the new employee", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "IDs of the created employees", + "description": "List of OrderProductWarehouse", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { + "total": { + "type": "integer" + }, "data": { - "description": "Array of the created employee ids", "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "security": [ - { - "ApiKey": [] - } - ] + } } }, - "/api/_action/update-employee": { - "patch": { + "/order-product-warehouse/{id}": { + "get": { "tags": [ - "B2B" + "Order Product Warehouse" ], - "summary": "Updates an employee", - "description": "This route is used to update an employee", - "operationId": "updateEmployee", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "description": "Id of the employee", - "type": "string" - }, - "firstName": { - "description": "First name of the employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the employee", - "type": "string" - }, - "email": { - "description": "Email of the employee", - "type": "string" - }, - "roleId": { - "description": "Id of the role of the employee", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "No content response" - } - }, - "security": [ + "summary": "Detailed information about a Order Product Warehouse resource.", + "description": "", + "operationId": "getOrderProductWarehouse", + "parameters": [ { - "ApiKey": [] + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } - ] - } - } - }, - "components": { - "schemas": { - "success": { - "required": [ - "data" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "description": "Link members related to the primary data.", - "allOf": [ - { - "$ref": "#/components/schemas/links" + "responses": { + "200": { + "description": "Detail of OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + ] + } }, - { - "$ref": "#/components/schemas/pagination" + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } } - ] + } }, - "data": { - "$ref": "#/components/schemas/data" + "404": { + "$ref": "#/components/responses/404" }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": false + } }, - "failure": { - "required": [ - "errors" + "delete": { + "tags": [ + "Order Product Warehouse" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" + "summary": "Delete a Order Product Warehouse resource.", + "description": "", + "operationId": "deleteOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "links": { - "$ref": "#/components/schemas/links" + { + "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" }, - "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" + "404": { + "$ref": "#/components/responses/404" }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" + "401": { + "$ref": "#/components/responses/401" } - }, - "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": [ + "patch": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "Partially update information about a Order Product Warehouse resource.", + "description": "", + "operationId": "updateOrderProductWarehouse", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } } - ] - }, - "resource": { - "description": "\"Resource objects\" appear in a JSON API document to represent resources.", - "required": [ - "type", - "id" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string" - }, - "attributes": { - "$ref": "#/components/schemas/attributes" - }, - "relationships": { - "$ref": "#/components/schemas/relationships" - }, - "links": { - "$ref": "#/components/schemas/links" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "requestBody": { + "description": "Partially update information about a Order Product Warehouse resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } } }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + "responses": { + "200": { + "description": "Detail of OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + ] } }, - { - "$ref": "#/components/schemas/link" + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } } - ] + } }, - "related": { - "$ref": "#/components/schemas/link" + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, + } + }, + "/order-return": { + "get": { + "tags": [ + "Order Return" + ], + "summary": "List with basic information of Order Return resources.", + "description": "", + "operationId": "getOrderReturnList", + "parameters": [ { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" - } + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" } - } - ] - }, - "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" - ] + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } }, { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of Order Return 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/OrderReturn" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return?limit=25" + }, + "last": { + "example": "/order-return?limit=25&page=11" + }, + "next": { + "example": "/order-return?limit=25&page=4" + }, + "prev": { + "example": "/order-return?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" - }, - { - "$ref": "#/components/schemas/relationshipToMany" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } } - ] + } } } + }, + "401": { + "$ref": "#/components/responses/401" } - ], - "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." - }, + "post": { + "tags": [ + "Order Return" + ], + "summary": "Create a new Order Return resources.", + "description": "", + "operationId": "createOrderReturn", + "parameters": [ { - "$ref": "#/components/schemas/linkage" + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } } - ] - }, - "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" + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } } }, - "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" + "responses": { + "200": { + "description": "Detail of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } + } }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" + "400": { + "$ref": "#/components/responses/400" }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "jsonapi": { - "description": "An object describing the server's implementation", - "properties": { - "version": { - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/meta" + } + } + }, + "/search/order-return": { + "post": { + "tags": [ + "Order Return" + ], + "summary": "Search for the Order Return resources.", + "description": "", + "operationId": "searchOrderReturn", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } } }, - "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]." + "responses": { + "200": { + "description": "List of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } + ] + } }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } } } }, - "meta": { - "$ref": "#/components/schemas/meta" - } - }, - "type": "object", - "additionalProperties": false - }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "400": { + "$ref": "#/components/responses/400" }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return/{id}": { + "get": { + "tags": [ + "Order Return" + ], + "summary": "Detailed information about a Order Return resource.", + "description": "", + "operationId": "getOrderReturn", + "parameters": [ { - "required": [ - "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" - } - } - } + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" - }, - "integrations": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/acl-role/87857e66337bf79fa25f363fefba38a1/integrations" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "integration" - }, - "id": { - "type": "string", - "example": "415320131958c70f4f250ca4d7e63bbd" - } - } + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" } } - }, - "type": "object" + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } } - }, - "type": "object" + } } - }, - "type": "object" + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } - ] + } }, - "AclRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "name", - "privileges", - "createdAt" + "delete": { + "tags": [ + "Order Return" ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privileges": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false + "summary": "Delete a Order Return resource.", + "description": "", + "operationId": "deleteOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "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" + { + "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" }, - "app": { - "$ref": "#/components/schemas/App" + "404": { + "$ref": "#/components/responses/404" }, - "integrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" + } }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "userId", - "aclRoleId", - "createdAt" + "patch": { + "tags": [ + "Order Return" ], - "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}$" + "summary": "Partially update information about a Order Return resource.", + "description": "", + "operationId": "updateOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "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 Order Return resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "400": { + "$ref": "#/components/responses/400" }, - "user": { - "$ref": "#/components/schemas/User" + "404": { + "$ref": "#/components/responses/404" }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "AdvancedSearchActionJsonApi": { - "allOf": [ + } + } + }, + "/order-return-line-item": { + "get": { + "tags": [ + "Order Return Line Item" + ], + "summary": "List with basic information of Order Return Line Item resources.", + "description": "", + "operationId": "getOrderReturnLineItemList", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } }, { - "required": [ - "configId", - "type", - "name", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { + "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 Order Return Line Item 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/OrderReturnLineItem" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return-line-item?limit=25" + }, + "last": { + "example": "/order-return-line-item?limit=25&page=11" + }, + "next": { + "example": "/order-return-line-item?limit=25&page=4" + }, + "prev": { + "example": "/order-return-line-item?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Create a new Order Return Line Item resources.", + "description": "", + "operationId": "createOrderReturnLineItem", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-return-line-item": { + "post": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Search for the Order Return Line Item resources.", + "description": "", + "operationId": "searchOrderReturnLineItem", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item/{id}": { + "get": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Detailed information about a Order Return Line Item resource.", + "description": "", + "operationId": "getOrderReturnLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Delete a Order Return Line Item resource.", + "description": "", + "operationId": "deleteOrderReturnLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item", + "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": [ + "Order Return Line Item" + ], + "summary": "Partially update information about a Order Return Line Item resource.", + "description": "", + "operationId": "updateOrderReturnLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item", + "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 Order Return Line Item resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item-reason": { + "get": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "List with basic information of Order Return Line Item Reason resources.", + "description": "", + "operationId": "getOrderReturnLineItemReasonList", + "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 Order Return Line Item Reason 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/OrderReturnLineItemReason" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return-line-item-reason?limit=25" + }, + "last": { + "example": "/order-return-line-item-reason?limit=25&page=11" + }, + "next": { + "example": "/order-return-line-item-reason?limit=25&page=4" + }, + "prev": { + "example": "/order-return-line-item-reason?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Create a new Order Return Line Item Reason resources.", + "description": "", + "operationId": "createOrderReturnLineItemReason", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-return-line-item-reason": { + "post": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Search for the Order Return Line Item Reason resources.", + "description": "", + "operationId": "searchOrderReturnLineItemReason", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item-reason/{id}": { + "get": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Detailed information about a Order Return Line Item Reason resource.", + "description": "", + "operationId": "getOrderReturnLineItemReason", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item_reason", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Delete a Order Return Line Item Reason resource.", + "description": "", + "operationId": "deleteOrderReturnLineItemReason", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item_reason", + "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": [ + "Order Return Line Item Reason" + ], + "summary": "Partially update information about a Order Return Line Item Reason resource.", + "description": "", + "operationId": "updateOrderReturnLineItemReason", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return_line_item_reason", + "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 Order Return Line Item Reason resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-transaction": { + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Search for the Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderTransaction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-transaction-capture": { + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Search for the Order Transaction Capture resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCapture", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Search for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-transaction-capture-refund-position": { + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Search for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefundPosition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-warehouse-group": { + "get": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "List with basic information of Order Warehouse Group resources.", + "description": "", + "operationId": "getOrderWarehouseGroupList", + "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 Order 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/OrderWarehouseGroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-warehouse-group?limit=25" + }, + "last": { + "example": "/order-warehouse-group?limit=25&page=11" + }, + "next": { + "example": "/order-warehouse-group?limit=25&page=4" + }, + "prev": { + "example": "/order-warehouse-group?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Create a new Order Warehouse Group resources.", + "description": "", + "operationId": "createOrderWarehouseGroup", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-warehouse-group": { + "post": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Search for the Order Warehouse Group resources.", + "description": "", + "operationId": "searchOrderWarehouseGroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-warehouse-group/{id}": { + "get": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Detailed information about a Order Warehouse Group resource.", + "description": "", + "operationId": "getOrderWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_warehouse_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Delete a Order Warehouse Group resource.", + "description": "", + "operationId": "deleteOrderWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_warehouse_group", + "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": [ + "Order Warehouse Group" + ], + "summary": "Partially update information about a Order Warehouse Group resource.", + "description": "", + "operationId": "updateOrderWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_warehouse_group", + "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 Order Warehouse Group resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/payment-method": { + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Search for the Payment Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/plugin": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Search for the Plugin resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPlugin", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product": { + "post": { + "tags": [ + "Product" + ], + "summary": "Search for the Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProduct", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-configurator-setting": { + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Search for the Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductConfiguratorSetting", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-cross-selling": { + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Search for the Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchProductCrossSelling", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-cross-selling-assigned-products": { + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Search for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "searchProductCrossSellingAssignedProducts", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-download": { + "post": { + "tags": [ + "Product Download" + ], + "summary": "Search for the Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "searchProductDownload", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-export": { + "post": { + "tags": [ + "Product Export" + ], + "summary": "Search for the Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchProductExport", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-feature-set": { + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Search for the Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "searchProductFeatureSet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-keyword-dictionary": { + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Search for the Product Keyword Dictionary resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductKeywordDictionary", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-manufacturer": { + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Search for the Product Manufacturer resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductManufacturer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-media": { + "post": { + "tags": [ + "Product Media" + ], + "summary": "Search for the Product Media resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductMedia", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-price": { + "post": { + "tags": [ + "Product Price" + ], + "summary": "Search for the Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductPrice", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-review": { + "post": { + "tags": [ + "Product Review" + ], + "summary": "Search for the Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductReview", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review-summary": { + "get": { + "tags": [ + "Product Review Summary" + ], + "summary": "List with basic information of Product Review Summary resources.", + "description": "", + "operationId": "getProductReviewSummaryList", + "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 Product Review Summary 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/ProductReviewSummary" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-review-summary?limit=25" + }, + "last": { + "example": "/product-review-summary?limit=25&page=11" + }, + "next": { + "example": "/product-review-summary?limit=25&page=4" + }, + "prev": { + "example": "/product-review-summary?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Review Summary" + ], + "summary": "Create a new Product Review Summary resources.", + "description": "", + "operationId": "createProductReviewSummary", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-review-summary": { + "post": { + "tags": [ + "Product Review Summary" + ], + "summary": "Search for the Product Review Summary resources.", + "description": "", + "operationId": "searchProductReviewSummary", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review-summary/{id}": { + "get": { + "tags": [ + "Product Review Summary" + ], + "summary": "Detailed information about a Product Review Summary resource.", + "description": "", + "operationId": "getProductReviewSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review_summary", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Review Summary" + ], + "summary": "Delete a Product Review Summary resource.", + "description": "", + "operationId": "deleteProductReviewSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review_summary", + "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": [ + "Product Review Summary" + ], + "summary": "Partially update information about a Product Review Summary resource.", + "description": "", + "operationId": "updateProductReviewSummary", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_review_summary", + "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 Product Review Summary resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-search-config": { + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Search for the Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchProductSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-search-config-field": { + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Search for the Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchProductSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-search-keyword": { + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Search for the Product Search Keyword resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductSearchKeyword", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Search for the Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "searchProductSorting", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-stream": { + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Search for the Product Stream resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductStream", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-stream-filter": { + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Search for the Product Stream Filter resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-visibility": { + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Search for the Product Visibility resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductVisibility", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-warehouse": { + "get": { + "tags": [ + "Product Warehouse" + ], + "summary": "List with basic information of Product Warehouse resources.", + "description": "", + "operationId": "getProductWarehouseList", + "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 Product Warehouse 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/ProductWarehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/product-warehouse?limit=25" + }, + "last": { + "example": "/product-warehouse?limit=25&page=11" + }, + "next": { + "example": "/product-warehouse?limit=25&page=4" + }, + "prev": { + "example": "/product-warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Warehouse" + ], + "summary": "Create a new Product Warehouse resources.", + "description": "", + "operationId": "createProductWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-warehouse": { + "post": { + "tags": [ + "Product Warehouse" + ], + "summary": "Search for the Product Warehouse resources.", + "description": "", + "operationId": "searchProductWarehouse", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-warehouse/{id}": { + "get": { + "tags": [ + "Product Warehouse" + ], + "summary": "Detailed information about a Product Warehouse resource.", + "description": "", + "operationId": "getProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Product Warehouse" + ], + "summary": "Delete a Product Warehouse resource.", + "description": "", + "operationId": "deleteProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_warehouse", + "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": [ + "Product Warehouse" + ], + "summary": "Partially update information about a Product Warehouse resource.", + "description": "", + "operationId": "updateProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_warehouse", + "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 Product Warehouse resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/promotion": { + "post": { + "tags": [ + "Promotion" + ], + "summary": "Search for the Promotion resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotion", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/promotion-discount": { + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Search for the Promotion Discount resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionDiscount", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/promotion-discount-prices": { + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Search for the Promotion Discount Prices resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionDiscountPrices", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/promotion-individual-code": { + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Search for the Promotion Individual Code resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionIndividualCode", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/promotion-sales-channel": { + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Search for the Promotion Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/promotion-setgroup": { + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Search for the Promotion Setgroup resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPromotionSetgroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/property-group": { + "post": { + "tags": [ + "Property Group" + ], + "summary": "Search for the Property Group resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPropertyGroup", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/property-group-option": { + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Search for the Property Group Option resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchPropertyGroupOption", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote": { + "get": { + "tags": [ + "Quote" + ], + "summary": "List with basic information of Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteList", + "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 Quote 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/Quote" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote?limit=25" + }, + "last": { + "example": "/quote?limit=25&page=11" + }, + "next": { + "example": "/quote?limit=25&page=4" + }, + "prev": { + "example": "/quote?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote" + ], + "summary": "Create a new Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuote", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote": { + "post": { + "tags": [ + "Quote" + ], + "summary": "Search for the Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuote", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote/{id}": { + "get": { + "tags": [ + "Quote" + ], + "summary": "Detailed information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote" + ], + "summary": "Delete a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote", + "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": [ + "Quote" + ], + "summary": "Partially update information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuote", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote", + "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 Quote resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-comment": { + "get": { + "tags": [ + "Quote Comment" + ], + "summary": "List with basic information of Quote Comment resources.", + "description": "", + "operationId": "getQuoteCommentList", + "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 Quote Comment 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/QuoteComment" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-comment?limit=25" + }, + "last": { + "example": "/quote-comment?limit=25&page=11" + }, + "next": { + "example": "/quote-comment?limit=25&page=4" + }, + "prev": { + "example": "/quote-comment?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Comment" + ], + "summary": "Create a new Quote Comment resources.", + "description": "", + "operationId": "createQuoteComment", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-comment": { + "post": { + "tags": [ + "Quote Comment" + ], + "summary": "Search for the Quote Comment resources.", + "description": "", + "operationId": "searchQuoteComment", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-comment/{id}": { + "get": { + "tags": [ + "Quote Comment" + ], + "summary": "Detailed information about a Quote Comment resource.", + "description": "", + "operationId": "getQuoteComment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_comment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Comment" + ], + "summary": "Delete a Quote Comment resource.", + "description": "", + "operationId": "deleteQuoteComment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_comment", + "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": [ + "Quote Comment" + ], + "summary": "Partially update information about a Quote Comment resource.", + "description": "", + "operationId": "updateQuoteComment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_comment", + "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 Quote Comment resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery": { + "get": { + "tags": [ + "Quote Delivery" + ], + "summary": "List with basic information of Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryList", + "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 Quote Delivery 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/QuoteDelivery" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-delivery?limit=25" + }, + "last": { + "example": "/quote-delivery?limit=25&page=11" + }, + "next": { + "example": "/quote-delivery?limit=25&page=4" + }, + "prev": { + "example": "/quote-delivery?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Delivery" + ], + "summary": "Create a new Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDelivery", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-delivery": { + "post": { + "tags": [ + "Quote Delivery" + ], + "summary": "Search for the Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDelivery", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery/{id}": { + "get": { + "tags": [ + "Quote Delivery" + ], + "summary": "Detailed information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Delivery" + ], + "summary": "Delete a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery", + "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": [ + "Quote Delivery" + ], + "summary": "Partially update information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDelivery", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery", + "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 Quote Delivery resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery-position": { + "get": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", + "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 Quote Delivery Position 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/QuoteDeliveryPosition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-delivery-position?limit=25" + }, + "last": { + "example": "/quote-delivery-position?limit=25&page=11" + }, + "next": { + "example": "/quote-delivery-position?limit=25&page=4" + }, + "prev": { + "example": "/quote-delivery-position?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-delivery-position": { + "post": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Search for the Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDeliveryPosition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery-position/{id}": { + "get": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Detailed information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Delete a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "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": [ + "Quote Delivery Position" + ], + "summary": "Partially update information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "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 Quote Delivery Position resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-document": { + "get": { + "tags": [ + "Quote Document" + ], + "summary": "List with basic information of Quote Document resources.", + "description": "", + "operationId": "getQuoteDocumentList", + "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 Quote Document 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/QuoteDocument" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-document?limit=25" + }, + "last": { + "example": "/quote-document?limit=25&page=11" + }, + "next": { + "example": "/quote-document?limit=25&page=4" + }, + "prev": { + "example": "/quote-document?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Document" + ], + "summary": "Create a new Quote Document resources.", + "description": "", + "operationId": "createQuoteDocument", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDocument", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-document": { + "post": { + "tags": [ + "Quote Document" + ], + "summary": "Search for the Quote Document resources.", + "description": "", + "operationId": "searchQuoteDocument", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteDocument", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-document/{id}": { + "get": { + "tags": [ + "Quote Document" + ], + "summary": "Detailed information about a Quote Document resource.", + "description": "", + "operationId": "getQuoteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_document", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteDocument", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Document" + ], + "summary": "Delete a Quote Document resource.", + "description": "", + "operationId": "deleteQuoteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_document", + "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": [ + "Quote Document" + ], + "summary": "Partially update information about a Quote Document resource.", + "description": "", + "operationId": "updateQuoteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_document", + "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 Quote Document resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteDocument", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-employee": { + "get": { + "tags": [ + "Quote Employee" + ], + "summary": "List with basic information of Quote Employee resources.", + "description": "", + "operationId": "getQuoteEmployeeList", + "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 Quote Employee 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/QuoteEmployee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-employee?limit=25" + }, + "last": { + "example": "/quote-employee?limit=25&page=11" + }, + "next": { + "example": "/quote-employee?limit=25&page=4" + }, + "prev": { + "example": "/quote-employee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Employee" + ], + "summary": "Create a new Quote Employee resources.", + "description": "", + "operationId": "createQuoteEmployee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-employee": { + "post": { + "tags": [ + "Quote Employee" + ], + "summary": "Search for the Quote Employee resources.", + "description": "", + "operationId": "searchQuoteEmployee", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-employee/{id}": { + "get": { + "tags": [ + "Quote Employee" + ], + "summary": "Detailed information about a Quote Employee resource.", + "description": "", + "operationId": "getQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Employee" + ], + "summary": "Delete a Quote Employee resource.", + "description": "", + "operationId": "deleteQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "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": [ + "Quote Employee" + ], + "summary": "Partially update information about a Quote Employee resource.", + "description": "", + "operationId": "updateQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "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 Quote Employee resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-line-item": { + "get": { + "tags": [ + "Quote Line Item" + ], + "summary": "List with basic information of Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItemList", + "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 Quote Line Item 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/QuoteLineItem" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-line-item?limit=25" + }, + "last": { + "example": "/quote-line-item?limit=25&page=11" + }, + "next": { + "example": "/quote-line-item?limit=25&page=4" + }, + "prev": { + "example": "/quote-line-item?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Line Item" + ], + "summary": "Create a new Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteLineItem", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-line-item": { + "post": { + "tags": [ + "Quote Line Item" + ], + "summary": "Search for the Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteLineItem", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-line-item/{id}": { + "get": { + "tags": [ + "Quote Line Item" + ], + "summary": "Detailed information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_line_item", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Line Item" + ], + "summary": "Delete a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_line_item", + "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": [ + "Quote Line Item" + ], + "summary": "Partially update information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteLineItem", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_line_item", + "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 Quote Line Item resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-transaction": { + "get": { + "tags": [ + "Quote Transaction" + ], + "summary": "List with basic information of Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", + "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 Quote Transaction 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/QuoteTransaction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-transaction?limit=25" + }, + "last": { + "example": "/quote-transaction?limit=25&page=11" + }, + "next": { + "example": "/quote-transaction?limit=25&page=4" + }, + "prev": { + "example": "/quote-transaction?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Quote Transaction" + ], + "summary": "Create a new Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/quote-transaction": { + "post": { + "tags": [ + "Quote Transaction" + ], + "summary": "Search for the Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteTransaction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-transaction/{id}": { + "get": { + "tags": [ + "Quote Transaction" + ], + "summary": "Detailed information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_transaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Transaction" + ], + "summary": "Delete a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_transaction", + "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": [ + "Quote Transaction" + ], + "summary": "Partially update information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_transaction", + "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 Quote Transaction resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/rule": { + "post": { + "tags": [ + "Rule" + ], + "summary": "Search for the Rule resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchRule", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/rule-condition": { + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Search for the Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchRuleCondition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sales-channel": { + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Search for the Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sales-channel-analytics": { + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Search for the Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "searchSalesChannelAnalytics", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sales-channel-domain": { + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Search for the Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannelDomain", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sales-channel-type": { + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Search for the Sales Channel Type resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalesChannelType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/salutation": { + "post": { + "tags": [ + "Salutation" + ], + "summary": "Search for the Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalutation", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Search for the Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchScheduledTask", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/script": { + "post": { + "tags": [ + "Script" + ], + "summary": "Search for the Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchScript", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/seo-url": { + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Search for the Seo Url resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSeoUrl", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/seo-url-template": { + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Search for the Seo Url Template resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSeoUrlTemplate", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/shipping-method": { + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Search for the Shipping Method resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/shipping-method-price": { + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Search for the Shipping Method Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchShippingMethodPrice", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Search for the Snippet resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSnippet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/snippet-set": { + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Search for the Snippet Set resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSnippetSet", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-render-config-size": { + "get": { + "tags": [ + "Spatial Render Config Size", + "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.", + "description": "", + "operationId": "getSpatialRenderConfigSizeList", + "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 Spatial Render Config Size 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/SpatialRenderConfigSize" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-render-config-size?limit=25" + }, + "last": { + "example": "/spatial-render-config-size?limit=25&page=11" + }, + "next": { + "example": "/spatial-render-config-size?limit=25&page=4" + }, + "prev": { + "example": "/spatial-render-config-size?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Render Config Size", + "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.", + "description": "", + "operationId": "createSpatialRenderConfigSize", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialRenderConfigSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-render-config-size": { + "post": { + "tags": [ + "Spatial Render Config Size", + "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.", + "description": "", + "operationId": "searchSpatialRenderConfigSize", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SpatialRenderConfigSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-render-config-size/{id}": { + "get": { + "tags": [ + "Spatial Render Config Size", + "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.", + "description": "", + "operationId": "getSpatialRenderConfigSize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_render_config_size", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialRenderConfigSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Render Config Size", + "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.", + "description": "", + "operationId": "deleteSpatialRenderConfigSize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_render_config_size", + "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": [ + "Spatial Render Config Size", + "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.", + "description": "", + "operationId": "updateSpatialRenderConfigSize", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_render_config_size", + "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 Spatial Render Config Size resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialRenderConfigSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene": { + "get": { + "tags": [ + "Spatial Scene", + "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.", + "description": "", + "operationId": "getSpatialSceneList", + "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 Spatial Scene 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/SpatialScene" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene?limit=25" + }, + "last": { + "example": "/spatial-scene?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene", + "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.", + "description": "", + "operationId": "createSpatialScene", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialScene", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene": { + "post": { + "tags": [ + "Spatial Scene", + "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.", + "description": "", + "operationId": "searchSpatialScene", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SpatialScene", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene/{id}": { + "get": { + "tags": [ + "Spatial Scene", + "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.", + "description": "", + "operationId": "getSpatialScene", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialScene", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene", + "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.", + "description": "", + "operationId": "deleteSpatialScene", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene", + "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": [ + "Spatial Scene", + "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.", + "description": "", + "operationId": "updateSpatialScene", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene", + "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 Spatial Scene resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialScene", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-camera": { + "get": { + "tags": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "getSpatialSceneCameraList", + "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 Spatial Scene Camera 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/SpatialSceneCamera" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-camera?limit=25" + }, + "last": { + "example": "/spatial-scene-camera?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-camera?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-camera?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "createSpatialSceneCamera", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneCamera", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-camera": { + "post": { + "tags": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "searchSpatialSceneCamera", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SpatialSceneCamera", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-camera/{id}": { + "get": { + "tags": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "getSpatialSceneCamera", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_camera", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneCamera", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "deleteSpatialSceneCamera", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_camera", + "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": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "updateSpatialSceneCamera", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_camera", + "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 Spatial Scene Camera resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneCamera", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-light": { + "get": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "getSpatialSceneLightList", + "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 Spatial Scene Light 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/SpatialSceneLight" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-light?limit=25" + }, + "last": { + "example": "/spatial-scene-light?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-light?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-light?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "createSpatialSceneLight", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-light": { + "post": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "searchSpatialSceneLight", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-light/{id}": { + "get": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "getSpatialSceneLight", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_light", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "deleteSpatialSceneLight", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_light", + "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": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "updateSpatialSceneLight", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_light", + "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 Spatial Scene Light resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-object": { + "get": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "getSpatialSceneObjectList", + "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 Spatial Scene Object 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/SpatialSceneObject" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-object?limit=25" + }, + "last": { + "example": "/spatial-scene-object?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-object?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-object?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "createSpatialSceneObject", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-object": { + "post": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "searchSpatialSceneObject", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-object/{id}": { + "get": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "getSpatialSceneObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_object", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "deleteSpatialSceneObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_object", + "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": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "updateSpatialSceneObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_object", + "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 Spatial Scene Object resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider": { + "get": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "getSsoProviderList", + "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 Sso Provider 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/SsoProvider" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sso-provider?limit=25" + }, + "last": { + "example": "/sso-provider?limit=25&page=11" + }, + "next": { + "example": "/sso-provider?limit=25&page=4" + }, + "prev": { + "example": "/sso-provider?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "createSsoProvider", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sso-provider": { + "post": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "searchSsoProvider", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider/{id}": { + "get": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "getSsoProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "deleteSsoProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider", + "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": [ + "Sso Provider", + "Experimental" + ], + "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": "updateSsoProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider", + "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 Sso Provider resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider-customer": { + "get": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "getSsoProviderCustomerList", + "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 Sso Provider 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/SsoProviderCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sso-provider-customer?limit=25" + }, + "last": { + "example": "/sso-provider-customer?limit=25&page=11" + }, + "next": { + "example": "/sso-provider-customer?limit=25&page=4" + }, + "prev": { + "example": "/sso-provider-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "createSsoProviderCustomer", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sso-provider-customer": { + "post": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "searchSsoProviderCustomer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider-customer/{id}": { + "get": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "getSsoProviderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "deleteSsoProviderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "updateSsoProviderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Sso Provider Customer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/state-machine": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Search for the State Machine resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachine", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Search for the State Machine History resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/state-machine-state": { + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Search for the State Machine State resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachineState", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/state-machine-transition": { + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Search for the State Machine Transition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchStateMachineTransition", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription": { + "get": { + "tags": [ + "Subscription" + ], + "summary": "List with basic information of Subscription resources.", + "description": "", + "operationId": "getSubscriptionList", + "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 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/Subscription" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription?limit=25" + }, + "last": { + "example": "/subscription?limit=25&page=11" + }, + "next": { + "example": "/subscription?limit=25&page=4" + }, + "prev": { + "example": "/subscription?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription" + ], + "summary": "Create a new Subscription resources.", + "description": "", + "operationId": "createSubscription", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription": { + "post": { + "tags": [ + "Subscription" + ], + "summary": "Search for the Subscription resources.", + "description": "", + "operationId": "searchSubscription", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription/{id}": { + "get": { + "tags": [ + "Subscription" + ], + "summary": "Detailed information about a Subscription resource.", + "description": "", + "operationId": "getSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription" + ], + "summary": "Delete a Subscription resource.", + "description": "", + "operationId": "deleteSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "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" + ], + "summary": "Partially update information about a Subscription resource.", + "description": "", + "operationId": "updateSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "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 resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-address": { + "get": { + "tags": [ + "Subscription Address" + ], + "summary": "List with basic information of Subscription Address resources.", + "description": "", + "operationId": "getSubscriptionAddressList", + "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 Address 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/SubscriptionAddress" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-address?limit=25" + }, + "last": { + "example": "/subscription-address?limit=25&page=11" + }, + "next": { + "example": "/subscription-address?limit=25&page=4" + }, + "prev": { + "example": "/subscription-address?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Address" + ], + "summary": "Create a new Subscription Address resources.", + "description": "", + "operationId": "createSubscriptionAddress", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription-address": { + "post": { + "tags": [ + "Subscription Address" + ], + "summary": "Search for the Subscription Address resources.", + "description": "", + "operationId": "searchSubscriptionAddress", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-address/{id}": { + "get": { + "tags": [ + "Subscription Address" + ], + "summary": "Detailed information about a Subscription Address resource.", + "description": "", + "operationId": "getSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Address" + ], + "summary": "Delete a Subscription Address resource.", + "description": "", + "operationId": "deleteSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "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 Address" + ], + "summary": "Partially update information about a Subscription Address resource.", + "description": "", + "operationId": "updateSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "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 Address resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-customer": { + "get": { + "tags": [ + "Subscription Customer" + ], + "summary": "List with basic information of Subscription Customer resources.", + "description": "", + "operationId": "getSubscriptionCustomerList", + "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 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/SubscriptionCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-customer?limit=25" + }, + "last": { + "example": "/subscription-customer?limit=25&page=11" + }, + "next": { + "example": "/subscription-customer?limit=25&page=4" + }, + "prev": { + "example": "/subscription-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Customer" + ], + "summary": "Create a new Subscription Customer resources.", + "description": "", + "operationId": "createSubscriptionCustomer", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription-customer": { + "post": { + "tags": [ + "Subscription Customer" + ], + "summary": "Search for the Subscription Customer resources.", + "description": "", + "operationId": "searchSubscriptionCustomer", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-customer/{id}": { + "get": { + "tags": [ + "Subscription Customer" + ], + "summary": "Detailed information about a Subscription Customer resource.", + "description": "", + "operationId": "getSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Customer" + ], + "summary": "Delete a Subscription Customer resource.", + "description": "", + "operationId": "deleteSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Subscription Customer" + ], + "summary": "Partially update information about a Subscription Customer resource.", + "description": "", + "operationId": "updateSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Subscription Customer resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-interval": { + "get": { + "tags": [ + "Subscription Interval" + ], + "summary": "List with basic information of Subscription Interval resources.", + "description": "", + "operationId": "getSubscriptionIntervalList", + "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 Interval 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/SubscriptionInterval" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-interval?limit=25" + }, + "last": { + "example": "/subscription-interval?limit=25&page=11" + }, + "next": { + "example": "/subscription-interval?limit=25&page=4" + }, + "prev": { + "example": "/subscription-interval?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Interval" + ], + "summary": "Create a new Subscription Interval resources.", + "description": "", + "operationId": "createSubscriptionInterval", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription-interval": { + "post": { + "tags": [ + "Subscription Interval" + ], + "summary": "Search for the Subscription Interval resources.", + "description": "", + "operationId": "searchSubscriptionInterval", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "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-interval/{id}": { + "get": { + "tags": [ + "Subscription Interval" + ], + "summary": "Detailed information about a Subscription Interval resource.", + "description": "", + "operationId": "getSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Interval" + ], + "summary": "Delete a Subscription Interval resource.", + "description": "", + "operationId": "deleteSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "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 Interval" + ], + "summary": "Partially update information about a Subscription Interval resource.", + "description": "", + "operationId": "updateSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "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 Interval resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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" + } + } + } + }, + "/swag-delay-action": { + "get": { + "tags": [ + "Swag Delay Action" + ], + "summary": "List with basic information of Swag Delay Action resources.", + "description": "", + "operationId": "getSwagDelayActionList", + "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 Delay Action 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/SwagDelayAction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-delay-action?limit=25" + }, + "last": { + "example": "/swag-delay-action?limit=25&page=11" + }, + "next": { + "example": "/swag-delay-action?limit=25&page=4" + }, + "prev": { + "example": "/swag-delay-action?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Create a new Swag Delay Action resources.", + "description": "", + "operationId": "createSwagDelayAction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-delay-action": { + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Search for the Swag Delay Action resources.", + "description": "", + "operationId": "searchSwagDelayAction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-delay-action/{id}": { + "get": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Detailed information about a Swag Delay Action resource.", + "description": "", + "operationId": "getSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Delete a Swag Delay Action resource.", + "description": "", + "operationId": "deleteSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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 Delay Action" + ], + "summary": "Partially update information about a Swag Delay Action resource.", + "description": "", + "operationId": "updateSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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 Delay Action resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/system-config": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Search for the System Config resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSystemConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/tag": { + "post": { + "tags": [ + "Tag" + ], + "summary": "Search for the Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTag", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/tax": { + "post": { + "tags": [ + "Tax" + ], + "summary": "Search for the Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTax", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/tax-provider": { + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Search for the Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "searchTaxProvider", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/tax-rule": { + "post": { + "tags": [ + "Tax Rule" + ], + "summary": "Search for the Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRule", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/tax-rule-type": { + "post": { + "tags": [ + "Tax Rule Type" + ], + "summary": "Search for the Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRuleType", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/theme": { + "post": { + "tags": [ + "Theme" + ], + "summary": "Search for the Theme resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTheme", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/unit": { + "post": { + "tags": [ + "Unit" + ], + "summary": "Search for the Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUnit", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/user": { + "post": { + "tags": [ + "User" + ], + "summary": "Search for the User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUser", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/user-access-key": { + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Search for the User Access Key resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/user-config": { + "post": { + "tags": [ + "User Config" + ], + "summary": "Search for the User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchUserConfig", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/user-recovery": { + "post": { + "tags": [ + "User Recovery" + ], + "summary": "Search for the User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserRecovery", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "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" + } + } + } + }, + "/warehouse": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "List with basic information of Warehouse resources.", + "description": "", + "operationId": "getWarehouseList", + "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 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/Warehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/warehouse?limit=25" + }, + "last": { + "example": "/warehouse?limit=25&page=11" + }, + "next": { + "example": "/warehouse?limit=25&page=4" + }, + "prev": { + "example": "/warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Create a new Warehouse resources.", + "description": "", + "operationId": "createWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/warehouse": { + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Search for the Warehouse resources.", + "description": "", + "operationId": "searchWarehouse", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "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/{id}": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "Detailed information about a Warehouse resource.", + "description": "", + "operationId": "getWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse" + ], + "summary": "Delete a Warehouse resource.", + "description": "", + "operationId": "deleteWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "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": [ + "Warehouse" + ], + "summary": "Partially update information about a Warehouse resource.", + "description": "", + "operationId": "updateWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "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 Warehouse resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of WarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse-group/{id}": { + "get": { + "tags": [ + "Warehouse Group" + ], + "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}$" + } + } + ], + "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" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse Group" + ], + "summary": "Delete a Warehouse Group resource.", + "description": "", + "operationId": "deleteWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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": [ + "Warehouse Group" + ], + "summary": "Partially update information about a Warehouse Group resource.", + "description": "", + "operationId": "updateWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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 Warehouse Group resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "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" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "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", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "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" + } + } + } + }, + "/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", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "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" + } + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "/_action/order/{orderId}/order-address": { + "post": { + "tags": [ + "Order address" + ], + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "type": "string", + "description": "The ID of the delivery (optional)", + "nullable": true + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" + }, + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/system-health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" + } + ], + "responses": { + "200": { + "description": "Returns the system health check results", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_action/custom-price": { + "post": { + "tags": [ + "Bulk Operations" + ], + "summary": "Bulk edit custom prices", + "description": "An emulation of Sync API implementation", + "operationId": "customPriceImport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomPricingUpsertOperation" + }, + { + "$ref": "#/components/schemas/CustomPricingDeleteOperation" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Returns a JSON result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPricingResponse" + } + } + } + } + } + } + }, + "/api/_admin/rule-builder-preview/{orderId}": { + "post": { + "tags": [ + "Rule Preview" + ], + "summary": "Preview results of a rule evaluating an order", + "description": "Evaluate the conditions of a rule based on a pre-selected order.", + "operationId": "rulePreview", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order the preview should be generated for", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "conditions" + ], + "properties": { + "conditions": { + "description": "Array of nested rule condition payloads.", + "items": { + "type": "object" + }, + "type": "array" + }, + "dateTime": { + "description": "A date and time to be mocked in the preview evaluation.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the results of the evaluated rule conditions as an object.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "properties": { + "match": { + "description": "Evaluation of the condition", + "type": "boolean" + }, + "name": { + "description": "The technical name of the condition", + "type": "string" + }, + "ruleReferenceId": { + "description": "The id of the corresponding rule_condition entity", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + } + }, + "/_action/invite-employee": { + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Sends an invite email to employee", + "description": "This route is used to send an invite email to an employee", + "operationId": "inviteEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the employee to invite", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Id of the sales channel through which the registration will be fulfilled.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "required": [ + "id" + ], + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/create-employee": { + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Creates an employee", + "description": "This route is used to create an employee", + "operationId": "createEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "firstName": { + "description": "First name of the new employee", + "type": "string" + }, + "lastName": { + "description": "Last name of the new employee", + "type": "string" + }, + "email": { + "description": "Email of the new employee", + "type": "string" + }, + "roleId": { + "description": "Id of the role of the new employee", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "IDs of the created employees", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Array of the created employee ids", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/_action/update-employee": { + "patch": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Updates an employee", + "description": "This route is used to update an employee", + "operationId": "updateEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the employee", + "type": "string" + }, + "firstName": { + "description": "First name of the employee", + "type": "string" + }, + "lastName": { + "description": "Last name of the employee", + "type": "string" + }, + "email": { + "description": "Email of the employee", + "type": "string" + }, + "roleId": { + "description": "Id of the role of the employee", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_proxy-quote/{salesChannelId}": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Create a new quote", + "description": "This route is used to create a new quote from admin", + "operationId": "createQuoteFromAdmin", + "parameters": [ + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Quote entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "/_action/quote/{quoteId}/product/{productId}": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Add product to quote", + "description": "This route is used to add a product to a quote from admin", + "operationId": "addProductToQuote", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "productId", + "in": "path", + "description": "Identifier of the product to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "quantity": { + "type": "integer", + "pattern": "int32" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/lineItem": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Add custom line item to quote", + "description": "This route is used to add a custom line item to a quote from admin", + "operationId": "addCustomLineItemToQuote", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "identifier": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string", + "default": "custom" + }, + "quantity": { + "type": "integer", + "pattern": "int32" + }, + "label": { + "type": "string", + "default": "null" + }, + "description": { + "type": "string", + "default": "null" + }, + "removable": { + "type": "boolean", + "default": true + }, + "stackable": { + "type": "boolean", + "default": true + }, + "payload": { + "type": "array", + "items": { + "type": "object" + } + }, + "priceDefinition": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/recalculate": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Recalculate a quote", + "description": "This route is used to recalculate a quote", + "operationId": "recalculateQuote", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/comment": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Create a new comment", + "description": "This route is used to create a new comment from admin", + "operationId": "createComment", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { + "description": "Message content", + "type": "string" + }, + "state": { + "description": "Current quote state", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/text-to-image/generate": { + "post": { + "tags": [ + "Text to Image", + "Experimental" + ], + "summary": "Generate images based on a textual prompt", + "description": "Experimental until v6.7.0\n\nGenerate images based on a textual prompt", + "operationId": "textToImageGenerate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "The textual prompt to describe what image to generate", + "type": "string", + "example": "Generate a warm and inviting ambience with soft lightning and neutral tones" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "The base64 string representation of the generated image", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "byte", + "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAJZlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgExAAIAAAARAAAAWodpAAQAAAABAAAAbAAAAAAAAABgAAAAAQAAAGAAAAABd3d3Lmlua3NjYXBlLm9yZwAAAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAABAAAAAAKwl1NwAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAi1pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+d3d3Lmlua3NjYXBlLm9yZzwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj45NjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+OTY8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgryNKKqAAAC8klEQVQ4EV1Tz0tUURg99943zpvGcWaqaRTJ7CdGvzBtkVQYFLjxD3AlZFREUZv21q4f1CLBCLR2bdoVBVmbchGUiUQU0i8oNUEsG9/MOG/uvZ07Y2B9vPu473HP+c53vvsJuOi3Ev3CuO26IbtHAH1K4EBSIlvDf0rY2aQSo63JcOh6d82EO9dvrewXwoiV4Pphe1N7OJP2gaAETBV40tE6lihXCLQAAx96xVl+wZKEyaqRHbYjtg5HUjlrJkOhoSCvrC+J1voQ62q1jXnGWAvl16WkV5p/2phdc9QhKwT1Q3bQJnEquYjiZBH+mazGufYcGpMhhLDQFGqXEymJYqw24y/8nBtMrc6cFg13bZtVeB0rQ38JoXrTGtcO/0I8alAMqwKjXhVOBZAkJKsWyleLwVI7heGEiAG+ZrUUfmpnHgl+BEsSzFYBjH/38XIqypqBbNygZW1o9m2LKVMunPCorEPRnG8GcmfMojEVolQWTELvmHliyseBZ4mqkU6IM9X68uo00LPd63AEG1GGe2SEICfagf9GZcvXhghbrGwFryHkhffAj1zdRookmMxN3I0XBOYCj32vwpfowY6GIh51BGiKWLzKC4zxzG+q2LwKmAwULxDwRZCdYZzVI599KnBaq+E60Lk1j/td83hxKIeLTSE+069PLLtk8VWw/7dkHCdNgDAhEPm4BDzZH6BzS4BCSUKTy5kXUW7RZyswsxAJn/9IRd5O69ti7bDd63kYs2yjgmWVPED2e7sLOMLMriNlLVDickTOH7ZVR/2o+pkvtcu5Y+INwQMyCVWGKPJu2mZe3Z7xGI6PpPHwXS1mc16lI7GIca0trkpk1O/FcDCTyowt21UZoscqhS69AENjdFpCvicjOBOSV+BSY2i6NhVU29Y6ufBr7mkqnVm+yismMXvH3oDEeclhMizDp9u1TDHPNeN85b8He/ID3W3x/4bpX5Jd7EYfMQcJqad3iEvMNteY0daEHrq8PM6VSeQ4/wGOAT89rW8MpwAAAABJRU5ErkJggg==" + } + } + } + } + } + } + } + }, + "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" + }, + "AdvancedSearchActionJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configId", + "type", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "active": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "typeConfig": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "searchTerms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action_search_term" + }, + "id": { + "type": "string", + "example": "952c07f523c564f09844ca7f880c2467" + } + } + } + } + }, + "type": "object" + }, + "config": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchAction": { + "required": [ + "id", + "configId", + "type", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "active": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "typeConfig": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "searchTerms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + }, + "type": "object" + }, + "AdvancedSearchActionSearchTermJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "term", + "salesChannelId", + "actionId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "term": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionId": { + "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": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "action": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "418c5509e2171d55b0aee5c2ea4442b5" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchActionSearchTerm": { + "required": [ + "id", + "term", + "salesChannelId", + "actionId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "term": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionId": { + "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" + }, + "action": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + }, + "type": "object" + }, + "AdvancedSearchBoostingJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "boost", + "name", + "configId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "boost": { + "type": "number", + "format": "float" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "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": { + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "entityStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62acf68da615789a0175ef827f74acbb" + } + } + } + }, + "type": "object" + }, + "config": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchBoosting": { + "required": [ + "id", + "boost", + "name", + "configId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "boost": { + "type": "number", + "format": "float" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "entityStream": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + }, + "type": "object" + }, + "AdvancedSearchConfigJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salesChannelId", + "esEnabled", + "andLogic", + "minSearchLength", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "esEnabled": { + "type": "boolean" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "hitCount": { + "properties": { + "product": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "product_manufacturer": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "category": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + } + }, + "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": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "fields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "d05b6ed7d2345020440df396d6da7f73" + } + } + } + } + }, + "type": "object" + }, + "boostings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_boosting" + }, + "id": { + "type": "string", + "example": "8e571802e4ea39b214104ca60e13b5a6" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchConfig": { + "required": [ + "id", + "salesChannelId", + "esEnabled", + "andLogic", + "minSearchLength", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "esEnabled": { + "type": "boolean" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "hitCount": { + "properties": { + "product": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "product_manufacturer": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "category": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + }, + "boostings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + }, + "type": "object" + }, + "AdvancedSearchConfigFieldJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configId", + "entity", + "field", + "tokenize", + "searchable", + "ranking", + "createdAt" + ], + "properties": { + "id": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "type": { + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { "type": "string" }, - "name": { + "field": { "type": "string" }, - "typeConfig": { + "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": { + "config": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" + } + } + } + }, + "type": "object" + }, + "customField": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/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" + } + ] + }, + "AdvancedSearchConfigField": { + "required": [ + "id", + "configId", + "entity", + "field", + "tokenize", + "searchable", + "ranking", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "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 + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + }, + "customField": { + "$ref": "#/components/schemas/CustomField" + } + }, + "type": "object" + }, + "AdvancedSearchEntityStreamJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true }, "createdAt": { "type": "string", @@ -16025,7 +38138,7 @@ }, "relationships": { "properties": { - "searchTerms": { + "filters": { "properties": { "links": { "type": "object", @@ -16033,7 +38146,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" + "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" } } }, @@ -16044,11 +38157,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_action_search_term" + "example": "advanced_search_entity_stream_filter" }, "id": { "type": "string", - "example": "952c07f523c564f09844ca7f880c2467" + "example": "2c9885d2b0c7e26971f60a90f33cf718" } } } @@ -16056,7 +38169,202 @@ }, "type": "object" }, - "config": { + "boosting": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_boosting" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ab105abdd48ced24ce7b0e516ca0970" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchEntityStream": { + "required": [ + "id", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + }, + "boosting": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + }, + "type": "object" + }, + "AdvancedSearchEntityStreamFilterJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entityStreamId", + "type", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "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" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "entityStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62acf68da615789a0175ef827f74acbb" + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "queries": { "properties": { "links": { "type": "object", @@ -16064,21 +38372,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "example": "5da7eb4247add5dbd5776c9c0b38460a" + } } } } @@ -16093,11 +38403,11 @@ } ] }, - "AdvancedSearchAction": { + "AdvancedSearchEntityStreamFilter": { "required": [ - "configId", + "id", + "entityStreamId", "type", - "name", "createdAt" ], "properties": { @@ -16105,30 +38415,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { + "entityStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "validFrom": { + "parentId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "validTo": { - "type": "string", - "format": "date-time" + "type": { + "type": "string" }, - "active": { - "type": "boolean" + "field": { + "type": "string" }, - "type": { + "operator": { "type": "string" }, - "name": { + "value": { "type": "string" }, - "typeConfig": { + "parameters": { "type": "object" }, + "position": { + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16139,28 +38452,30 @@ "format": "date-time", "readOnly": true }, - "searchTerms": { + "entityStream": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "parent": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + }, + "queries": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" } - }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" } }, "type": "object" }, - "AdvancedSearchActionSearchTermJsonApi": { + "AdvancedSearchSynonymJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "term", - "salesChannelId", - "actionId", + "id", + "left", "createdAt" ], "properties": { @@ -16168,14 +38483,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "term": { - "type": "string" + "left": { + "type": "array", + "items": { + "type": "string" + } }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "right": { + "type": "array", + "items": { + "type": "string" + } }, - "actionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -16191,36 +38511,7 @@ }, "relationships": { "properties": { - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - }, - "action": { + "language": { "properties": { "links": { "type": "object", @@ -16228,7 +38519,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" + "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language" } } }, @@ -16237,12 +38528,12 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_action" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "418c5509e2171d55b0aee5c2ea4442b5" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -16257,11 +38548,10 @@ } ] }, - "AdvancedSearchActionSearchTerm": { + "AdvancedSearchSynonym": { "required": [ - "term", - "salesChannelId", - "actionId", + "id", + "left", "createdAt" ], "properties": { @@ -16269,14 +38559,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "term": { - "type": "string" + "left": { + "type": "array", + "items": { + "type": "string" + } }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "right": { + "type": "array", + "items": { + "type": "string" + } }, - "actionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -16290,59 +38585,120 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "action": { - "$ref": "#/components/schemas/AdvancedSearchAction" + "language": { + "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "AdvancedSearchBoostingJsonApi": { + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "boost", + "id", "name", - "configId", - "createdAt" + "path", + "active", + "configurable", + "version", + "allowDisable", + "integrationId", + "aclRoleId", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "validFrom": { - "type": "string", - "format": "date-time" + "name": { + "type": "string" }, - "validTo": { - "type": "string", - "format": "date-time" + "path": { + "type": "string" }, - "boost": { - "type": "number", - "format": "float" + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" }, "active": { "type": "boolean" }, - "name": { + "configurable": { + "type": "boolean" + }, + "privacy": { "type": "string" }, - "productStreamId": { + "version": { + "type": "string" + }, + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "entityStreamId": { + "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}$" }, - "configId": { + "aclRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -16356,9 +38712,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "productStream": { + "integration": { "properties": { "links": { "type": "object", @@ -16366,7 +38725,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" } } }, @@ -16375,19 +38734,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "integration" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "776ea3bf11df5829827f7afb43c37174" } } } }, "type": "object" }, - "entityStream": { + "aclRole": { "properties": { "links": { "type": "object", @@ -16395,7 +38754,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" } } }, @@ -16404,19 +38763,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream" + "example": "acl_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62acf68da615789a0175ef827f74acbb" + "example": "250aa1c64b973365fd6fd489eefbdefc" } } } }, "type": "object" }, - "config": { + "customFieldSets": { "properties": { "links": { "type": "object", @@ -16424,188 +38783,216 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } + } + } + } + }, + "type": "object" + }, + "actionButtons": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "advanced_search_config" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" + "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" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AdvancedSearchBoosting": { - "required": [ - "boost", - "name", - "configId", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { - "type": "string", - "format": "date-time" - }, - "boost": { - "type": "number", - "format": "float" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" - }, - "entityStream": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" - }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" - } - }, - "type": "object" - }, - "AdvancedSearchConfigJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "salesChannelId", - "esEnabled", - "andLogic", - "minSearchLength", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "esEnabled": { - "type": "boolean" - }, - "andLogic": { - "type": "boolean" - }, - "minSearchLength": { - "type": "integer", - "format": "int64" - }, - "hitCount": { - "properties": { - "product": { + }, + "webhooks": { "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" + } + } }, - "maxSearchCount": { - "type": "integer", - "format": "int64" + "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" }, - "product_manufacturer": { + "taxProviders": { "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + } + } }, - "maxSearchCount": { - "type": "integer", - "format": "int64" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tax_provider" + }, + "id": { + "type": "string", + "example": "01a1a9d428b6402dc8255d99c787a00e" + } + } + } } }, "type": "object" }, - "category": { + "cmsBlocks": { "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + } + } }, - "maxSearchCount": { - "type": "integer", - "format": "int64" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } + } + } } }, "type": "object" - } - }, - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "salesChannel": { + }, + "flowActions": { "properties": { "links": { "type": "object", @@ -16613,28 +39000,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_flow_action" + }, + "id": { + "type": "string", + "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + } } } } }, "type": "object" }, - "fields": { + "flowEvents": { "properties": { "links": { "type": "object", @@ -16642,7 +39031,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" } } }, @@ -16653,11 +39042,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_config_field" + "example": "app_flow_event" }, "id": { "type": "string", - "example": "d05b6ed7d2345020440df396d6da7f73" + "example": "045e9ec14eafd26d17854fb4fe7c9cae" } } } @@ -16665,7 +39054,7 @@ }, "type": "object" }, - "boostings": { + "appShippingMethods": { "properties": { "links": { "type": "object", @@ -16673,7 +39062,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" + "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" } } }, @@ -16684,11 +39073,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_boosting" + "example": "app_shipping_method" }, "id": { "type": "string", - "example": "8e571802e4ea39b214104ca60e13b5a6" + "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } @@ -16704,77 +39093,112 @@ } ] }, - "AdvancedSearchConfig": { + "App": { + "description": "Added since version: 6.3.1.0", "required": [ - "salesChannelId", - "esEnabled", - "andLogic", - "minSearchLength", - "createdAt" + "id", + "name", + "path", + "active", + "configurable", + "version", + "allowDisable", + "integrationId", + "aclRoleId", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "esEnabled": { + "path": { + "type": "string" + }, + "author": { + "type": "string" + }, + "copyright": { + "type": "string" + }, + "license": { + "type": "string" + }, + "active": { "type": "boolean" }, - "andLogic": { + "configurable": { "type": "boolean" }, - "minSearchLength": { + "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" }, - "hitCount": { - "properties": { - "product": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "product_manufacturer": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "category": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - } - }, + "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", @@ -16785,67 +39209,118 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "translated": { + "type": "object" }, - "fields": { + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" + "$ref": "#/components/schemas/CustomFieldSet" } }, - "boostings": { + "actionButtons": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "$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" }, - "AdvancedSearchConfigFieldJsonApi": { + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "configId", + "id", "entity", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "view", + "url", + "action", + "appId", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "entity": { "type": "string" }, - "field": { + "view": { "type": "string" }, - "tokenize": { - "type": "boolean" + "url": { + "type": "string" }, - "searchable": { - "type": "boolean" + "action": { + "type": "string" }, - "ranking": { - "type": "integer", - "format": "int64" + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -16857,38 +39332,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "config": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" - } - } - } - }, - "type": "object" - }, - "customField": { + "app": { "properties": { "links": { "type": "object", @@ -16896,7 +39345,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/customField" + "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" } } }, @@ -16905,12 +39354,12 @@ "properties": { "type": { "type": "string", - "example": "custom_field" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ed2028a1c479c7e0065da597452d9c11" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -16925,14 +39374,113 @@ } ] }, - "AdvancedSearchConfigField": { + "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": [ - "configId", - "entity", - "field", - "tokenize", - "searchable", - "ranking", + "id", + "value", + "appId", + "localeId", "createdAt" ], "properties": { @@ -16940,30 +39488,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { + "value": { + "type": "string" + }, + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldId": { + "localeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "type": "string" - }, - "field": { - "type": "string" - }, - "tokenize": { - "type": "boolean" - }, - "searchable": { - "type": "boolean" - }, - "ranking": { - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -16973,41 +39508,50 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" - }, - "customField": { - "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, - "AdvancedSearchEntityStreamJsonApi": { + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "type", - "createdAt" + "id", + "name", + "block", + "template", + "styles", + "appId", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "name": { "type": "string" }, - "apiFilter": { - "type": "object", - "readOnly": true + "block": { + "type": "object" }, - "invalid": { - "type": "boolean", - "readOnly": true + "template": { + "type": "string" + }, + "styles": { + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -17019,40 +39563,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "filters": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_entity_stream_filter" - }, - "id": { - "type": "string", - "example": "2c9885d2b0c7e26971f60a90f33cf718" - } - } - } - } - }, - "type": "object" - }, - "boosting": { + "app": { "properties": { "links": { "type": "object", @@ -17060,7 +39576,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" } } }, @@ -17069,12 +39585,12 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_boosting" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "6ab105abdd48ced24ce7b0e516ca0970" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -17089,26 +39605,41 @@ } ] }, - "AdvancedSearchEntityStream": { + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", "required": [ - "type", - "createdAt" + "id", + "name", + "block", + "template", + "styles", + "appId", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "name": { "type": "string" }, - "apiFilter": { - "type": "object", - "readOnly": true + "block": { + "type": "object" }, - "invalid": { - "type": "boolean", - "readOnly": true + "template": { + "type": "string" + }, + "styles": { + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -17120,60 +39651,88 @@ "format": "date-time", "readOnly": true }, - "filters": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" - } + "translated": { + "type": "object" }, - "boosting": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "AdvancedSearchEntityStreamFilterJsonApi": { + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "entityStreamId", - "type", - "createdAt" + "id", + "appId", + "name", + "url", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "type": { + "swIcon": { "type": "string" }, - "field": { + "url": { "type": "string" }, - "operator": { + "delayable": { + "type": "boolean" + }, + "label": { "type": "string" }, - "value": { + "description": { "type": "string" }, - "parameters": { - "type": "object" + "headline": { + "type": "string" }, - "position": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -17185,38 +39744,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "entityStream": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_entity_stream" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62acf68da615789a0175ef827f74acbb" - } - } - } - }, - "type": "object" - }, - "parent": { + "app": { "properties": { "links": { "type": "object", @@ -17224,7 +39757,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" } } }, @@ -17233,19 +39766,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "queries": { + "flowSequences": { "properties": { "links": { "type": "object", @@ -17253,7 +39786,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" } } }, @@ -17264,11 +39797,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "5da7eb4247add5dbd5776c9c0b38460a" + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } @@ -17284,43 +39817,74 @@ } ] }, - "AdvancedSearchEntityStreamFilter": { + "AppFlowAction": { + "description": "Added since version: 6.4.10.0", "required": [ - "entityStreamId", - "type", - "createdAt" + "id", + "appId", + "name", + "url", + "createdAt", + "label" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "readOnly": true }, - "type": { + "swIcon": { "type": "string" }, - "field": { + "url": { "type": "string" }, - "operator": { + "delayable": { + "type": "boolean" + }, + "label": { "type": "string" }, - "value": { + "description": { "type": "string" }, - "parameters": { - "type": "object" + "headline": { + "type": "string" }, - "position": { - "type": "integer", - "format": "int64" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -17332,29 +39896,33 @@ "format": "date-time", "readOnly": true }, - "entityStream": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "translated": { + "type": "object" }, - "parent": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "app": { + "$ref": "#/components/schemas/App" }, - "queries": { + "flowSequences": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "$ref": "#/components/schemas/FlowSequence" } } }, "type": "object" }, - "AdvancedSearchSynonymJsonApi": { + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "left", + "id", + "appId", + "name", + "aware", "createdAt" ], "properties": { @@ -17362,21 +39930,21 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "left": { - "type": "array", - "items": { - "type": "string" - } + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "right": { + "name": { + "type": "string" + }, + "aware": { "type": "array", "items": { "type": "string" } }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -17390,7 +39958,7 @@ }, "relationships": { "properties": { - "language": { + "app": { "properties": { "links": { "type": "object", @@ -17398,7 +39966,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language" + "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" } } }, @@ -17407,12 +39975,43 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "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" + } } } } @@ -17427,9 +40026,13 @@ } ] }, - "AdvancedSearchSynonym": { + "AppFlowEvent": { + "description": "Added since version: 6.5.2.0", "required": [ - "left", + "id", + "appId", + "name", + "aware", "createdAt" ], "properties": { @@ -17437,21 +40040,21 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "left": { - "type": "array", - "items": { - "type": "string" - } + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "right": { + "name": { + "type": "string" + }, + "aware": { "type": "array", "items": { "type": "string" } }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -17463,116 +40066,70 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "app": { + "$ref": "#/components/schemas/App" + }, + "flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } } }, "type": "object" }, - "AppJsonApi": { - "description": "Added since version: 6.3.1.0", + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", - "path", - "active", - "configurable", - "version", - "allowDisable", - "integrationId", - "aclRoleId", - "createdAt", - "label" + "id", + "appName", + "identifier", + "paymentMethodId", + "createdAt" ], - "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.", + "properties": { + "id": { "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } + "appName": { + "type": "string" }, - "allowDisable": { - "type": "boolean" + "identifier": { + "type": "string" }, - "baseAppUrl": { + "payUrl": { "type": "string" }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } + "finalizeUrl": { + "type": "string" }, - "templateLoadPriority": { - "type": "integer", - "format": "int64" + "validateUrl": { + "type": "string" }, - "label": { + "captureUrl": { "type": "string" }, - "description": { + "refundUrl": { "type": "string" }, - "privacyPolicyExtensions": { + "recurringUrl": { "type": "string" }, - "customFields": { - "type": "object" + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "integrationId": { + "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { + "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -17586,12 +40143,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "integration": { + "app": { "properties": { "links": { "type": "object", @@ -17599,7 +40153,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" } } }, @@ -17608,19 +40162,19 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "776ea3bf11df5829827f7afb43c37174" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "aclRole": { + "originalMedia": { "properties": { "links": { "type": "object", @@ -17628,7 +40182,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" } } }, @@ -17637,19 +40191,19 @@ "properties": { "type": { "type": "string", - "example": "acl_role" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "250aa1c64b973365fd6fd489eefbdefc" + "example": "56386c66f82d9cd5639a5a7447971ead" } } } }, "type": "object" }, - "customFieldSets": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -17657,92 +40211,165 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" + "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" } } }, "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": { "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": { + "example": "payment_method" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" - }, - "webhooks": { + } + }, + "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", @@ -17750,92 +40377,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/webhooks" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" } } }, "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": { "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": { + "example": "app" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "cmsBlocks": { + "ruleConditions": { "properties": { "links": { "type": "object", @@ -17843,7 +40406,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" } } }, @@ -17854,19 +40417,138 @@ "properties": { "type": { "type": "string", - "example": "app_cms_block" + "example": "rule_condition" }, "id": { "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" + "example": "24bfabce4195894c9aed9b8bcfb0b748" } } } } }, "type": "object" - }, - "flowActions": { + } + }, + "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", @@ -17874,30 +40556,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_action" - }, - "id": { - "type": "string", - "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "flowEvents": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -17905,30 +40585,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_flow_event" - }, - "id": { - "type": "string", - "example": "045e9ec14eafd26d17854fb4fe7c9cae" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "appShippingMethods": { + "originalMedia": { "properties": { "links": { "type": "object", @@ -17936,23 +40614,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/appShippingMethods" + "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_shipping_method" - }, - "id": { - "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "56386c66f82d9cd5639a5a7447971ead" } } } @@ -17967,105 +40643,35 @@ } ] }, - "App": { - "description": "Added since version: 6.3.1.0", + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", "required": [ - "name", - "path", - "active", - "configurable", - "version", - "allowDisable", - "integrationId", - "aclRoleId", - "createdAt", - "label" + "id", + "appName", + "identifier", + "shippingMethodId", + "createdAt" ], "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": { + "appName": { "type": "string" }, - "version": { + "identifier": { "type": "string" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "appId": { "type": "string", - "readOnly": true - }, - "modules": { - "type": "array", - "items": { - "type": "object" - } - }, - "mainModule": { - "type": "object" - }, - "cookies": { - "type": "array", - "items": { - "type": "object" - } - }, - "allowDisable": { - "type": "boolean" - }, - "baseAppUrl": { - "type": "string" - }, - "allowedHosts": { - "type": "array", - "items": { - "type": "string" - } - }, - "templateLoadPriority": { - "type": "integer", - "format": "int64" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privacyPolicyExtensions": { - "type": "string" - }, - "customFields": { - "type": "object" + "pattern": "^[0-9a-f]{32}$" }, - "integrationId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { + "originalMediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18079,79 +40685,19 @@ "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" - } + "app": { + "$ref": "#/components/schemas/App" }, - "flowEvents": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "originalMedia": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "AppActionButtonJsonApi": { + "AppTemplateJsonApi": { "description": "Added since version: 6.3.1.0", "allOf": [ { @@ -18159,33 +40705,26 @@ }, { "required": [ - "entity", - "view", - "url", - "action", + "id", + "template", + "path", + "active", "appId", - "createdAt", - "label" + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "type": "string" - }, - "view": { - "type": "string" - }, - "url": { + "template": { "type": "string" }, - "action": { + "path": { "type": "string" }, - "label": { - "type": "string" + "active": { + "type": "boolean" }, "appId": { "type": "string", @@ -18201,9 +40740,6 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { "app": { @@ -18214,7 +40750,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" } } }, @@ -18243,36 +40779,29 @@ } ] }, - "AppActionButton": { + "AppTemplate": { "description": "Added since version: 6.3.1.0", "required": [ - "entity", - "view", - "url", - "action", + "id", + "template", + "path", + "active", "appId", - "createdAt", - "label" + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { - "type": "string" - }, - "view": { - "type": "string" - }, - "url": { + "template": { "type": "string" }, - "action": { + "path": { "type": "string" }, - "label": { - "type": "string" + "active": { + "type": "boolean" }, "appId": { "type": "string", @@ -18288,26 +40817,20 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "app": { "$ref": "#/components/schemas/App" } }, "type": "object" }, - "AppAdministrationSnippetJsonApi": { - "description": "Added since version: 6.4.15.0", + "B2bBusinessPartnerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "value", - "appId", - "localeId", + "id", "createdAt" ], "properties": { @@ -18315,14 +40838,180 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultRoleId": { + "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": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "defaultRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2944ea414640901d532eba5106eb706b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bBusinessPartner": { + "required": [ + "id", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultRoleId": { + "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 + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "defaultRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + }, + "type": "object" + }, + "B2bComponentsApprovalRuleJsonApi": { + "description": "Added since version: 6.6.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "priority", + "active", + "conditions", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "appId": { + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18335,18 +41024,112 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "relationships": { + "properties": { + "businessPartnerCustomer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + } + } + } + }, + "type": "object" + }, + "reviewerRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06ec286ee4d03afb4028caa32c0ef40b" + } + } + } + }, + "type": "object" + }, + "affectedRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "33237c6057eedd7b8c978f77270af3b1" + } + } + } + }, + "type": "object" + } + }, + "type": "object" } }, "type": "object" } ] }, - "AppAdministrationSnippet": { - "description": "Added since version: 6.4.15.0", + "B2bComponentsApprovalRule": { + "description": "Added since version: 6.6.0.0", "required": [ - "value", - "appId", - "localeId", + "id", + "name", + "priority", + "active", + "conditions", "createdAt" ], "properties": { @@ -18354,14 +41137,31 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "value": { + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "appId": { + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "affectedRoleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18374,45 +41174,56 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" + }, + "reviewerRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "affectedRole": { + "$ref": "#/components/schemas/B2bComponentsRole" } }, "type": "object" }, - "AppCmsBlockJsonApi": { - "description": "Added since version: 6.4.2.0", + "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { + "description": "Added since version: 6.6.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", - "block", - "template", - "styles", + "id", + "identifier", + "active", "appId", "createdAt", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "identifier": { + "type": "string" + }, "name": { "type": "string" }, - "block": { - "type": "object" + "active": { + "type": "boolean" }, - "template": { + "group": { "type": "string" }, - "styles": { + "script": { "type": "string" }, - "label": { - "type": "string" + "config": { + "type": "object" }, "appId": { "type": "string", @@ -18441,7 +41252,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" } } }, @@ -18470,36 +41281,38 @@ } ] }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", + "B2bComponentsApprovalRuleAppScriptCondition": { + "description": "Added since version: 6.6.3.0", "required": [ - "name", - "block", - "template", - "styles", + "id", + "identifier", + "active", "appId", "createdAt", - "label" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "identifier": { + "type": "string" + }, "name": { "type": "string" }, - "block": { - "type": "object" + "active": { + "type": "boolean" }, - "template": { + "group": { "type": "string" }, - "styles": { + "script": { "type": "string" }, - "label": { - "type": "string" + "config": { + "type": "object" }, "appId": { "type": "string", @@ -18524,76 +41337,214 @@ }, "type": "object" }, - "AppFlowActionJsonApi": { - "description": "Added since version: 6.4.10.0", + "B2bComponentsPendingOrderJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "appId", - "name", - "url", - "createdAt", - "label" + "id", + "billingAddressId", + "customerId", + "employeeId", + "stateId", + "currencyId", + "countryId", + "salesChannelId", + "shippingMethodId", + "paymentMethodId", + "languageId", + "number", + "cartPayload", + "itemRounding", + "totalRounding", + "lineItemCount", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "badge": { - "type": "string" + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "parameters": { - "type": "object" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "headers": { - "type": "object" + "decidedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "requirements": { - "type": "array", - "items": { - "type": "string" - } + "approvalRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iconRaw": { - "type": "string" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "currencyId": { "type": "string", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "swIcon": { - "type": "string" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "url": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "delayable": { - "type": "boolean" + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "label": { + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "number": { "type": "string" }, - "description": { + "cartPayload": { "type": "string" }, - "headline": { + "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" + }, + "originalPrice": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reason": { "type": "string" }, + "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" + }, + "lineItemCount": { + "type": "integer", + "format": "int64" + }, + "designatedPayerIds": { + "type": "array", + "items": { + "type": "string" + } + }, "customFields": { "type": "object" }, @@ -18607,12 +41558,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "order": { "properties": { "links": { "type": "object", @@ -18620,7 +41568,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/order" } } }, @@ -18629,19 +41577,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "flowSequences": { + "billingAddress": { "properties": { "links": { "type": "object", @@ -18649,177 +41597,57 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/billingAddress" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", - "required": [ - "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": [ - "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": { + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "employee": { "properties": { "links": { "type": "object", @@ -18827,7 +41655,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/employee" } } }, @@ -18836,19 +41664,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" }, - "flows": { + "decidedBy": { "properties": { "links": { "type": "object", @@ -18856,155 +41684,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/decidedBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b293e6616bcffea8e393a4066a4a4230" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", - "required": [ - "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": [ - "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": { + }, + "approvalRule": { "properties": { "links": { "type": "object", @@ -19012,7 +41713,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/app" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/approvalRule" } } }, @@ -19021,19 +41722,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "b2b_components_approval_rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "2beeb3d6f9f7be5fb67d4cd9d9f9ba25" } } } }, "type": "object" }, - "originalMedia": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -19041,7 +41742,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/originalMedia" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/stateMachineState" } } }, @@ -19050,12 +41751,128 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/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": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/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": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -19070,7 +41887,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-payment-method/84f7c932de07ae9a57398d64828a7eae/paymentMethod" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/paymentMethod" } } }, @@ -19090,6 +41907,66 @@ } }, "type": "object" + }, + "shippingMethod": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/shippingMethod" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + } + } + } + }, + "type": "object" + }, + "addresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -19099,12 +41976,25 @@ } ] }, - "AppPaymentMethod": { - "description": "Added since version: 6.4.1.0", + "B2bComponentsPendingOrder": { + "description": "Added since version: 6.6.0.0", "required": [ - "appName", - "identifier", + "id", + "billingAddressId", + "customerId", + "employeeId", + "stateId", + "currencyId", + "countryId", + "salesChannelId", + "shippingMethodId", "paymentMethodId", + "languageId", + "number", + "cartPayload", + "itemRounding", + "totalRounding", + "lineItemCount", "createdAt" ], "properties": { @@ -19112,41 +42002,185 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "type": "string" + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "identifier": { - "type": "string" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "payUrl": { - "type": "string" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "finalizeUrl": { - "type": "string" + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "validateUrl": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "captureUrl": { + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "decidedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "approvalRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "number": { "type": "string" }, - "refundUrl": { + "cartPayload": { "type": "string" }, - "recurringUrl": { + "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" + }, + "originalPrice": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reason": { "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "lineItemCount": { + "type": "integer", + "format": "int64" }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "designatedPayerIds": { + "type": "array", + "items": { + "type": "string" + } }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -19158,58 +42192,130 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "order": { + "$ref": "#/components/schemas/Order" }, - "originalMedia": { - "$ref": "#/components/schemas/Media" + "billingAddress": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "decidedBy": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "approvalRule": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } } }, "type": "object" }, - "AppScriptConditionJsonApi": { - "description": "Added since version: 6.4.10.3", + "B2bComponentsPendingOrderAddressJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "identifier", - "active", - "appId", - "createdAt", - "name" + "id", + "countryId", + "pendingOrderId", + "firstName", + "lastName", + "street", + "city", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pendingOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "name": { + "lastName": { "type": "string" }, - "active": { - "type": "boolean" + "street": { + "type": "string" }, - "group": { + "zipcode": { "type": "string" }, - "script": { + "city": { "type": "string" }, - "config": { - "type": "object" + "company": { + "type": "string" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "department": { + "type": "string" + }, + "title": { + "type": "string" + }, + "vatId": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "additionalAddressLine1": { + "type": "string" + }, + "additionalAddressLine2": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -19221,12 +42327,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "app": { + "country": { "properties": { "links": { "type": "object", @@ -19234,7 +42337,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/country" } } }, @@ -19243,167 +42346,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "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": [ - "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": [ - "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": { + "countryState": { "properties": { "links": { "type": "object", @@ -19411,7 +42366,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/countryState" } } }, @@ -19420,19 +42375,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, - "shippingMethod": { + "pendingOrder": { "properties": { "links": { "type": "object", @@ -19440,7 +42395,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/pendingOrder" } } }, @@ -19449,19 +42404,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "b2b_components_pending_order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "1fd94955ea55110a2cf95eeb6fb1679f" } } } }, "type": "object" }, - "originalMedia": { + "salutation": { "properties": { "links": { "type": "object", @@ -19469,7 +42424,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/salutation" } } }, @@ -19478,12 +42433,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -19498,12 +42453,16 @@ } ] }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", + "B2bComponentsPendingOrderAddress": { + "description": "Added since version: 6.6.0.0", "required": [ - "appName", - "identifier", - "shippingMethodId", + "id", + "countryId", + "pendingOrderId", + "firstName", + "lastName", + "street", + "city", "createdAt" ], "properties": { @@ -19511,24 +42470,61 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "countryStateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "pendingOrderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalMediaId": { + "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", @@ -19539,30 +42535,30 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "country": { + "$ref": "#/components/schemas/Country" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "originalMedia": { - "$ref": "#/components/schemas/Media" + "pendingOrder": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", + "B2bComponentsRoleJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "template", - "path", - "active", - "appId", + "id", + "name", "createdAt" ], "properties": { @@ -19570,18 +42566,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { - "type": "string" + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "path": { + "name": { "type": "string" }, - "active": { - "type": "boolean" + "permissions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -19595,7 +42595,7 @@ }, "relationships": { "properties": { - "app": { + "employees": { "properties": { "links": { "type": "object", @@ -19603,7 +42603,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + } + } + } + } + }, + "type": "object" + }, + "businessPartnerCustomer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" } } }, @@ -19612,12 +42643,12 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } @@ -19632,13 +42663,10 @@ } ] }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", + "B2bComponentsRole": { "required": [ - "template", - "path", - "active", - "appId", + "id", + "name", "createdAt" ], "properties": { @@ -19646,18 +42674,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "template": { - "type": "string" + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "path": { + "name": { "type": "string" }, - "active": { - "type": "boolean" + "permissions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -19669,19 +42701,29 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "employees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "B2bBusinessPartnerJsonApi": { + "B2bComponentsShoppingListJsonApi": { + "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", + "salesChannelId", + "customerId", "createdAt" ], "properties": { @@ -19689,17 +42731,38 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultRoleId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, + "price": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -19712,6 +42775,93 @@ }, "relationships": { "properties": { + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/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": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, "customer": { "properties": { "links": { @@ -19720,7 +42870,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" } } }, @@ -19741,7 +42891,7 @@ }, "type": "object" }, - "defaultRole": { + "employee": { "properties": { "links": { "type": "object", @@ -19749,7 +42899,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" } } }, @@ -19758,12 +42908,43 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2944ea414640901d532eba5106eb706b" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + } + } + } + }, + "type": "object" + }, + "lineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } } } } @@ -19778,8 +42959,12 @@ } ] }, - "B2bBusinessPartner": { + "B2bComponentsShoppingList": { + "description": "Added since version: 6.6.2.0", "required": [ + "id", + "salesChannelId", + "customerId", "createdAt" ], "properties": { @@ -19787,17 +42972,38 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultRoleId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, + "price": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -19808,23 +43014,40 @@ "format": "date-time", "readOnly": true }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, "customer": { "$ref": "#/components/schemas/Customer" }, - "defaultRole": { - "$ref": "#/components/schemas/B2bComponentsRole" + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } } }, "type": "object" }, - "B2bComponentsRoleJsonApi": { + "B2bComponentsShoppingListLineItemJsonApi": { + "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", + "id", + "quantity", "createdAt" ], "properties": { @@ -19832,19 +43055,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "shoppingListId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "permissions": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "quantity": { + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -19861,7 +43089,7 @@ }, "relationships": { "properties": { - "employees": { + "shoppingList": { "properties": { "links": { "type": "object", @@ -19869,30 +43097,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" + "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/shoppingList" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "75cf6f56c85d6cbfe36939709500418b" } } } }, "type": "object" }, - "businessPartnerCustomer": { + "product": { "properties": { "links": { "type": "object", @@ -19900,7 +43126,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" + "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/product" } } }, @@ -19909,12 +43135,12 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -19929,9 +43155,11 @@ } ] }, - "B2bComponentsRole": { + "B2bComponentsShoppingListLineItem": { + "description": "Added since version: 6.6.2.0", "required": [ - "name", + "id", + "quantity", "createdAt" ], "properties": { @@ -19939,19 +43167,24 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "shoppingListId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "permissions": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "quantity": { + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -19966,14 +43199,11 @@ "format": "date-time", "readOnly": true }, - "employees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bEmployee" - } + "shoppingList": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" @@ -19985,6 +43215,7 @@ }, { "required": [ + "id", "languageId", "firstName", "lastName", @@ -20172,6 +43403,7 @@ }, "B2bEmployee": { "required": [ + "id", "languageId", "firstName", "lastName", @@ -20279,6 +43511,7 @@ }, { "required": [ + "id", "orderId", "firstName", "lastName", @@ -20392,6 +43625,7 @@ }, "B2bOrderEmployee": { "required": [ + "id", "orderId", "firstName", "lastName", @@ -20451,6 +43685,7 @@ }, { "required": [ + "id", "name", "group", "createdAt" @@ -20489,6 +43724,7 @@ }, "B2bPermission": { "required": [ + "id", "name", "group", "createdAt" @@ -20531,6 +43767,7 @@ }, { "required": [ + "id", "displayNestedProducts", "type", "productAssignmentType", @@ -20680,6 +43917,14 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "search": { + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "parent": { @@ -21088,6 +44333,7 @@ "Category": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "displayNestedProducts", "type", "productAssignmentType", @@ -21237,6 +44483,14 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "search": { + "type": "object" + } + }, + "type": "object" + }, "parent": { "$ref": "#/components/schemas/Category" }, @@ -21346,6 +44600,7 @@ }, { "required": [ + "id", "position", "type", "sectionId", @@ -21538,6 +44793,7 @@ "CmsBlock": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "position", "type", "sectionId", @@ -21651,6 +44907,7 @@ }, { "required": [ + "id", "type", "createdAt" ], @@ -21903,6 +45160,7 @@ "CmsPage": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "createdAt" ], @@ -22002,6 +45260,7 @@ }, { "required": [ + "id", "position", "type", "pageId", @@ -22185,6 +45444,7 @@ "CmsSection": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "position", "type", "pageId", @@ -22289,6 +45549,7 @@ }, { "required": [ + "id", "type", "slot", "blockId", @@ -22388,6 +45649,7 @@ "CmsSlot": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "type", "slot", "blockId", @@ -22459,6 +45721,8 @@ }, { "required": [ + "id", + "isEu", "createdAt", "name", "addressFormat" @@ -22563,6 +45827,9 @@ "defaultPostalCodePattern": { "type": "string" }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -22842,6 +46109,8 @@ "Country": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "isEu", "createdAt", "name", "addressFormat" @@ -22946,6 +46215,9 @@ "defaultPostalCodePattern": { "type": "string" }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -23048,6 +46320,7 @@ }, { "required": [ + "id", "countryId", "shortCode", "createdAt", @@ -23231,6 +46504,7 @@ "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "countryId", "shortCode", "createdAt", @@ -23336,6 +46610,7 @@ }, { "required": [ + "id", "factor", "symbol", "isoCode", @@ -23382,6 +46657,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -23398,6 +46678,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -23723,6 +47008,7 @@ "Currency": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "factor", "symbol", "isoCode", @@ -23769,6 +47055,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -23785,6 +47076,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -23933,6 +47229,7 @@ }, { "required": [ + "id", "currencyId", "countryId", "itemRounding", @@ -23953,6 +47250,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -23969,6 +47271,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -24065,6 +47372,7 @@ "CurrencyCountryRounding": { "description": "Added since version: 6.4.0.0", "required": [ + "id", "currencyId", "countryId", "itemRounding", @@ -24085,6 +47393,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -24101,6 +47414,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -24143,6 +47461,7 @@ }, { "required": [ + "id", "name", "fields", "createdAt" @@ -24205,6 +47524,7 @@ "CustomEntity": { "description": "Added since version: 6.4.9.0", "required": [ + "id", "name", "fields", "createdAt" @@ -24270,6 +47590,7 @@ }, { "required": [ + "id", "name", "type", "createdAt" @@ -24384,6 +47705,7 @@ "CustomField": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "type", "createdAt" @@ -24445,6 +47767,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -24618,6 +47941,7 @@ "CustomFieldSet": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "createdAt" ], @@ -24688,6 +48012,7 @@ }, { "required": [ + "id", "customFieldSetId", "entityName", "createdAt" @@ -24756,6 +48081,7 @@ "CustomFieldSetRelation": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "customFieldSetId", "entityName", "createdAt" @@ -24795,6 +48121,7 @@ }, { "required": [ + "id", "productId", "price", "createdAt" @@ -24932,6 +48259,7 @@ }, "CustomPrice": { "required": [ + "id", "productId", "price", "createdAt" @@ -24990,8 +48318,8 @@ }, { "required": [ + "id", "groupId", - "defaultPaymentMethodId", "salesChannelId", "languageId", "defaultBillingAddressId", @@ -25001,6 +48329,7 @@ "lastName", "email", "accountType", + "defaultPaymentMethodId", "createdAt" ], "properties": { @@ -25012,10 +48341,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -25159,6 +48484,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -25384,6 +48713,37 @@ }, "type": "object" }, + "ssoProviderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" + } + } + } + } + }, + "type": "object" + }, "quotes": { "properties": { "links": { @@ -25480,35 +48840,6 @@ }, "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" - }, "salesChannel": { "properties": { "links": { @@ -26013,6 +49344,35 @@ } }, "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" @@ -26025,8 +49385,8 @@ "Customer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "groupId", - "defaultPaymentMethodId", "salesChannelId", "languageId", "defaultBillingAddressId", @@ -26036,6 +49396,7 @@ "lastName", "email", "accountType", + "defaultPaymentMethodId", "createdAt" ], "properties": { @@ -26047,10 +49408,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -26194,6 +49551,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "defaultPaymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -26419,6 +49780,37 @@ }, "type": "object" }, + "ssoProviderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" + } + } + } + } + }, + "type": "object" + }, "quotes": { "properties": { "links": { @@ -26487,9 +49879,6 @@ "group": { "$ref": "#/components/schemas/CustomerGroup" }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, @@ -26558,6 +49947,9 @@ }, "updatedBy": { "$ref": "#/components/schemas/User" + }, + "defaultPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" @@ -26570,6 +49962,7 @@ }, { "required": [ + "id", "customerId", "countryId", "firstName", @@ -26774,6 +50167,7 @@ "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "customerId", "countryId", "firstName", @@ -26872,6 +50266,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -27059,6 +50454,7 @@ "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -27203,6 +50599,7 @@ }, { "required": [ + "id", "hash", "customerId", "createdAt" @@ -27271,6 +50668,7 @@ "CustomerRecovery": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "hash", "customerId", "createdAt" @@ -27310,6 +50708,7 @@ }, { "required": [ + "id", "customerId", "features", "createdAt" @@ -27377,6 +50776,7 @@ }, "CustomerSpecificFeatures": { "required": [ + "id", "customerId", "features", "createdAt" @@ -27445,6 +50845,7 @@ }, { "required": [ + "id", "customerId", "salesChannelId", "createdAt" @@ -27577,6 +50978,7 @@ "CustomerWishlist": { "description": "Added since version: 6.3.4.0", "required": [ + "id", "customerId", "salesChannelId", "createdAt" @@ -27630,6 +51032,7 @@ }, { "required": [ + "id", "productId", "wishlistId", "createdAt" @@ -27732,6 +51135,7 @@ "CustomerWishlistProduct": { "description": "Added since version: 6.3.4.0", "required": [ + "id", "productId", "wishlistId", "createdAt" @@ -27780,6 +51184,7 @@ }, { "required": [ + "id", "name", "min", "max", @@ -27896,6 +51301,7 @@ "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "min", "max", @@ -27960,6 +51366,7 @@ }, { "required": [ + "id", "documentTypeId", "fileType", "orderId", @@ -28183,6 +51590,7 @@ "Document": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentTypeId", "fileType", "orderId", @@ -28275,6 +51683,7 @@ }, { "required": [ + "id", "documentTypeId", "name", "global", @@ -28426,6 +51835,7 @@ "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentTypeId", "name", "global", @@ -28498,6 +51908,7 @@ }, { "required": [ + "id", "documentBaseConfigId", "createdAt" ], @@ -28628,6 +52039,7 @@ "DocumentBaseConfigSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "documentBaseConfigId", "createdAt" ], @@ -28678,6 +52090,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -28709,6 +52122,42 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "documents": { @@ -28815,6 +52264,7 @@ "DocumentType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -28846,6 +52296,42 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "documents": { "type": "array", "items": { @@ -28875,6 +52361,7 @@ }, { "required": [ + "id", "name", "eventName", "createdAt" @@ -29030,6 +52517,7 @@ "Flow": { "description": "Added since version: 6.4.6.0", "required": [ + "id", "name", "eventName", "createdAt" @@ -29132,6 +52620,7 @@ }, { "required": [ + "id", "flowId", "createdAt" ], @@ -29413,6 +52902,7 @@ "FlowSequence": { "description": "Added since version: 6.4.6.0", "required": [ + "id", "flowId", "createdAt" ], @@ -29563,6 +53053,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -29595,6 +53086,7 @@ "FlowTemplate": { "description": "Added since version: 6.4.18.0", "required": [ + "id", "name", "createdAt" ], @@ -29630,6 +53122,7 @@ }, { "required": [ + "id", "originalName", "path", "expireDate", @@ -29709,6 +53202,7 @@ "ImportExportFile": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "originalName", "path", "expireDate", @@ -29760,6 +53254,7 @@ }, { "required": [ + "id", "activity", "state", "records", @@ -29977,6 +53472,7 @@ "ImportExportLog": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "activity", "state", "records", @@ -30062,6 +53558,7 @@ }, { "required": [ + "id", "label", "sourceEntity", "fileType", @@ -30074,9 +53571,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, "label": { "type": "string" }, @@ -30107,6 +53601,12 @@ "config": { "type": "object" }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -30164,6 +53664,7 @@ "ImportExportProfile": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "label", "sourceEntity", "fileType", @@ -30176,9 +53677,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, "label": { "type": "string" }, @@ -30209,6 +53707,12 @@ "config": { "type": "object" }, + "technicalName": { + "type": "string" + }, + "name": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -30239,6 +53743,7 @@ }, { "required": [ + "id", "label", "accessKey", "secretAccessKey", @@ -30272,10 +53777,6 @@ "type": "string", "format": "date-time" }, - "writeAccess": { - "type": "boolean", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -30395,6 +53896,7 @@ "Integration": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "label", "accessKey", "secretAccessKey", @@ -30428,10 +53930,6 @@ "type": "string", "format": "date-time" }, - "writeAccess": { - "type": "boolean", - "deprecated": true - }, "createdAt": { "type": "string", "format": "date-time", @@ -30526,6 +54024,7 @@ }, { "required": [ + "id", "createdAt", "name", "url" @@ -30719,6 +54218,7 @@ "LandingPage": { "description": "Added since version: 6.4.0.0", "required": [ + "id", "createdAt", "name", "url" @@ -30873,6 +54373,7 @@ }, { "required": [ + "id", "localeId", "name", "createdAt" @@ -31447,6 +54948,7 @@ "Language": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "localeId", "name", "createdAt" @@ -31665,6 +55167,7 @@ }, { "required": [ + "id", "code", "createdAt", "name", @@ -31775,6 +55278,7 @@ "Locale": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "code", "createdAt", "name", @@ -31833,6 +55337,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -31874,6 +55379,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -31918,6 +55424,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -32004,6 +55511,7 @@ "MailHeaderFooter": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -32063,6 +55571,7 @@ }, { "required": [ + "id", "mailTemplateTypeId", "createdAt", "subject", @@ -32185,6 +55694,7 @@ "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "mailTemplateTypeId", "createdAt", "subject", @@ -32249,6 +55759,7 @@ "MailTemplateMedia": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "mailTemplateId", "languageId", "mediaId" @@ -32291,6 +55802,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -32372,6 +55884,7 @@ "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -32426,6 +55939,7 @@ }, { "required": [ + "id", "productId", "categoryId", "salesChannelId", @@ -32566,6 +56080,7 @@ "MainCategory": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "productId", "categoryId", "salesChannelId", @@ -32626,6 +56141,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -32671,6 +56187,9 @@ "type": "object", "readOnly": true }, + "config": { + "type": "object" + }, "alt": { "type": "string" }, @@ -32799,6 +56318,99 @@ } }, "type": "object" + }, + "ssoProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "example": "520b66891556bf9309da72937c4f1f98" + } + } + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + }, + "spatialObjects": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -33525,6 +57137,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -33570,6 +57183,9 @@ "type": "object", "readOnly": true }, + "config": { + "type": "object" + }, "alt": { "type": "string" }, @@ -33698,6 +57314,99 @@ } }, "type": "object" + }, + "ssoProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "example": "520b66891556bf9309da72937c4f1f98" + } + } + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + }, + "spatialObjects": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -33844,6 +57553,7 @@ }, { "required": [ + "id", "mediaId", "createdAt" ], @@ -33921,6 +57631,7 @@ }, "MediaAiTag": { "required": [ + "id", "mediaId", "createdAt" ], @@ -33971,8 +57682,8 @@ }, { "required": [ + "id", "entity", - "associationFields", "createdAt" ], "properties": { @@ -33986,12 +57697,6 @@ "customFields": { "type": "object" }, - "associationFields": { - "type": "array", - "items": { - "type": "string" - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -34044,8 +57749,8 @@ "MediaDefaultFolder": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "entity", - "associationFields", "createdAt" ], "properties": { @@ -34059,12 +57764,6 @@ "customFields": { "type": "object" }, - "associationFields": { - "type": "array", - "items": { - "type": "string" - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -34089,6 +57788,7 @@ }, { "required": [ + "id", "configurationId", "name", "createdAt" @@ -34300,6 +58000,7 @@ "MediaFolder": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "configurationId", "name", "createdAt" @@ -34381,6 +58082,7 @@ }, { "required": [ + "id", "createdAt" ], "properties": { @@ -34492,6 +58194,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt" ], "properties": { @@ -34607,6 +58310,7 @@ }, { "required": [ + "id", "mediaId", "width", "height", @@ -34693,6 +58397,7 @@ "MediaThumbnail": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "mediaId", "width", "height", @@ -34751,6 +58456,7 @@ }, { "required": [ + "id", "width", "height", "createdAt" @@ -34825,6 +58531,7 @@ "MediaThumbnailSize": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "width", "height", "createdAt" @@ -34872,6 +58579,7 @@ }, { "required": [ + "id", "email", "status", "hash", @@ -35071,6 +58779,7 @@ "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "email", "status", "hash", @@ -35193,6 +58902,7 @@ }, { "required": [ + "id", "status", "message", "createdAt" @@ -35307,6 +59017,7 @@ "Notification": { "description": "Added since version: 6.4.7.0", "required": [ + "id", "status", "message", "createdAt" @@ -35367,6 +59078,7 @@ }, { "required": [ + "id", "typeId", "global", "pattern", @@ -35517,6 +59229,7 @@ "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "typeId", "global", "pattern", @@ -35588,6 +59301,7 @@ }, { "required": [ + "id", "numberRangeId", "salesChannelId", "createdAt" @@ -35719,6 +59433,7 @@ "NumberRangeSalesChannel": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "numberRangeId", "salesChannelId", "createdAt" @@ -35770,6 +59485,7 @@ }, { "required": [ + "id", "numberRangeId", "lastValue", "createdAt" @@ -35839,6 +59555,7 @@ "NumberRangeState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "numberRangeId", "lastValue", "createdAt" @@ -35880,6 +59597,7 @@ }, { "required": [ + "id", "global", "createdAt", "typeName" @@ -35989,6 +59707,7 @@ "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "global", "createdAt", "typeName" @@ -36046,6 +59765,7 @@ }, { "required": [ + "id", "billingAddressId", "currencyId", "languageId", @@ -36261,6 +59981,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -36277,6 +60002,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -36487,6 +60217,37 @@ } }, "type": "object" + }, + "b2bPendingOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c7e0572188e2dec59215e8872024567e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -36922,6 +60683,7 @@ "Order": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "billingAddressId", "currencyId", "languageId", @@ -37137,6 +60899,11 @@ "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -37153,6 +60920,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -37363,6 +61135,37 @@ } }, "type": "object" + }, + "b2bPendingOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c7e0572188e2dec59215e8872024567e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -37438,6 +61241,7 @@ }, { "required": [ + "id", "countryId", "orderId", "firstName", @@ -37684,6 +61488,7 @@ "OrderAddress": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "countryId", "orderId", "firstName", @@ -37799,6 +61604,7 @@ }, { "required": [ + "id", "orderId", "email", "firstName", @@ -37970,6 +61776,7 @@ "OrderCustomer": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "email", "firstName", @@ -38061,6 +61868,7 @@ }, { "required": [ + "id", "orderId", "shippingOrderAddressId", "shippingMethodId", @@ -38347,6 +62155,7 @@ "OrderDelivery": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "shippingOrderAddressId", "shippingMethodId", @@ -38502,6 +62311,7 @@ }, { "required": [ + "id", "orderDeliveryId", "orderLineItemId", "createdAt" @@ -38684,6 +62494,7 @@ "OrderDeliveryPosition": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderDeliveryId", "orderLineItemId", "createdAt" @@ -38812,6 +62623,7 @@ }, { "required": [ + "id", "orderId", "identifier", "quantity", @@ -38849,8 +62661,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -39333,6 +63144,7 @@ "OrderLineItem": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "identifier", "quantity", @@ -39370,8 +63182,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -39622,6 +63433,7 @@ }, { "required": [ + "id", "orderLineItemId", "mediaId", "position", @@ -39740,6 +63552,7 @@ "OrderLineItemDownload": { "description": "Added since version: 6.4.19.0", "required": [ + "id", "orderLineItemId", "mediaId", "position", @@ -39803,6 +63616,7 @@ }, { "required": [ + "id", "orderId", "productId", "warehouseId", @@ -39952,6 +63766,7 @@ }, "OrderProductWarehouse": { "required": [ + "id", "orderId", "productId", "warehouseId", @@ -40022,6 +63837,7 @@ }, { "required": [ + "id", "orderId", "stateId", "returnNumber", @@ -40338,6 +64154,7 @@ }, "OrderReturn": { "required": [ + "id", "orderId", "stateId", "returnNumber", @@ -40523,6 +64340,7 @@ }, { "required": [ + "id", "orderReturnId", "orderLineItemId", "reasonId", @@ -40777,6 +64595,7 @@ }, "OrderReturnLineItem": { "required": [ + "id", "orderReturnId", "orderLineItemId", "reasonId", @@ -40925,6 +64744,7 @@ }, { "required": [ + "id", "reasonKey", "createdAt", "content" @@ -40996,6 +64816,7 @@ }, "OrderReturnLineItemReason": { "required": [ + "id", "reasonKey", "createdAt", "content" @@ -41073,6 +64894,7 @@ }, { "required": [ + "id", "orderId", "paymentMethodId", "amount", @@ -41157,6 +64979,9 @@ }, "type": "object" }, + "validationData": { + "type": "object" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -41305,6 +65130,7 @@ "OrderTransaction": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "orderId", "paymentMethodId", "amount", @@ -41389,6 +65215,9 @@ }, "type": "object" }, + "validationData": { + "type": "object" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -41432,6 +65261,7 @@ }, { "required": [ + "id", "orderTransactionId", "stateId", "amount", @@ -41633,6 +65463,7 @@ "OrderTransactionCapture": { "description": "Added since version: 6.4.12.0", "required": [ + "id", "orderTransactionId", "stateId", "amount", @@ -41755,6 +65586,7 @@ }, { "required": [ + "id", "captureId", "stateId", "amount", @@ -41959,6 +65791,7 @@ "OrderTransactionCaptureRefund": { "description": "Added since version: 6.4.12.0", "required": [ + "id", "captureId", "stateId", "amount", @@ -42084,6 +65917,7 @@ }, { "required": [ + "id", "refundId", "orderLineItemId", "amount", @@ -42265,6 +66099,7 @@ "OrderTransactionCaptureRefundPosition": { "description": "Added since version: 6.4.12.0", "required": [ + "id", "refundId", "orderLineItemId", "amount", @@ -42391,6 +66226,7 @@ }, { "required": [ + "id", "orderId", "warehouseGroupId", "createdAt" @@ -42496,6 +66332,7 @@ }, "OrderWarehouseGroup": { "required": [ + "id", "orderId", "warehouseGroupId", "createdAt" @@ -42548,6 +66385,7 @@ }, { "required": [ + "id", "createdAt", "name" ], @@ -42964,6 +66802,7 @@ "PaymentMethod": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "name" ], @@ -43174,6 +67013,7 @@ }, { "required": [ + "id", "baseClass", "name", "autoload", @@ -43247,9 +67087,6 @@ "supportLink": { "type": "string" }, - "changelog": { - "type": "object" - }, "customFields": { "type": "object" }, @@ -43310,6 +67147,7 @@ "Plugin": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "baseClass", "name", "autoload", @@ -43383,9 +67221,6 @@ "supportLink": { "type": "string" }, - "changelog": { - "type": "object" - }, "customFields": { "type": "object" }, @@ -43419,6 +67254,7 @@ }, { "required": [ + "id", "taxId", "price", "productNumber", @@ -43479,6 +67315,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "cmsPageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -43512,6 +67352,15 @@ "isCloseout": { "type": "boolean" }, + "availableStock": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stock": { + "type": "integer", + "format": "int64" + }, "variation": { "type": "array", "items": { @@ -43690,14 +67539,6 @@ "additionalProperties": false } }, - "availableStock": { - "type": "integer", - "format": "int64" - }, - "stock": { - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -43713,7 +67554,263 @@ }, "extensions": { "properties": { - "customPrice": { + "customPrice": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/customPrice" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" + }, + "subscriptionPlans": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } + } + }, + "type": "object" + }, + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } + } + }, + "type": "object" + }, + "warehouses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_warehouse" + }, + "id": { + "type": "string", + "example": "544959798565126142ca2820b4f56271" + } + } + } + } + }, + "type": "object" + }, + "orderWarehouses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "5331369e2f71d048521bd35d80975314" + } + } + } + } + }, + "type": "object" + }, + "reviewSummaries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "c9c718522e64ffa5effb26cef94f4849" + } + } + } + } + }, + "type": "object" + }, + "search": { + "type": "object" + }, + "quoteLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } + } + } + } + }, + "type": "object" + }, + "shoppingListLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "ce593c6d1db236f22dc387a2ee20dfd6" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "downloads": { "properties": { "links": { "type": "object", @@ -43721,7 +67818,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" + "example": "/product/deb10517653c255364175796ace3553f/downloads" } } }, @@ -43732,11 +67829,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "product_download" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "d07d50a751bc6ddf12bf3af0efee9b45" } } } @@ -43744,7 +67841,7 @@ }, "type": "object" }, - "subscriptionPlans": { + "parent": { "properties": { "links": { "type": "object", @@ -43752,7 +67849,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + "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" } } }, @@ -43763,11 +67889,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_plan" + "example": "product" }, "id": { "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" + "example": "268184c12df027f536154d099d497b31" } } } @@ -43775,7 +67901,7 @@ }, "type": "object" }, - "warehouseGroups": { + "deliveryTime": { "properties": { "links": { "type": "object", @@ -43783,7 +67909,239 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "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" } } }, @@ -43794,11 +68152,11 @@ "properties": { "type": { "type": "string", - "example": "warehouse_group" + "example": "product_price" }, "id": { "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + "example": "afae32efe0f84fece3f96b377b768b33" } } } @@ -43806,7 +68164,7 @@ }, "type": "object" }, - "warehouses": { + "media": { "properties": { "links": { "type": "object", @@ -43814,7 +68172,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "example": "/product/deb10517653c255364175796ace3553f/media" } } }, @@ -43825,11 +68183,11 @@ "properties": { "type": { "type": "string", - "example": "product_warehouse" + "example": "product_media" }, "id": { "type": "string", - "example": "544959798565126142ca2820b4f56271" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -43837,7 +68195,7 @@ }, "type": "object" }, - "orderWarehouses": { + "crossSellings": { "properties": { "links": { "type": "object", @@ -43845,7 +68203,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" + "example": "/product/deb10517653c255364175796ace3553f/crossSellings" } } }, @@ -43856,11 +68214,11 @@ "properties": { "type": { "type": "string", - "example": "order_product_warehouse" + "example": "product_cross_selling" }, "id": { "type": "string", - "example": "5331369e2f71d048521bd35d80975314" + "example": "89936e14544d1b403cecef938101b6b0" } } } @@ -43868,7 +68226,7 @@ }, "type": "object" }, - "reviewSummaries": { + "crossSellingAssignedProducts": { "properties": { "links": { "type": "object", @@ -43876,7 +68234,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" + "example": "/product/deb10517653c255364175796ace3553f/crossSellingAssignedProducts" } } }, @@ -43887,11 +68245,11 @@ "properties": { "type": { "type": "string", - "example": "product_review_summary" + "example": "product_cross_selling_assigned_products" }, "id": { "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" + "example": "5ee26b69e515f51ece26912961283b6d" } } } @@ -43899,7 +68257,7 @@ }, "type": "object" }, - "quoteLineItems": { + "configuratorSettings": { "properties": { "links": { "type": "object", @@ -43907,7 +68265,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" + "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" } } }, @@ -43918,24 +68276,19 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "product_configurator_setting" }, "id": { "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" + "example": "c0827fee13725d41f1fd7e292243f5aa" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "downloads": { + }, + "visibilities": { "properties": { "links": { "type": "object", @@ -43943,7 +68296,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/downloads" + "example": "/product/deb10517653c255364175796ace3553f/visibilities" } } }, @@ -43954,11 +68307,11 @@ "properties": { "type": { "type": "string", - "example": "product_download" + "example": "product_visibility" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "63226fcdfe3316ec1237ef07a8fe6732" } } } @@ -43966,7 +68319,7 @@ }, "type": "object" }, - "parent": { + "searchKeywords": { "properties": { "links": { "type": "object", @@ -43974,28 +68327,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/parent" + "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_keyword" + }, + "id": { + "type": "string", + "example": "effbcffaacb8111b531f15e6f4c796d1" + } } } } }, "type": "object" }, - "children": { + "productReviews": { "properties": { "links": { "type": "object", @@ -44003,7 +68358,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/children" + "example": "/product/deb10517653c255364175796ace3553f/productReviews" } } }, @@ -44014,11 +68369,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_review" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "01e78541ea343ed72424a5222796a4cd" } } } @@ -44026,7 +68381,7 @@ }, "type": "object" }, - "deliveryTime": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -44034,28 +68389,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" + "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": { - "type": { - "type": "string", - "example": "delivery_time" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8c888ae25a7bd42057370e31f7e01044" + "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" }, - "tax": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -44063,28 +68451,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tax" + "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": { - "type": { - "type": "string", - "example": "tax" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" + "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" }, - "manufacturer": { + "options": { "properties": { "links": { "type": "object", @@ -44092,28 +68513,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/manufacturer" + "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": { - "type": { - "type": "string", - "example": "product_manufacturer" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c2904bca62b22443d6cf5e9d89cab204" + "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" }, - "unit": { + "categories": { "properties": { "links": { "type": "object", @@ -44121,28 +68575,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/unit" + "example": "/product/deb10517653c255364175796ace3553f/categories" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "unit" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3e34bdebd9bd5edda27e8728904a2552" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } } } } }, "type": "object" }, - "cover": { + "streams": { "properties": { "links": { "type": "object", @@ -44150,28 +68606,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cover" + "example": "/product/deb10517653c255364175796ace3553f/streams" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "example": "2f6f4768f1c2d7c8f1f54823723f1a70" + } } } } }, "type": "object" }, - "featureSet": { + "categoriesRo": { "properties": { "links": { "type": "object", @@ -44179,28 +68637,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/featureSet" + "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_feature_set" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "7f0702d3a90d965b8c9158c451f43fdb" + } } } } }, "type": "object" }, - "cmsPage": { + "tags": { "properties": { "links": { "type": "object", @@ -44208,28 +68668,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + "example": "/product/deb10517653c255364175796ace3553f/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_page" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "canonicalProduct": { + "customFieldSets": { "properties": { "links": { "type": "object", @@ -44237,338 +68699,883 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "023995a50b56c0de077323e958b2bbcd" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } } } } - }, - "type": "object" + }, + "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" + }, + "extensions": { + "properties": { + "customPrice": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/customPrice" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" + }, + "subscriptionPlans": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } + } + }, + "type": "object" + }, + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + } + } }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" } } - }, - "type": "object" - }, - "media": { + } + } + }, + "type": "object" + }, + "warehouses": { + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouses" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_warehouse" + }, + "id": { + "type": "string", + "example": "544959798565126142ca2820b4f56271" } } - }, - "type": "object" - }, - "crossSellingAssignedProducts": { + } + } + }, + "type": "object" + }, + "orderWarehouses": { + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "5331369e2f71d048521bd35d80975314" } } - }, - "type": "object" - }, - "visibilities": { + } + } + }, + "type": "object" + }, + "reviewSummaries": { + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "c9c718522e64ffa5effb26cef94f4849" } } - }, - "type": "object" - }, - "productReviews": { + } + } + }, + "type": "object" + }, + "search": { + "type": "object" + }, + "quoteLineItems": { + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } - }, - "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" - } - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" } } - }, - "type": "object" - }, - "seoUrls": { + } + } + }, + "type": "object" + }, + "shoppingListLineItems": { + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } - }, - "type": "object" + } }, - "orderLineItems": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "ce593c6d1db236f22dc387a2ee20dfd6" + } + } + } + } + }, + "type": "object" + } + }, + "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", @@ -44576,92 +69583,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/product" } } }, "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": { "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": { + "example": "product" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "properties": { + "media": { "properties": { "links": { "type": "object", @@ -44669,92 +69612,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/properties" + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/media" } } }, "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": { "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": { + "example": "media" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "categoriesRo": { + "option": { "properties": { "links": { "type": "object", @@ -44762,85 +69641,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" + "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/option" } } }, "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": { "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": { + "example": "property_group_option" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "ef3e30e070f70244fd6578d88a6b77ac" } } } @@ -44855,15 +69670,13 @@ } ] }, - "Product": { + "ProductConfiguratorSetting": { "description": "Added since version: 6.0.0.0", "required": [ - "taxId", - "price", - "productNumber", - "stock", - "createdAt", - "name" + "id", + "productId", + "optionId", + "createdAt" ], "properties": { "id": { @@ -44874,269 +69687,32 @@ "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": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "canonicalProductId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "optionId": { "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" - }, - "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": { + "position": { "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 - } - }, - "availableStock": { - "type": "integer", - "format": "int64" - }, - "stock": { - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -45147,398 +69723,591 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "product": { + "$ref": "#/components/schemas/Product" }, - "extensions": { + "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": { - "customPrice": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } - } - } - } - }, - "type": "object" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "subscriptionPlans": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_plan" - }, - "id": { - "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" - } - } - } - } - }, - "type": "object" + "name": { + "type": "string" }, - "warehouseGroups": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" - } - } - } - } - }, - "type": "object" + "position": { + "type": "integer", + "format": "int64" }, - "warehouses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" - } - } - } - } - }, - "type": "object" + "sortBy": { + "type": "string" }, - "orderWarehouses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_product_warehouse" - }, - "id": { - "type": "string", - "example": "5331369e2f71d048521bd35d80975314" - } - } - } - } - }, + "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" }, - "reviewSummaries": { + "relationships": { "properties": { - "links": { - "type": "object", + "product": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" + "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" - }, - "quoteLineItems": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "productStream": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" + "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" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" + "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}$" }, - "downloads": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } + "name": { + "type": "string" }, - "parent": { - "$ref": "#/components/schemas/Product" + "position": { + "type": "integer", + "format": "int64" }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "sortBy": { + "type": "string" }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "sortDirection": { + "type": "string" }, - "tax": { - "$ref": "#/components/schemas/Tax" + "type": { + "type": "string" }, - "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer" + "active": { + "type": "boolean" }, - "unit": { - "$ref": "#/components/schemas/Unit" + "limit": { + "type": "integer", + "format": "int64" }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "featureSet": { - "$ref": "#/components/schemas/ProductFeatureSet" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "prices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } + "translated": { + "type": "object" }, - "crossSellings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } + "product": { + "$ref": "#/components/schemas/Product" }, - "crossSellingAssignedProducts": { + "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" }, - "configuratorSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } + { + "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}$" }, - "visibilities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } + "crossSellingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "searchKeywords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "productReviews": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "mainCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "position": { + "type": "integer", + "format": "int64" }, - "seoUrls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "orderLineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "wishlists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } + "product": { + "$ref": "#/components/schemas/Product" }, - "options": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "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}$" }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "customFieldSetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "streams": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "categoriesRo": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "product": { + "$ref": "#/components/schemas/Product" }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "type": "object" + }, + "ProductDownloadJsonApi": { + "description": "Added since version: 6.4.19.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "customFieldSets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } + { + "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" } - }, - "type": "object" + ] }, - "ProductCategory": { - "description": "Added since version: 6.0.0.0", + "ProductDownload": { + "description": "Added since version: 6.4.19.0", "required": [ + "id", "productId", - "categoryId" + "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}$" @@ -45547,177 +70316,553 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryVersionId": { + "position": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, "product": { "$ref": "#/components/schemas/Product" }, - "category": { - "$ref": "#/components/schemas/Category" + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "ProductCategoryTree": { - "description": "Added since version: 6.0.0.0", + "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": [ - "productId", - "categoryId" + "id", + "productStreamId", + "storefrontSalesChannelId", + "salesChannelId", + "salesChannelDomainId", + "currencyId", + "fileName", + "accessKey", + "encoding", + "fileFormat", + "generateByCronjob", + "interval", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "storefrontSalesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "categoryVersionId": { + "salesChannelDomainId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "product": { - "$ref": "#/components/schemas/Product" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "category": { - "$ref": "#/components/schemas/Category" + "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" }, - "ProductConfiguratorSettingJsonApi": { - "description": "Added since version: 6.0.0.0", + "ProductFeatureSetJsonApi": { + "description": "Added since version: 6.3.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "optionId", - "createdAt" + "id", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "productId": { + "description": { + "type": "string" + }, + "features": { + "type": "object" + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "productVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "mediaId": { + "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}$" }, - "optionId": { + "languageId": { "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 + "keyword": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "reversed": { + "type": "string" }, "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": { + "language": { "properties": { "links": { "type": "object", @@ -45725,7 +70870,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-configurator-setting/62bab37b1cdb1e5ffd2e0ea79ac515cb/option" + "example": "/product-keyword-dictionary/a1bc4695aa3e6f80fb42d62e6439296c/language" } } }, @@ -45734,12 +70879,12 @@ "properties": { "type": { "type": "string", - "example": "property_group_option" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ef3e30e070f70244fd6578d88a6b77ac" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -45754,123 +70899,70 @@ } ] }, - "ProductConfiguratorSetting": { + "ProductKeywordDictionary": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "optionId", - "createdAt" + "id", + "languageId", + "keyword" ], "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": { + "languageId": { "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" + "keyword": { + "type": "string" }, - "media": { - "$ref": "#/components/schemas/Media" + "reversed": { + "type": "string" }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" + "language": { + "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "ProductCrossSellingJsonApi": { - "description": "Added since version: 6.1.0.0", + "ProductManufacturerJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", - "position", - "type", - "productId", - "createdAt" + "id", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sortBy": { + "link": { "type": "string" }, - "sortDirection": { + "name": { "type": "string" }, - "type": { + "description": { "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}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -45885,38 +70977,17 @@ "translated": { "type": "object" }, - "relationships": { + "extensions": { "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" - } - } - } - }, + "search": { "type": "object" - }, - "productStream": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "media": { "properties": { "links": { "type": "object", @@ -45924,7 +70995,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/productStream" + "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/media" } } }, @@ -45933,19 +71004,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "assignedProducts": { + "products": { "properties": { "links": { "type": "object", @@ -45953,7 +71024,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling/30f0355cd0686038f211fd5c8014c9b4/assignedProducts" + "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/products" } } }, @@ -45964,11 +71035,11 @@ "properties": { "type": { "type": "string", - "example": "product_cross_selling_assigned_products" + "example": "product" }, "id": { "type": "string", - "example": "5da5e10eda1b7026499bcd4747d6bdf8" + "example": "86024cad1e83101d97359d7351051156" } } } @@ -45984,54 +71055,37 @@ } ] }, - "ProductCrossSelling": { - "description": "Added since version: 6.1.0.0", + "ProductManufacturer": { + "description": "Added since version: 6.0.0.0", "required": [ - "name", - "position", - "type", - "productId", - "createdAt" + "id", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sortBy": { + "link": { "type": "string" }, - "sortDirection": { + "name": { "type": "string" }, - "type": { + "description": { "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}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -46046,31 +71100,37 @@ "translated": { "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "extensions": { + "properties": { + "search": { + "type": "object" + } + }, + "type": "object" }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "media": { + "$ref": "#/components/schemas/Media" }, - "assignedProducts": { + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/Product" } } }, "type": "object" }, - "ProductCrossSellingAssignedProductsJsonApi": { - "description": "Added since version: 6.2.0.0", + "ProductMediaJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "crossSellingId", + "id", "productId", + "mediaId", "createdAt" ], "properties": { @@ -46078,7 +71138,7 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "crossSellingId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46090,10 +71150,17 @@ "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", @@ -46114,7 +71181,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/product" + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/product" } } }, @@ -46135,7 +71202,7 @@ }, "type": "object" }, - "crossSelling": { + "media": { "properties": { "links": { "type": "object", @@ -46143,7 +71210,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-cross-selling-assigned-products/281cee27ae278acd6f5f2bc77ce12736/crossSelling" + "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" } } }, @@ -46152,12 +71219,43 @@ "properties": { "type": { "type": "string", - "example": "product_cross_selling" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ef23268669fb6d8a7def2b9f2da0aceb" + "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" + } } } } @@ -46172,11 +71270,12 @@ } ] }, - "ProductCrossSellingAssignedProducts": { - "description": "Added since version: 6.2.0.0", + "ProductMedia": { + "description": "Added since version: 6.0.0.0", "required": [ - "crossSellingId", + "id", "productId", + "mediaId", "createdAt" ], "properties": { @@ -46184,7 +71283,7 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "crossSellingId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46196,10 +71295,17 @@ "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", @@ -46213,17 +71319,23 @@ "product": { "$ref": "#/components/schemas/Product" }, - "crossSelling": { - "$ref": "#/components/schemas/ProductCrossSelling" + "media": { + "$ref": "#/components/schemas/Media" + }, + "coverProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" }, - "ProductCustomFieldSet": { - "description": "Added since version: 6.3.0.0", + "ProductOption": { + "description": "Added since version: 6.0.0.0", "required": [ "productId", - "customFieldSetId" + "optionId" ], "properties": { "id": { @@ -46234,33 +71346,36 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "optionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "product": { "$ref": "#/components/schemas/Product" }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "ProductDownloadJsonApi": { - "description": "Added since version: 6.4.19.0", + "ProductPriceJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", "productId", - "mediaId", + "ruleId", + "price", + "quantityStart", "createdAt" ], "properties": { @@ -46280,11 +71395,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { + "price": { + "type": "object" + }, + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { "type": "integer", "format": "int64" }, @@ -46311,7 +71433,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/product" + "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" } } }, @@ -46332,7 +71454,7 @@ }, "type": "object" }, - "media": { + "rule": { "properties": { "links": { "type": "object", @@ -46340,7 +71462,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-download/f1371d26b74fe7557f3d9b5aeb2653df/media" + "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" } } }, @@ -46349,12 +71471,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "981c1e7b3795da18687613fbd66d4954" } } } @@ -46369,22 +71491,81 @@ } ] }, - "ProductDownload": { - "description": "Added since version: 6.4.19.0", + "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", - "mediaId", - "createdAt" + "optionId" ], "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}$" @@ -46393,55 +71574,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "optionId": { "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" + "option": { + "$ref": "#/components/schemas/PropertyGroupOption" } }, "type": "object" }, - "ProductExportJsonApi": { - "description": "Added since version: 6.1.0.0", + "ProductReviewJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productStreamId", - "storefrontSalesChannelId", + "id", + "productId", "salesChannelId", - "salesChannelDomainId", - "currencyId", - "fileName", - "accessKey", - "encoding", - "fileFormat", - "generateByCronjob", - "interval", + "languageId", + "title", + "content", "createdAt" ], "properties": { @@ -46449,66 +71608,50 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "storefrontSalesChannelId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelDomainId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileName": { + "externalUser": { "type": "string" }, - "accessKey": { + "externalEmail": { "type": "string" }, - "encoding": { + "title": { "type": "string" }, - "fileFormat": { + "content": { "type": "string" }, - "includeVariants": { - "type": "boolean" + "points": { + "type": "number", + "format": "float" }, - "generateByCronjob": { + "status": { "type": "boolean" }, - "generatedAt": { - "type": "string", - "format": "date-time" - }, - "interval": { - "type": "integer", - "format": "int64" - }, - "headerTemplate": { - "type": "string" - }, - "bodyTemplate": { - "type": "string" - }, - "footerTemplate": { + "comment": { "type": "string" }, - "pausedSchedule": { - "type": "boolean" - }, - "isRunning": { - "type": "boolean" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -46522,7 +71665,7 @@ }, "relationships": { "properties": { - "productStream": { + "product": { "properties": { "links": { "type": "object", @@ -46530,7 +71673,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/productStream" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" } } }, @@ -46539,19 +71682,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "storefrontSalesChannel": { + "customer": { "properties": { "links": { "type": "object", @@ -46559,7 +71702,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/storefrontSalesChannel" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/customer" } } }, @@ -46568,12 +71711,12 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "5979d6e259ba5ec4c2b93cf79df6f2e5" + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -46588,7 +71731,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/salesChannel" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/salesChannel" } } }, @@ -46609,36 +71752,7 @@ }, "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": { + "language": { "properties": { "links": { "type": "object", @@ -46646,7 +71760,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-export/7a835b69a3e491d9a3be31d2de469f8a/currency" + "example": "/product-review/0793b857a73beced20090eec19b11a3d/language" } } }, @@ -46655,12 +71769,12 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -46675,20 +71789,15 @@ } ] }, - "ProductExport": { - "description": "Added since version: 6.1.0.0", + "ProductReview": { + "description": "Added since version: 6.0.0.0", "required": [ - "productStreamId", - "storefrontSalesChannelId", + "id", + "productId", "salesChannelId", - "salesChannelDomainId", - "currencyId", - "fileName", - "accessKey", - "encoding", - "fileFormat", - "generateByCronjob", - "interval", + "languageId", + "title", + "content", "createdAt" ], "properties": { @@ -46696,66 +71805,50 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "storefrontSalesChannelId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelDomainId": { + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileName": { + "externalUser": { "type": "string" }, - "accessKey": { + "externalEmail": { "type": "string" }, - "encoding": { + "title": { "type": "string" }, - "fileFormat": { + "content": { "type": "string" }, - "includeVariants": { - "type": "boolean" + "points": { + "type": "number", + "format": "float" }, - "generateByCronjob": { + "status": { "type": "boolean" }, - "generatedAt": { - "type": "string", - "format": "date-time" - }, - "interval": { - "type": "integer", - "format": "int64" - }, - "headerTemplate": { - "type": "string" - }, - "bodyTemplate": { - "type": "string" - }, - "footerTemplate": { + "comment": { "type": "string" }, - "pausedSchedule": { - "type": "boolean" - }, - "isRunning": { - "type": "boolean" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -46767,272 +71860,55 @@ "format": "date-time", "readOnly": true }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "product": { + "$ref": "#/components/schemas/Product" }, - "storefrontSalesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "customer": { + "$ref": "#/components/schemas/Customer" }, "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": [ - "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": [ - "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": [ - "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": [ - "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", + "ProductReviewSummaryJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "createdAt", - "name" + "id", + "productId", + "salesChannelId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "link": { - "type": "string" - }, - "name": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "summary": { "type": "string" }, - "customFields": { - "type": "object" + "visible": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -47049,7 +71925,7 @@ }, "relationships": { "properties": { - "media": { + "product": { "properties": { "links": { "type": "object", @@ -47057,7 +71933,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/media" + "example": "/product-review-summary/a4b5dac1755dd11ea772509278bbc072/product" } } }, @@ -47066,19 +71942,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "products": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -47086,23 +71962,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-manufacturer/269f96011fc7a4e7a8c1fa87b45b8d1d/products" + "example": "/product-review-summary/a4b5dac1755dd11ea772509278bbc072/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -47117,36 +71991,35 @@ } ] }, - "ProductManufacturer": { - "description": "Added since version: 6.0.0.0", + "ProductReviewSummary": { "required": [ - "createdAt", - "name" + "id", + "productId", + "salesChannelId", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "link": { - "type": "string" - }, - "name": { - "type": "string" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { + "summary": { "type": "string" }, - "customFields": { - "type": "object" + "visible": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -47161,28 +72034,27 @@ "translated": { "type": "object" }, - "media": { - "$ref": "#/components/schemas/Media" + "product": { + "$ref": "#/components/schemas/Product" }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "ProductMediaJsonApi": { - "description": "Added since version: 6.0.0.0", + "ProductSearchConfigJsonApi": { + "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "mediaId", + "id", + "languageId", + "andLogic", + "minSearchLength", "createdAt" ], "properties": { @@ -47190,28 +72062,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "andLogic": { + "type": "boolean" }, - "position": { + "minSearchLength": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" + "excludedTerms": { + "type": "array", + "items": { + "type": "string" + } }, "createdAt": { "type": "string", @@ -47225,36 +72091,7 @@ }, "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": { + "language": { "properties": { "links": { "type": "object", @@ -47262,7 +72099,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/media" + "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" } } }, @@ -47271,19 +72108,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "coverProducts": { + "configFields": { "properties": { "links": { "type": "object", @@ -47291,7 +72128,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-media/b93c38a6be7ba7db807d807adfff50a3/coverProducts" + "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" } } }, @@ -47302,11 +72139,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_search_config_field" }, "id": { "type": "string", - "example": "41f7b522ee6fd2f54469cf9ec8e1c8b0" + "example": "5334117da647d3f2fb8a82948d56bcc3" } } } @@ -47322,11 +72159,13 @@ } ] }, - "ProductMedia": { - "description": "Added since version: 6.0.0.0", + "ProductSearchConfig": { + "description": "Added since version: 6.3.5.0", "required": [ - "productId", - "mediaId", + "id", + "languageId", + "andLogic", + "minSearchLength", "createdAt" ], "properties": { @@ -47334,28 +72173,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "andLogic": { + "type": "boolean" }, - "position": { + "minSearchLength": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" + "excludedTerms": { + "type": "array", + "items": { + "type": "string" + } }, "createdAt": { "type": "string", @@ -47367,65 +72200,32 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" - }, - "media": { - "$ref": "#/components/schemas/Media" + "language": { + "$ref": "#/components/schemas/Language" }, - "coverProducts": { + "configFields": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/ProductSearchConfigField" } } }, "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", + "ProductSearchConfigFieldJsonApi": { + "description": "Added since version: 6.3.5.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "ruleId", - "price", - "quantityStart", + "id", + "searchConfigId", + "field", + "tokenize", + "searchable", + "ranking", "createdAt" ], "properties": { @@ -47433,36 +72233,27 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "searchConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "type": "string" }, - "price": { - "type": "object" + "tokenize": { + "type": "boolean" }, - "quantityStart": { - "type": "integer", - "format": "int64" + "searchable": { + "type": "boolean" }, - "quantityEnd": { + "ranking": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -47475,7 +72266,7 @@ }, "relationships": { "properties": { - "product": { + "searchConfig": { "properties": { "links": { "type": "object", @@ -47483,7 +72274,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-price/2003a59b6b10a56954d203e225f83585/product" + "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" } } }, @@ -47492,19 +72283,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "product_search_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "bc8281d44069ce8ffd34144fbad1bddd" } } } }, "type": "object" }, - "rule": { + "customField": { "properties": { "links": { "type": "object", @@ -47512,7 +72303,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-price/2003a59b6b10a56954d203e225f83585/rule" + "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" } } }, @@ -47521,12 +72312,12 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "custom_field" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "example": "ed2028a1c479c7e0065da597452d9c11" } } } @@ -47541,13 +72332,15 @@ } ] }, - "ProductPrice": { - "description": "Added since version: 6.0.0.0", + "ProductSearchConfigField": { + "description": "Added since version: 6.3.5.0", "required": [ - "productId", - "ruleId", - "price", - "quantityStart", + "id", + "searchConfigId", + "field", + "tokenize", + "searchable", + "ranking", "createdAt" ], "properties": { @@ -47555,36 +72348,27 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { + "searchConfigId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "customFieldId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "field": { + "type": "string" }, - "price": { - "type": "object" + "tokenize": { + "type": "boolean" }, - "quantityStart": { - "type": "integer", - "format": "int64" + "searchable": { + "type": "boolean" }, - "quantityEnd": { + "ranking": { "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -47595,48 +72379,16 @@ "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" + "searchConfig": { + "$ref": "#/components/schemas/ProductSearchConfig" }, - "option": { - "$ref": "#/components/schemas/PropertyGroupOption" + "customField": { + "$ref": "#/components/schemas/CustomField" } }, "type": "object" }, - "ProductReviewJsonApi": { + "ProductSearchKeywordJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -47644,11 +72396,11 @@ }, { "required": [ - "productId", - "salesChannelId", + "id", "languageId", - "title", - "content", + "productId", + "keyword", + "ranking", "createdAt" ], "properties": { @@ -47656,51 +72408,29 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalUser": { - "type": "string" - }, - "externalEmail": { - "type": "string" - }, - "title": { - "type": "string" - }, - "content": { + "keyword": { "type": "string" }, - "points": { + "ranking": { "type": "number", "format": "float" }, - "status": { - "type": "boolean" - }, - "comment": { - "type": "string" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -47721,7 +72451,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review/0793b857a73beced20090eec19b11a3d/product" + "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/product" } } }, @@ -47742,64 +72472,6 @@ }, "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": { @@ -47808,7 +72480,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review/0793b857a73beced20090eec19b11a3d/language" + "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" } } }, @@ -47837,66 +72509,156 @@ } ] }, - "ProductReview": { - "description": "Added since version: 6.0.0.0", + "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": [ - "productId", - "salesChannelId", - "languageId", - "title", - "content", - "createdAt" + "id", + "key", + "priority", + "active", + "fields", + "createdAt", + "label" ], "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" + "locked": { + "type": "boolean" }, - "content": { + "key": { "type": "string" }, - "points": { - "type": "number", - "format": "float" + "priority": { + "type": "integer", + "format": "int64" }, - "status": { + "active": { "type": "boolean" }, - "comment": { - "type": "string" - }, - "customFields": { + "fields": { "type": "object" }, + "label": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -47907,54 +72669,45 @@ "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" + "translated": { + "type": "object" } }, "type": "object" }, - "ProductReviewSummaryJsonApi": { + "ProductStreamJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "salesChannelId", - "createdAt" + "id", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "apiFilter": { + "type": "object", + "readOnly": true }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "invalid": { + "type": "boolean", + "readOnly": true }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "summary": { + "description": { "type": "string" }, - "visible": { - "type": "boolean" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -47971,7 +72724,7 @@ }, "relationships": { "properties": { - "product": { + "filters": { "properties": { "links": { "type": "object", @@ -47979,28 +72732,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review-summary/a4b5dac1755dd11ea772509278bbc072/product" + "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": { - "type": { - "type": "string", - "example": "product" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "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" }, - "salesChannel": { + "productExports": { "properties": { "links": { "type": "object", @@ -48008,21 +72794,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-review-summary/a4b5dac1755dd11ea772509278bbc072/salesChannel" + "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": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" + } } } } @@ -48037,34 +72856,34 @@ } ] }, - "ProductReviewSummary": { + "ProductStream": { + "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "salesChannelId", - "createdAt" + "id", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "apiFilter": { + "type": "object", + "readOnly": true }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "invalid": { + "type": "boolean", + "readOnly": true }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "summary": { + "description": { "type": "string" }, - "visible": { - "type": "boolean" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -48079,26 +72898,44 @@ "translated": { "type": "object" }, - "product": { - "$ref": "#/components/schemas/Product" + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "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" }, - "ProductSearchConfigJsonApi": { - "description": "Added since version: 6.3.5.0", + "ProductStreamFilterJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "languageId", - "andLogic", - "minSearchLength", + "id", + "productStreamId", + "type", "createdAt" ], "properties": { @@ -48106,22 +72943,35 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "andLogic": { - "type": "boolean" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "minSearchLength": { + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "position": { "type": "integer", "format": "int64" }, - "excludedTerms": { - "type": "array", - "items": { - "type": "string" - } + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -48135,7 +72985,7 @@ }, "relationships": { "properties": { - "language": { + "productStream": { "properties": { "links": { "type": "object", @@ -48143,7 +72993,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/language" + "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/productStream" } } }, @@ -48152,19 +73002,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "product_stream" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "49561f6faa0badfce831a183d2ec7c2f" } } } }, "type": "object" }, - "configFields": { + "parent": { "properties": { "links": { "type": "object", @@ -48172,7 +73022,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config/a150b98c1747cffb40453f0c15e18261/configFields" + "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" } } }, @@ -48183,11 +73062,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_config_field" + "example": "product_stream_filter" }, "id": { "type": "string", - "example": "5334117da647d3f2fb8a82948d56bcc3" + "example": "5da7eb4247add5dbd5776c9c0b38460a" } } } @@ -48203,12 +73082,12 @@ } ] }, - "ProductSearchConfig": { - "description": "Added since version: 6.3.5.0", + "ProductStreamFilter": { + "description": "Added since version: 6.0.0.0", "required": [ - "languageId", - "andLogic", - "minSearchLength", + "id", + "productStreamId", + "type", "createdAt" ], "properties": { @@ -48216,22 +73095,35 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "productStreamId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "andLogic": { - "type": "boolean" + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "minSearchLength": { + "type": { + "type": "string" + }, + "field": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "value": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "position": { "type": "integer", "format": "int64" }, - "excludedTerms": { - "type": "array", - "items": { - "type": "string" - } + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -48243,31 +73135,97 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "productStream": { + "$ref": "#/components/schemas/ProductStream" }, - "configFields": { + "parent": { + "$ref": "#/components/schemas/ProductStreamFilter" + }, + "queries": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductStreamFilter" } } }, "type": "object" }, - "ProductSearchConfigFieldJsonApi": { - "description": "Added since version: 6.3.5.0", + "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": [ - "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", + "id", + "productId", + "salesChannelId", + "visibility", "createdAt" ], "properties": { @@ -48275,24 +73233,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "searchConfigId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldId": { + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "field": { - "type": "string" - }, - "tokenize": { - "type": "boolean" - }, - "searchable": { - "type": "boolean" - }, - "ranking": { + "visibility": { "type": "integer", "format": "int64" }, @@ -48308,7 +73261,7 @@ }, "relationships": { "properties": { - "searchConfig": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -48316,7 +73269,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/searchConfig" + "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" } } }, @@ -48325,19 +73278,19 @@ "properties": { "type": { "type": "string", - "example": "product_search_config" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "bc8281d44069ce8ffd34144fbad1bddd" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "customField": { + "product": { "properties": { "links": { "type": "object", @@ -48345,7 +73298,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-config-field/38271ca1804968a1c9d07c12719453b8/customField" + "example": "/product-visibility/e965d09420555f52df9b20f904697d96/product" } } }, @@ -48354,12 +73307,12 @@ "properties": { "type": { "type": "string", - "example": "custom_field" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ed2028a1c479c7e0065da597452d9c11" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -48374,14 +73327,13 @@ } ] }, - "ProductSearchConfigField": { - "description": "Added since version: 6.3.5.0", + "ProductVisibility": { + "description": "Added since version: 6.0.0.0", "required": [ - "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", + "id", + "productId", + "salesChannelId", + "visibility", "createdAt" ], "properties": { @@ -48389,24 +73341,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "searchConfigId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldId": { + "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "field": { - "type": "string" - }, - "tokenize": { - "type": "boolean" - }, - "searchable": { - "type": "boolean" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "ranking": { + "visibility": { "type": "integer", "format": "int64" }, @@ -48420,27 +73367,26 @@ "format": "date-time", "readOnly": true }, - "searchConfig": { - "$ref": "#/components/schemas/ProductSearchConfig" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "customField": { - "$ref": "#/components/schemas/CustomField" + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "ProductSearchKeywordJsonApi": { - "description": "Added since version: 6.0.0.0", + "ProductWarehouseJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "languageId", + "id", "productId", - "keyword", - "ranking", + "warehouseId", + "stock", "createdAt" ], "properties": { @@ -48448,14 +73394,6 @@ "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}$" @@ -48464,12 +73402,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "keyword": { - "type": "string" + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "ranking": { - "type": "number", - "format": "float" + "stock": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -48491,7 +73430,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/product" + "example": "/product-warehouse/bb934215f15673b81755030f1d8cc000/product" } } }, @@ -48512,7 +73451,7 @@ }, "type": "object" }, - "language": { + "warehouse": { "properties": { "links": { "type": "object", @@ -48520,7 +73459,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-search-keyword/b704475cf722682ba73e11d9903e09a4/language" + "example": "/product-warehouse/bb934215f15673b81755030f1d8cc000/warehouse" } } }, @@ -48529,12 +73468,12 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "warehouse" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "372d30dd2849813ef674855253900679" } } } @@ -48549,13 +73488,12 @@ } ] }, - "ProductSearchKeyword": { - "description": "Added since version: 6.0.0.0", + "ProductWarehouse": { "required": [ - "languageId", + "id", "productId", - "keyword", - "ranking", + "warehouseId", + "stock", "createdAt" ], "properties": { @@ -48563,14 +73501,6 @@ "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}$" @@ -48579,12 +73509,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "keyword": { - "type": "string" + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "ranking": { - "type": "number", - "format": "float" + "stock": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -48599,120 +73530,44 @@ "product": { "$ref": "#/components/schemas/Product" }, - "language": { - "$ref": "#/components/schemas/Language" + "warehouse": { + "$ref": "#/components/schemas/Warehouse" } }, "type": "object" }, - "ProductSortingJsonApi": { - "description": "Added since version: 6.3.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "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", + "ProductWarehouseGroup": { "required": [ - "key", - "priority", - "active", - "fields", - "createdAt", - "label" + "productId", + "warehouseGroupId" ], "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" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "productVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "warehouseGroupId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "product": { + "$ref": "#/components/schemas/Product" + }, + "warehouseGroup": { + "$ref": "#/components/schemas/WarehouseGroup" } }, "type": "object" }, - "ProductStreamJsonApi": { + "PromotionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -48720,6 +73575,14 @@ }, { "required": [ + "id", + "active", + "priority", + "exclusive", + "useCodes", + "useIndividualCodes", + "useSetGroups", + "preventCombination", "createdAt", "name" ], @@ -48728,20 +73591,72 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "apiFilter": { - "type": "object", - "readOnly": true + "name": { + "type": "string" }, - "invalid": { - "type": "boolean", - "readOnly": true + "active": { + "type": "boolean" }, - "name": { + "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" }, - "description": { + "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" }, @@ -48758,9 +73673,9 @@ "translated": { "type": "object" }, - "relationships": { + "extensions": { "properties": { - "filters": { + "quoteLineItems": { "properties": { "links": { "type": "object", @@ -48768,7 +73683,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/filters" + "example": "/promotion/626a54d37d402d449d6d7541911e0952/quoteLineItems" } } }, @@ -48779,19 +73694,24 @@ "properties": { "type": { "type": "string", - "example": "product_stream_filter" + "example": "quote_line_item" }, "id": { "type": "string", - "example": "2c9885d2b0c7e26971f60a90f33cf718" + "example": "6b1c17ad551ef636e491ab6848f68420" } } } } }, "type": "object" - }, - "productCrossSellings": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "setgroups": { "properties": { "links": { "type": "object", @@ -48799,7 +73719,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productCrossSellings" + "example": "/promotion/626a54d37d402d449d6d7541911e0952/setgroups" } } }, @@ -48810,11 +73730,11 @@ "properties": { "type": { "type": "string", - "example": "product_cross_selling" + "example": "promotion_setgroup" }, "id": { "type": "string", - "example": "6fa3de1d94218e2ac5a51cbeaca7f846" + "example": "3c963571517f44e87274198cb8bb62a8" } } } @@ -48822,7 +73742,7 @@ }, "type": "object" }, - "productExports": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -48830,7 +73750,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/productExports" + "example": "/promotion/626a54d37d402d449d6d7541911e0952/salesChannels" } } }, @@ -48841,11 +73761,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "promotion_sales_channel" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -48853,7 +73773,7 @@ }, "type": "object" }, - "categories": { + "discounts": { "properties": { "links": { "type": "object", @@ -48861,7 +73781,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/categories" + "example": "/promotion/626a54d37d402d449d6d7541911e0952/discounts" } } }, @@ -48872,154 +73792,50 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "promotion_discount" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "9544fa2fae515081e7fc27ef2d268642" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "ProductStream": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "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", @@ -49027,28 +73843,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/productStream" + "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": { - "type": { - "type": "string", - "example": "product_stream" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "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" }, - "parent": { + "orderRules": { "properties": { "links": { "type": "object", @@ -49056,28 +73905,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/parent" + "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": { - "type": { - "type": "string", - "example": "product_stream_filter" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "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" }, - "queries": { + "orderLineItems": { "properties": { "links": { "type": "object", @@ -49085,7 +73967,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-stream-filter/4e06c1fc9085cee6646a5e736395212d/queries" + "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderLineItems" } } }, @@ -49096,11 +73978,11 @@ "properties": { "type": { "type": "string", - "example": "product_stream_filter" + "example": "order_line_item" }, "id": { "type": "string", - "example": "5da7eb4247add5dbd5776c9c0b38460a" + "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" } } } @@ -49116,44 +73998,90 @@ } ] }, - "ProductStreamFilter": { + "Promotion": { "description": "Added since version: 6.0.0.0", "required": [ - "productStreamId", - "type", - "createdAt" + "id", + "active", + "priority", + "exclusive", + "useCodes", + "useIndividualCodes", + "useSetGroups", + "preventCombination", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "validFrom": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "parentId": { + "validUntil": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "type": { - "type": "string" + "maxRedemptionsGlobal": { + "type": "integer", + "format": "int64" }, - "field": { - "type": "string" + "maxRedemptionsPerCustomer": { + "type": "integer", + "format": "int64" }, - "operator": { + "priority": { + "type": "integer", + "format": "int64" + }, + "exclusive": { + "type": "boolean" + }, + "code": { "type": "string" }, - "value": { + "useCodes": { + "type": "boolean" + }, + "useIndividualCodes": { + "type": "boolean" + }, + "individualCodePattern": { "type": "string" }, - "parameters": { - "type": "object" + "useSetGroups": { + "type": "boolean" }, - "position": { + "customerRestriction": { + "type": "boolean" + }, + "preventCombination": { + "type": "boolean" + }, + "orderCount": { "type": "integer", - "format": "int64" + "format": "int64", + "readOnly": true + }, + "ordersPerCustomerCount": { + "type": "object", + "readOnly": true + }, + "exclusionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, "customFields": { "type": "object" @@ -49168,86 +74096,131 @@ "format": "date-time", "readOnly": true }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "translated": { + "type": "object" }, - "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "extensions": { + "properties": { + "quoteLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/promotion/626a54d37d402d449d6d7541911e0952/quoteLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "queries": { + "setgroups": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/PromotionSetgroup" } - } - }, - "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}$" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "discounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "individualCodes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } }, - "product": { - "$ref": "#/components/schemas/Product" + "personaRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "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" }, - "ProductTag": { + "PromotionCartRule": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "tagId" + "promotionId", + "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "product": { - "$ref": "#/components/schemas/Product" + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "rule": { + "$ref": "#/components/schemas/Rule" } }, "type": "object" }, - "ProductVisibilityJsonApi": { + "PromotionDiscountJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -49255,9 +74228,12 @@ }, { "required": [ - "productId", - "salesChannelId", - "visibility", + "id", + "promotionId", + "scope", + "type", + "value", + "considerAdvancedRules", "createdAt" ], "properties": { @@ -49265,21 +74241,38 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "scope": { + "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "visibility": { - "type": "integer", - "format": "int64" + "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", @@ -49293,7 +74286,7 @@ }, "relationships": { "properties": { - "salesChannel": { + "promotion": { "properties": { "links": { "type": "object", @@ -49301,7 +74294,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-visibility/e965d09420555f52df9b20f904697d96/salesChannel" + "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotion" } } }, @@ -49310,19 +74303,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "promotion" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "product": { + "discountRules": { "properties": { "links": { "type": "object", @@ -49330,21 +74323,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-visibility/e965d09420555f52df9b20f904697d96/product" + "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": { - "type": { - "type": "string", - "example": "product" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "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" + } } } } @@ -49359,12 +74385,15 @@ } ] }, - "ProductVisibility": { + "PromotionDiscount": { "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "salesChannelId", - "visibility", + "id", + "promotionId", + "scope", + "type", + "value", + "considerAdvancedRules", "createdAt" ], "properties": { @@ -49372,21 +74401,38 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "promotionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "scope": { + "type": "string" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "visibility": { - "type": "integer", - "format": "int64" + "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", @@ -49398,25 +74444,36 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "product": { - "$ref": "#/components/schemas/Product" + "discountRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + }, + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } } }, "type": "object" }, - "ProductWarehouseJsonApi": { + "PromotionDiscountPricesJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "productId", - "warehouseId", - "stock", + "id", + "discountId", + "currencyId", + "price", "createdAt" ], "properties": { @@ -49424,21 +74481,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "warehouseId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stock": { - "type": "integer", - "format": "int64" + "price": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -49452,7 +74505,7 @@ }, "relationships": { "properties": { - "product": { + "promotionDiscount": { "properties": { "links": { "type": "object", @@ -49460,7 +74513,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-warehouse/bb934215f15673b81755030f1d8cc000/product" + "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" } } }, @@ -49469,19 +74522,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "promotion_discount" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "eaeedb5c09dfc7dbf130657ed44ef33f" } } } }, "type": "object" }, - "warehouse": { + "currency": { "properties": { "links": { "type": "object", @@ -49489,7 +74542,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product-warehouse/bb934215f15673b81755030f1d8cc000/warehouse" + "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" } } }, @@ -49498,12 +74551,12 @@ "properties": { "type": { "type": "string", - "example": "warehouse" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "372d30dd2849813ef674855253900679" + "example": "1af0389838508d7016a9841eb6273962" } } } @@ -49518,11 +74571,13 @@ } ] }, - "ProductWarehouse": { + "PromotionDiscountPrices": { + "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "warehouseId", - "stock", + "id", + "discountId", + "currencyId", + "price", "createdAt" ], "properties": { @@ -49530,21 +74585,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "warehouseId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stock": { - "type": "integer", - "format": "int64" + "price": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -49556,47 +74607,44 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "promotionDiscount": { + "$ref": "#/components/schemas/PromotionDiscount" }, - "warehouse": { - "$ref": "#/components/schemas/Warehouse" + "currency": { + "$ref": "#/components/schemas/Currency" } }, "type": "object" }, - "ProductWarehouseGroup": { + "PromotionDiscountRule": { + "description": "Added since version: 6.0.0.0", "required": [ - "productId", - "warehouseGroupId" + "discountId", + "ruleId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "discountId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "warehouseGroupId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "product": { - "$ref": "#/components/schemas/Product" + "discount": { + "$ref": "#/components/schemas/PromotionDiscount" }, - "warehouseGroup": { - "$ref": "#/components/schemas/WarehouseGroup" + "rule": { + "$ref": "#/components/schemas/Rule" } }, "type": "object" }, - "PromotionJsonApi": { + "PromotionIndividualCodeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -49604,88 +74652,24 @@ }, { "required": [ - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", - "name" + "id", + "promotionId", + "code", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validUntil": { + "promotionId": { "type": "string", - "format": "date-time" - }, - "maxRedemptionsGlobal": { - "type": "integer", - "format": "int64" - }, - "maxRedemptionsPerCustomer": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "exclusive": { - "type": "boolean" + "pattern": "^[0-9a-f]{32}$" }, "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": { + "payload": { "type": "object" }, "createdAt": { @@ -49698,110 +74682,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "quoteLineItems": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/quoteLineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" - } - } - } - } - }, - "type": "object" - } - }, - "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": { + "promotion": { "properties": { "links": { "type": "object", @@ -49809,92 +74692,202 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/discounts" + "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" } } }, "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": { "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": { + "example": "promotion" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" - }, - "personaCustomers": { + } + }, + "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", @@ -49902,30 +74895,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/personaCustomers" + "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "example": "b969a9b0d5772d70ea83383c1be06c82" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "orderRules": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -49933,30 +74924,127 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderRules" + "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "example": "ee517f71bf240d98dcf33db6e6ffa881" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - }, - "cartRules": { + } + }, + "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", @@ -49964,30 +75052,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/cartRules" + "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "example": "6549606ef529fde0a7628b4c0aa7c6ef" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" } } } }, "type": "object" }, - "orderLineItems": { + "setGroupRules": { "properties": { "links": { "type": "object", @@ -49995,7 +75081,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/orderLineItems" + "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" } } }, @@ -50006,11 +75092,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "rule" }, "id": { "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + "example": "a54c38d5a1d9180d689d11234afbbb32" } } } @@ -50026,92 +75112,34 @@ } ] }, - "Promotion": { + "PromotionSetgroup": { "description": "Added since version: 6.0.0.0", "required": [ - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", - "name" + "id", + "promotionId", + "packagerKey", + "sorterKey", + "value", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validUntil": { + "promotionId": { "type": "string", - "format": "date-time" - }, - "maxRedemptionsGlobal": { - "type": "integer", - "format": "int64" - }, - "maxRedemptionsPerCustomer": { - "type": "integer", - "format": "int64" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "exclusive": { - "type": "boolean" + "pattern": "^[0-9a-f]{32}$" }, - "code": { + "packagerKey": { "type": "string" }, - "useCodes": { - "type": "boolean" - }, - "useIndividualCodes": { - "type": "boolean" - }, - "individualCodePattern": { + "sorterKey": { "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" + "value": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -50123,106 +75151,22 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { - "properties": { - "quoteLineItems": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/promotion/626a54d37d402d449d6d7541911e0952/quoteLineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" - } - } - } - } - }, - "type": "object" - } - }, - "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" - } + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "cartRules": { + "setGroupRules": { "type": "array", "items": { "$ref": "#/components/schemas/Rule" } - }, - "orderLineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } } }, "type": "object" }, - "PromotionCartRule": { + "PromotionSetgroupRule": { "description": "Added since version: 6.0.0.0", "required": [ - "promotionId", + "setgroupId", "ruleId" ], "properties": { @@ -50230,7 +75174,7 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { + "setgroupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -50238,8 +75182,8 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotion": { - "$ref": "#/components/schemas/Promotion" + "setgroup": { + "$ref": "#/components/schemas/PromotionSetgroup" }, "rule": { "$ref": "#/components/schemas/Rule" @@ -50247,7 +75191,7 @@ }, "type": "object" }, - "PromotionDiscountJsonApi": { + "PropertyGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -50255,50 +75199,41 @@ }, { "required": [ - "promotionId", - "scope", - "type", - "value", - "considerAdvancedRules", - "createdAt" + "id", + "displayType", + "sortingType", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "scope": { + "description": { "type": "string" }, - "type": { + "displayType": { "type": "string" }, - "value": { - "type": "number", - "format": "float" + "sortingType": { + "type": "string" }, - "considerAdvancedRules": { + "filterable": { "type": "boolean" }, - "maxValue": { - "type": "number", - "format": "float" - }, - "sorterKey": { - "type": "string" - }, - "applierKey": { - "type": "string" + "visibleOnProductDetailPage": { + "type": "boolean" }, - "usageKey": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, - "pickerKey": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -50310,69 +75245,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { + "options": { "properties": { "links": { "type": "object", @@ -50380,7 +75258,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount/1d292bd1ccb9a6140bb16d3a9217a30c/promotionDiscountPrices" + "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" } } }, @@ -50391,11 +75269,11 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount_prices" + "example": "property_group_option" }, "id": { "type": "string", - "example": "325723473ecab76b0f45e1554513f779" + "example": "93da65a9fd0004d9477aeac024e08e15" } } } @@ -50411,53 +75289,44 @@ } ] }, - "PromotionDiscount": { + "PropertyGroup": { "description": "Added since version: 6.0.0.0", "required": [ - "promotionId", - "scope", - "type", - "value", - "considerAdvancedRules", - "createdAt" + "id", + "displayType", + "sortingType", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "scope": { + "description": { "type": "string" }, - "type": { + "displayType": { "type": "string" }, - "value": { - "type": "number", - "format": "float" + "sortingType": { + "type": "string" }, - "considerAdvancedRules": { + "filterable": { "type": "boolean" }, - "maxValue": { - "type": "number", - "format": "float" - }, - "sorterKey": { - "type": "string" - }, - "applierKey": { - "type": "string" + "visibleOnProductDetailPage": { + "type": "boolean" }, - "usageKey": { - "type": "string" + "position": { + "type": "integer", + "format": "int64" }, - "pickerKey": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -50469,25 +75338,19 @@ "format": "date-time", "readOnly": true }, - "promotion": { - "$ref": "#/components/schemas/Promotion" - }, - "discountRules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" - } + "translated": { + "type": "object" }, - "promotionDiscountPrices": { + "options": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/PropertyGroupOption" } } }, "type": "object" }, - "PromotionDiscountPricesJsonApi": { + "PropertyGroupOptionJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -50495,27 +75358,36 @@ }, { "required": [ - "discountId", - "currencyId", - "price", - "createdAt" + "id", + "groupId", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "discountId": { + "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "colorHexCode": { + "type": "string" + }, + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number", - "format": "float" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -50527,9 +75399,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "promotionDiscount": { + "media": { "properties": { "links": { "type": "object", @@ -50537,7 +75412,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/promotionDiscount" + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/media" } } }, @@ -50546,19 +75421,19 @@ "properties": { "type": { "type": "string", - "example": "promotion_discount" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "eaeedb5c09dfc7dbf130657ed44ef33f" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "currency": { + "group": { "properties": { "links": { "type": "object", @@ -50566,7 +75441,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-discount-prices/bed3b77da61f7bd4ccc1f6d17fa416df/currency" + "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/group" } } }, @@ -50575,12 +75450,105 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "property_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "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" + } } } } @@ -50595,30 +75563,39 @@ } ] }, - "PromotionDiscountPrices": { + "PropertyGroupOption": { "description": "Added since version: 6.0.0.0", "required": [ - "discountId", - "currencyId", - "price", - "createdAt" + "id", + "groupId", + "createdAt", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "discountId": { + "groupId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "name": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "colorHexCode": { + "type": "string" + }, + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number", - "format": "float" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -50630,53 +75607,52 @@ "format": "date-time", "readOnly": true }, - "promotionDiscount": { - "$ref": "#/components/schemas/PromotionDiscount" + "translated": { + "type": "object" }, - "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}$" + "media": { + "$ref": "#/components/schemas/Media" }, - "discountId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "group": { + "$ref": "#/components/schemas/PropertyGroup" }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "productConfiguratorSettings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } }, - "discount": { - "$ref": "#/components/schemas/PromotionDiscount" + "productProperties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "rule": { - "$ref": "#/components/schemas/Rule" + "productOptions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" }, - "PromotionIndividualCodeJsonApi": { - "description": "Added since version: 6.0.0.0", + "QuoteJsonApi": { + "description": "Added since version: 6.5.3.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "promotionId", - "code", + "id", + "stateId", + "currencyId", + "languageId", + "salesChannelId", + "customerId", + "itemRounding", + "totalRounding", "createdAt" ], "properties": { @@ -50684,14 +75660,237 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "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}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "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}$" + }, + "quoteNumber": { "type": "string" }, - "payload": { + "expirationDate": { + "type": "string", + "format": "date-time" + }, + "sentAt": { + "type": "string", + "format": "date-time" + }, + "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" + }, + "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" + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "subtotalNet": { + "type": "number", + "format": "float" + }, + "totalDiscount": { + "type": "number", + "format": "float" + }, + "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" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -50706,7 +75905,36 @@ }, "relationships": { "properties": { - "promotion": { + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "user": { "properties": { "links": { "type": "object", @@ -50714,7 +75942,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-individual-code/139ddd829ed66162c831471f101e3823/promotion" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/user" } } }, @@ -50723,191 +75951,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionIndividualCode": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "currency": { "properties": { "links": { "type": "object", @@ -50915,7 +75971,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/promotion" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/currency" } } }, @@ -50924,19 +75980,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "salesChannel": { + "language": { "properties": { "links": { "type": "object", @@ -50944,7 +76000,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-sales-channel/2081c7fb87ec7bafc7a39bf0e33ebaa8/salesChannel" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/language" } } }, @@ -50953,116 +76009,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "salesChannel": { "properties": { "links": { "type": "object", @@ -51070,7 +76029,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/promotion" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/salesChannel" } } }, @@ -51079,19 +76038,19 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "setGroupRules": { + "createdBy": { "properties": { "links": { "type": "object", @@ -51099,174 +76058,57 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/promotion-setgroup/d2e23a646d2a711e7af57757b8ff7d3f/setGroupRules" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "example": "a54c38d5a1d9180d689d11234afbbb32" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PromotionSetgroup": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "updatedBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "customer": { "properties": { "links": { "type": "object", @@ -51274,151 +76116,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group/28691f41cd50e3065fd221390a457a56/options" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "property_group_option" - }, - "id": { - "type": "string", - "example": "93da65a9fd0004d9477aeac024e08e15" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "PropertyGroup": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "order": { "properties": { "links": { "type": "object", @@ -51426,7 +76145,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/media" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/order" } } }, @@ -51435,19 +76154,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "group": { + "lineItems": { "properties": { "links": { "type": "object", @@ -51455,28 +76174,92 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/group" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/lineItems" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } + } + } + } + }, + "type": "object" + }, + "deliveries": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "property_group" - }, - "id": { + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/deliveries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_delivery" + }, + "id": { + "type": "string", + "example": "6fc31b6b9cd717cc0dcb81152308f8af" + } + } + } + } + }, + "type": "object" + }, + "transactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/transactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_transaction" + }, + "id": { + "type": "string", + "example": "c15b977dd99332ca8623fbdfb86827e8" + } } } } }, "type": "object" }, - "productConfiguratorSettings": { + "comments": { "properties": { "links": { "type": "object", @@ -51484,7 +76267,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productConfiguratorSettings" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/comments" } } }, @@ -51495,11 +76278,11 @@ "properties": { "type": { "type": "string", - "example": "product_configurator_setting" + "example": "quote_comment" }, "id": { "type": "string", - "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + "example": "a5d491060952aa8ad5fdee071be752de" } } } @@ -51507,7 +76290,7 @@ }, "type": "object" }, - "productProperties": { + "quoteEmployees": { "properties": { "links": { "type": "object", @@ -51515,7 +76298,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productProperties" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/quoteEmployees" } } }, @@ -51526,11 +76309,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "quote_employee" }, "id": { "type": "string", - "example": "bacd76b9cbbc26cb9854ec57f4d0fef3" + "example": "2d59101091544ffd9a1d23090d6e2f0a" } } } @@ -51538,7 +76321,7 @@ }, "type": "object" }, - "productOptions": { + "documents": { "properties": { "links": { "type": "object", @@ -51546,7 +76329,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/property-group-option/10f78a0d3f087d9d206956bca1cf72b1/productOptions" + "example": "/quote/c48e929b2b1eabba2ba036884433345e/documents" } } }, @@ -51557,11 +76340,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "quote_document" }, "id": { "type": "string", - "example": "2e96cc7eba692416e31a6af3230ebf88" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -51574,38 +76357,256 @@ } }, "type": "object" - } - ] - }, - "PropertyGroupOption": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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}$" + } + ] + }, + "Quote": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "stateId", + "currencyId", + "languageId", + "salesChannelId", + "customerId", + "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 + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "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}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "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}$" + }, + "quoteNumber": { + "type": "string" + }, + "expirationDate": { + "type": "string", + "format": "date-time" + }, + "sentAt": { + "type": "string", + "format": "date-time" + }, + "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" + }, + "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" + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "subtotalNet": { + "type": "number", + "format": "float" + }, + "totalDiscount": { + "type": "number", + "format": "float" + }, + "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" }, "customFields": { "type": "object" @@ -51620,51 +76621,82 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" }, - "media": { - "$ref": "#/components/schemas/Media" + "user": { + "$ref": "#/components/schemas/User" }, - "group": { - "$ref": "#/components/schemas/PropertyGroup" + "currency": { + "$ref": "#/components/schemas/Currency" }, - "productConfiguratorSettings": { + "language": { + "$ref": "#/components/schemas/Language" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "lineItems": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/QuoteLineItem" } }, - "productProperties": { + "deliveries": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/QuoteDelivery" } }, - "productOptions": { + "transactions": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/QuoteTransaction" + } + }, + "comments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + }, + "quoteEmployees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" } } }, "type": "object" }, - "QuoteJsonApi": { - "description": "Added since version: 6.5.3.0", + "QuoteCommentJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "stateId", - "currencyId", - "languageId", - "salesChannelId", - "customerId", - "itemRounding", - "totalRounding", + "id", + "comment", + "quoteId", "createdAt" ], "properties": { @@ -51676,36 +76708,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "comment": { + "type": "string" }, - "languageId": { + "seenAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "salesChannelId": { + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -51713,192 +76731,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteNumber": { - "type": "string" - }, - "expirationDate": { - "type": "string", - "format": "date-time" - }, - "sentAt": { - "type": "string", - "format": "date-time" - }, - "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" - }, - "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" - }, - "discount": { - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "taxStatus": { - "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true - }, - "subtotalNet": { - "type": "number", - "format": "float" - }, - "totalDiscount": { - "type": "number", - "format": "float" - }, - "originalPrice": { - "type": "number", - "format": "float" - }, - "itemRounding": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -51911,7 +76747,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "quote": { "properties": { "links": { "type": "object", @@ -51919,7 +76755,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/stateMachineState" + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/quote" } } }, @@ -51928,19 +76764,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, - "user": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -51948,7 +76784,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/user" + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/stateMachineState" } } }, @@ -51957,19 +76793,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "currency": { + "customer": { "properties": { "links": { "type": "object", @@ -51977,7 +76813,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/currency" + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/customer" } } }, @@ -51986,19 +76822,19 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "language": { + "createdBy": { "properties": { "links": { "type": "object", @@ -52006,7 +76842,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/language" + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/createdBy" } } }, @@ -52015,106 +76851,211 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" - }, - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/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" + } + ] + }, + "QuoteComment": { + "required": [ + "id", + "comment", + "quoteId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "comment": { + "type": "string" + }, + "seenAt": { + "type": "string", + "format": "date-time" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "quote": { + "$ref": "#/components/schemas/Quote" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "QuoteDeliveryJsonApi": { + "description": "Added since version: 6.5.3.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "quoteId", + "shippingMethodId", + "shippingDateEarliest", + "shippingDateLatest", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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" }, - "createdBy": { + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/createdBy" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "updatedBy": { + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/updatedBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "customer": { + } + }, + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "quote": { "properties": { "links": { "type": "object", @@ -52122,7 +77063,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/customer" + "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/quote" } } }, @@ -52131,19 +77072,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, - "order": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -52151,7 +77092,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/order" + "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/shippingMethod" } } }, @@ -52160,19 +77101,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "lineItems": { + "positions": { "properties": { "links": { "type": "object", @@ -52180,7 +77121,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/lineItems" + "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/positions" } } }, @@ -52191,81 +77132,273 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "quote_delivery_position" }, "id": { "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" + "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "QuoteDelivery": { + "description": "Added since version: 6.5.3.0", + "required": [ + "id", + "quoteId", + "shippingMethodId", + "shippingDateEarliest", + "shippingDateLatest", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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" }, - "deliveries": { + "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 + }, + "quote": { + "$ref": "#/components/schemas/Quote" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + }, + "type": "object" + }, + "QuoteDeliveryPositionJsonApi": { + "description": "Added since version: 6.5.3.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "quoteDeliveryId", + "quoteLineItemId", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteLineItemVersionId": { + "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": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/deliveries" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_delivery" - }, - "id": { - "type": "string", - "example": "6fc31b6b9cd717cc0dcb81152308f8af" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "transactions": { + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/transactions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_transaction" - }, - "id": { - "type": "string", - "example": "c15b977dd99332ca8623fbdfb86827e8" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "comments": { + } + }, + "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": { + "quoteDelivery": { "properties": { "links": { "type": "object", @@ -52273,30 +77406,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/comments" + "example": "/quote-delivery-position/9bccead7211d7f905df800ef90888f07/quoteDelivery" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_comment" - }, - "id": { - "type": "string", - "example": "a5d491060952aa8ad5fdee071be752de" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_delivery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "19397469743ae5505500cb3fa99bc0b1" } } } }, "type": "object" }, - "quoteEmployees": { + "quoteLineItem": { "properties": { "links": { "type": "object", @@ -52304,23 +77435,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote/c48e929b2b1eabba2ba036884433345e/quoteEmployees" + "example": "/quote-delivery-position/9bccead7211d7f905df800ef90888f07/quoteLineItem" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_employee" - }, - "id": { - "type": "string", - "example": "2d59101091544ffd9a1d23090d6e2f0a" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "dbe619b4a557266e76679178cc13085b" } } } @@ -52335,121 +77464,40 @@ } ] }, - "Quote": { + "QuoteDeliveryPosition": { "description": "Added since version: 6.5.3.0", "required": [ - "stateId", - "currencyId", - "languageId", - "salesChannelId", - "customerId", - "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 - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { + "id", + "quoteDeliveryId", + "quoteLineItemId", + "createdAt" + ], + "properties": { + "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createdById": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "updatedById": { + "quoteDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "quoteDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "quoteLineItemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "quoteLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteNumber": { - "type": "string" - }, - "expirationDate": { - "type": "string", - "format": "date-time" - }, - "sentAt": { - "type": "string", - "format": "date-time" - }, "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" - }, - "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -52506,75 +77554,17 @@ }, "type": "object" }, - "discount": { - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "number", - "format": "float" - } - }, - "type": "object" - }, - "taxStatus": { - "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true - }, - "subtotalNet": { - "type": "number", - "format": "float" - }, - "totalDiscount": { + "unitPrice": { "type": "number", "format": "float" }, - "originalPrice": { + "totalPrice": { "type": "number", "format": "float" }, - "itemRounding": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" - }, - "totalRounding": { - "properties": { - "decimals": { - "type": "integer", - "format": "int64" - }, - "interval": { - "type": "number", - "format": "float" - }, - "roundForNet": { - "type": "boolean" - } - }, - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" @@ -52589,75 +77579,28 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "user": { - "$ref": "#/components/schemas/User" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteLineItem" - } - }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteDelivery" - } - }, - "transactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteTransaction" - } - }, - "comments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteComment" - } + "quoteDelivery": { + "$ref": "#/components/schemas/QuoteDelivery" }, - "quoteEmployees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/QuoteEmployee" - } + "quoteLineItem": { + "$ref": "#/components/schemas/QuoteLineItem" } }, "type": "object" }, - "QuoteCommentJsonApi": { + "QuoteDocumentJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "comment", + "id", + "documentTypeId", + "fileType", "quoteId", + "config", + "deepLinkCode", "createdAt" ], "properties": { @@ -52669,12 +77612,15 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "comment": { + "documentNumber": { "type": "string" }, - "seenAt": { + "documentTypeId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" + }, + "fileType": { + "type": "string" }, "quoteId": { "type": "string", @@ -52684,18 +77630,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "config": { + "type": "object" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "sent": { + "type": "boolean" }, - "createdById": { + "static": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -52708,6 +77664,35 @@ }, "relationships": { "properties": { + "documentType": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/documentType" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" + } + } + } + }, + "type": "object" + }, "quote": { "properties": { "links": { @@ -52716,7 +77701,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/quote" + "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/quote" } } }, @@ -52737,7 +77722,7 @@ }, "type": "object" }, - "stateMachineState": { + "documentMediaFile": { "properties": { "links": { "type": "object", @@ -52745,7 +77730,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/stateMachineState" + "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/documentMediaFile" } } }, @@ -52754,19 +77739,161 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "ac7db1e6be481d6422fc63700e08279d" } } } }, "type": "object" - }, - "customer": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "QuoteDocument": { + "required": [ + "id", + "documentTypeId", + "fileType", + "quoteId", + "config", + "deepLinkCode", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentNumber": { + "type": "string" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fileType": { + "type": "string" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "type": "object" + }, + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "active": { + "type": "boolean" + }, + "deepLinkCode": { + "type": "string" + }, + "documentMediaFileId": { + "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 + }, + "documentType": { + "$ref": "#/components/schemas/DocumentType" + }, + "quote": { + "$ref": "#/components/schemas/Quote" + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "QuoteEmployeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "quoteId", + "employeeId", + "firstName", + "lastName", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "quoteVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "quote": { "properties": { "links": { "type": "object", @@ -52774,7 +77901,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/customer" + "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/quote" } } }, @@ -52783,19 +77910,19 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, - "createdBy": { + "employee": { "properties": { "links": { "type": "object", @@ -52803,7 +77930,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/createdBy" + "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/employee" } } }, @@ -52812,12 +77939,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } @@ -52832,10 +77959,13 @@ } ] }, - "QuoteComment": { + "QuoteEmployee": { "required": [ - "comment", + "id", "quoteId", + "employeeId", + "firstName", + "lastName", "createdAt" ], "properties": { @@ -52847,13 +77977,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "comment": { - "type": "string" - }, - "seenAt": { - "type": "string", - "format": "date-time" - }, "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -52862,17 +77985,15 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "firstName": { + "type": "string" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "lastName": { + "type": "string" }, "createdAt": { "type": "string", @@ -52887,19 +78008,13 @@ "quote": { "$ref": "#/components/schemas/Quote" }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "createdBy": { - "$ref": "#/components/schemas/User" + "employee": { + "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, - "QuoteDeliveryJsonApi": { + "QuoteLineItemJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { @@ -52907,10 +78022,15 @@ }, { "required": [ + "id", "quoteId", - "shippingMethodId", - "shippingDateEarliest", - "shippingDateLatest", + "identifier", + "children", + "states", + "label", + "quantity", + "price", + "position", "createdAt" ], "properties": { @@ -52930,19 +78050,64 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "identifier": { + "type": "string" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "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}$", + "readOnly": true + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" }, - "shippingDateEarliest": { - "type": "string", - "format": "date-time" + "totalPrice": { + "type": "number", + "format": "float" }, - "shippingDateLatest": { - "type": "string", - "format": "date-time" + "priceDefinition": { + "type": "object" }, - "shippingCosts": { + "price": { "required": [ "unitPrice", "totalPrice", @@ -52999,6 +78164,44 @@ }, "type": "object" }, + "productPrice": { + "type": "object" + }, + "purchasePrice": { + "type": "object" + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "good": { + "type": "boolean" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "referencedId": { + "type": "string" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -53022,7 +78225,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/quote" + "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/quote" } } }, @@ -53043,7 +78246,7 @@ }, "type": "object" }, - "shippingMethod": { + "parent": { "properties": { "links": { "type": "object", @@ -53051,7 +78254,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/shippingMethod" + "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/parent" } } }, @@ -53060,19 +78263,19 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "quote_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "positions": { + "children": { "properties": { "links": { "type": "object", @@ -53080,7 +78283,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-delivery/d2e61366180daeec11fe88b1cb03bbd6/positions" + "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/children" } } }, @@ -53091,17 +78294,104 @@ "properties": { "type": { "type": "string", - "example": "quote_delivery_position" + "example": "quote_line_item" }, "id": { "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" + "example": "268184c12df027f536154d099d497b31" } } } } }, "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/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": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/promotion" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + } + } + } + }, + "type": "object" + }, + "cover": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/cover" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "41d0e299ca1abeb2094852da042165c7" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -53111,13 +78401,18 @@ } ] }, - "QuoteDelivery": { + "QuoteLineItem": { "description": "Added since version: 6.5.3.0", "required": [ + "id", "quoteId", - "shippingMethodId", - "shippingDateEarliest", - "shippingDateLatest", + "identifier", + "children", + "states", + "label", + "quantity", + "price", + "position", "createdAt" ], "properties": { @@ -53137,19 +78432,64 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "identifier": { + "type": "string" + }, + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingDateEarliest": { + "parentVersionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "shippingDateLatest": { + "productId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "shippingCosts": { + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "readOnly": true + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "payload": { + "type": "object" + }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "priceDefinition": { + "type": "object" + }, + "price": { "required": [ "unitPrice", "totalPrice", @@ -53206,6 +78546,44 @@ }, "type": "object" }, + "productPrice": { + "type": "object" + }, + "purchasePrice": { + "type": "object" + }, + "discount": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "good": { + "type": "boolean" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "referencedId": { + "type": "string" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -53222,19 +78600,28 @@ "quote": { "$ref": "#/components/schemas/Quote" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "parent": { + "$ref": "#/components/schemas/QuoteLineItem" }, - "positions": { + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteLineItem" } + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "promotion": { + "$ref": "#/components/schemas/Promotion" + }, + "cover": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "QuoteDeliveryPositionJsonApi": { + "QuoteTransactionJsonApi": { "description": "Added since version: 6.5.3.0", "allOf": [ { @@ -53242,8 +78629,10 @@ }, { "required": [ - "quoteDeliveryId", - "quoteLineItemId", + "id", + "quoteId", + "paymentMethodId", + "amount", "createdAt" ], "properties": { @@ -53255,23 +78644,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteDeliveryVersionId": { + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteLineItemId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteLineItemVersionId": { + "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { + "amount": { "required": [ "unitPrice", "totalPrice", @@ -53328,18 +78713,6 @@ }, "type": "object" }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "customFields": { "type": "object" }, @@ -53355,7 +78728,7 @@ }, "relationships": { "properties": { - "quoteDelivery": { + "quote": { "properties": { "links": { "type": "object", @@ -53363,7 +78736,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-delivery-position/9bccead7211d7f905df800ef90888f07/quoteDelivery" + "example": "/quote-transaction/ace75e8d17b730e2c18557ab7ea8abeb/quote" } } }, @@ -53372,19 +78745,19 @@ "properties": { "type": { "type": "string", - "example": "quote_delivery" + "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "19397469743ae5505500cb3fa99bc0b1" + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" } } } }, "type": "object" }, - "quoteLineItem": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -53392,7 +78765,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-delivery-position/9bccead7211d7f905df800ef90888f07/quoteLineItem" + "example": "/quote-transaction/ace75e8d17b730e2c18557ab7ea8abeb/paymentMethod" } } }, @@ -53401,12 +78774,12 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "dbe619b4a557266e76679178cc13085b" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } @@ -53421,11 +78794,13 @@ } ] }, - "QuoteDeliveryPosition": { + "QuoteTransaction": { "description": "Added since version: 6.5.3.0", "required": [ - "quoteDeliveryId", - "quoteLineItemId", + "id", + "quoteId", + "paymentMethodId", + "amount", "createdAt" ], "properties": { @@ -53437,23 +78812,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteDeliveryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteDeliveryVersionId": { + "quoteId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteLineItemId": { + "quoteVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteLineItemVersionId": { + "paymentMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { + "amount": { "required": [ "unitPrice", "totalPrice", @@ -53510,18 +78881,6 @@ }, "type": "object" }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "customFields": { "type": "object" }, @@ -53535,26 +78894,26 @@ "format": "date-time", "readOnly": true }, - "quoteDelivery": { - "$ref": "#/components/schemas/QuoteDelivery" + "quote": { + "$ref": "#/components/schemas/Quote" }, - "quoteLineItem": { - "$ref": "#/components/schemas/QuoteLineItem" + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "QuoteEmployeeJsonApi": { + "RuleJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "quoteId", - "employeeId", - "firstName", - "lastName", + "id", + "name", + "priority", "createdAt" ], "properties": { @@ -53562,27 +78921,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "invalid": { + "type": "boolean", + "readOnly": true }, - "firstName": { - "type": "string" + "areas": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true }, - "lastName": { - "type": "string" + "customFields": { + "type": "object" + }, + "moduleTypes": { + "type": "object" }, "createdAt": { "type": "string", @@ -53594,9 +78959,107 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "subscriptionPlans": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } + } + }, + "type": "object" + }, + "subscriptionIntervals": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionIntervals" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_interval" + }, + "id": { + "type": "string", + "example": "28e0fbf8d26aa147681d2241c60ef075" + } + } + } + } + }, + "type": "object" + }, + "warehouseGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "1768e3071b62161d415e0c24332055ed" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { - "quote": { + "conditions": { "properties": { "links": { "type": "object", @@ -53604,28 +79067,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/quote" + "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": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + "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" }, - "employee": { + "shippingMethodPrices": { "properties": { "links": { "type": "object", @@ -53633,292 +79129,123 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-employee/e4bf66af05d85640412ac7a8951252a3/employee" + "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": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "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" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "QuoteEmployee": { - "required": [ - "quoteId", - "employeeId", - "firstName", - "lastName", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "quote": { - "$ref": "#/components/schemas/Quote" - }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" - } - }, - "type": "object" - }, - "QuoteLineItemJsonApi": { - "description": "Added since version: 6.5.3.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "quoteId", - "identifier", - "children", - "states", - "label", - "quantity", - "price", - "position", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { - "type": "string" - }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "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}$", - "readOnly": true - }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" - }, - "payload": { - "type": "object" - }, - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "priceDefinition": { - "type": "object" - }, - "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": { + "shippingMethods": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "paymentMethods": { "properties": { - "price": { - "type": "number", - "format": "float" + "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" - } - }, - "type": "object" - }, - "productPrice": { - "type": "object" - }, - "purchasePrice": { - "type": "object" - }, - "discount": { - "properties": { - "type": { - "type": "string" }, - "value": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "good": { - "type": "boolean" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "referencedId": { - "type": "string" - }, - "coverId": { - "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": { - "quote": { + "personaPromotions": { "properties": { "links": { "type": "object", @@ -53926,28 +79253,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/quote" + "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": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + "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" }, - "parent": { + "taxProviders": { "properties": { "links": { "type": "object", @@ -53955,28 +79315,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/parent" + "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": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "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" }, - "children": { + "orderPromotions": { "properties": { "links": { "type": "object", @@ -53984,7 +79377,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/children" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/orderPromotions" } } }, @@ -53995,11 +79388,11 @@ "properties": { "type": { "type": "string", - "example": "quote_line_item" + "example": "promotion" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "82dea0f7981e729cd7f6303cc8a1c499" } } } @@ -54007,7 +79400,7 @@ }, "type": "object" }, - "product": { + "cartPromotions": { "properties": { "links": { "type": "object", @@ -54015,28 +79408,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/product" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/cartPromotions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion" + }, + "id": { + "type": "string", + "example": "2ce52c5be33293c67fb55f29fa4046a7" + } } } } }, "type": "object" }, - "promotion": { + "promotionDiscounts": { "properties": { "links": { "type": "object", @@ -54044,28 +79439,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/promotion" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionDiscounts" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_discount" + }, + "id": { + "type": "string", + "example": "3ddb3f7d5ec4f032dc51f294409b68f9" + } } } } }, "type": "object" }, - "cover": { + "promotionSetGroups": { "properties": { "links": { "type": "object", @@ -54073,21 +79470,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/cover" + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionSetGroups" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_setgroup" + }, + "id": { + "type": "string", + "example": "b71b82231d40fdedf42133c0e71384f8" + } } } } @@ -54102,17 +79501,12 @@ } ] }, - "QuoteLineItem": { - "description": "Added since version: 6.5.3.0", + "Rule": { + "description": "Added since version: 6.0.0.0", "required": [ - "quoteId", - "identifier", - "children", - "states", - "label", - "quantity", - "price", - "position", + "id", + "name", + "priority", "createdAt" ], "properties": { @@ -54120,125 +79514,135 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "identifier": { + "name": { "type": "string" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "parentVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priority": { + "type": "integer", + "format": "int64" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" }, - "promotionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", + "invalid": { + "type": "boolean", "readOnly": true }, - "states": { + "areas": { "type": "array", "items": { - "type": "string" - } - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" + "type": "object", + "additionalProperties": false + }, + "readOnly": true }, - "payload": { + "customFields": { "type": "object" }, - "unitPrice": { - "type": "number", - "format": "float" + "moduleTypes": { + "type": "object" }, - "totalPrice": { - "type": "number", - "format": "float" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "priceDefinition": { - "type": "object" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "price": { - "required": [ - "unitPrice", - "totalPrice", - "quantity" - ], + "extensions": { "properties": { - "unitPrice": { - "type": "number", - "format": "float" - }, - "totalPrice": { - "type": "number", - "format": "float" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, - "calculatedTaxes": { - "type": "object" - }, - "taxRules": { - "type": "object" - }, - "referencePrice": { + "subscriptionPlans": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } + } + }, "type": "object" }, - "listPrice": { + "subscriptionIntervals": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionIntervals" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_interval" + }, + "id": { + "type": "string", + "example": "28e0fbf8d26aa147681d2241c60ef075" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "warehouseGroup": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "1768e3071b62161d415e0c24332055ed" + } + } + } } }, "type": "object" @@ -54246,172 +79650,133 @@ }, "type": "object" }, - "productPrice": { - "type": "object" - }, - "purchasePrice": { - "type": "object" - }, - "discount": { - "properties": { - "type": { - "type": "string" - }, - "value": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "good": { - "type": "boolean" - }, - "removable": { - "type": "boolean" + "conditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } }, - "stackable": { - "type": "boolean" + "productPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } }, - "position": { - "type": "integer", - "format": "int64" + "shippingMethodPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } }, - "referencedId": { - "type": "string" + "shippingMethodPriceCalculations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } }, - "coverId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } }, - "customFields": { - "type": "object" + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "personaPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } }, - "quote": { - "$ref": "#/components/schemas/Quote" + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } }, - "parent": { - "$ref": "#/components/schemas/QuoteLineItem" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "children": { + "orderPromotions": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/Promotion" } }, - "product": { - "$ref": "#/components/schemas/Product" + "cartPromotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } }, - "promotion": { - "$ref": "#/components/schemas/Promotion" + "promotionDiscounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } }, - "cover": { - "$ref": "#/components/schemas/Media" + "promotionSetGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } } }, "type": "object" }, - "QuoteTransactionJsonApi": { - "description": "Added since version: 6.5.3.0", + "RuleConditionJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, - { - "required": [ - "quoteId", - "paymentMethodId", - "amount", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quoteVersionId": { - "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" - } - }, + { + "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" }, @@ -54427,7 +79792,7 @@ }, "relationships": { "properties": { - "quote": { + "rule": { "properties": { "links": { "type": "object", @@ -54435,7 +79800,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-transaction/ace75e8d17b730e2c18557ab7ea8abeb/quote" + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" } } }, @@ -54444,19 +79809,19 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, - "paymentMethod": { + "appScriptCondition": { "properties": { "links": { "type": "object", @@ -54464,7 +79829,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/quote-transaction/ace75e8d17b730e2c18557ab7ea8abeb/paymentMethod" + "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/appScriptCondition" } } }, @@ -54473,12 +79838,72 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "app_script_condition" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "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" + } } } } @@ -54493,12 +79918,12 @@ } ] }, - "QuoteTransaction": { - "description": "Added since version: 6.5.3.0", + "RuleCondition": { + "description": "Added since version: 6.0.0.0", "required": [ - "quoteId", - "paymentMethodId", - "amount", + "id", + "type", + "ruleId", "createdAt" ], "properties": { @@ -54506,79 +79931,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": { + "type": "string" }, - "quoteId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quoteVersionId": { + "scriptId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "parentId": { "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" - } - }, + "value": { "type": "object" }, + "position": { + "type": "integer", + "format": "int64" + }, "customFields": { "type": "object" }, @@ -54592,16 +79966,53 @@ "format": "date-time", "readOnly": true }, - "quote": { - "$ref": "#/components/schemas/Quote" + "rule": { + "$ref": "#/components/schemas/Rule" }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "appScriptCondition": { + "$ref": "#/components/schemas/AppScriptCondition" + }, + "parent": { + "$ref": "#/components/schemas/RuleCondition" + }, + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } } }, "type": "object" }, - "RuleJsonApi": { + "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": [ { @@ -54609,185 +80020,177 @@ }, { "required": [ + "id", + "typeId", + "languageId", + "customerGroupId", + "currencyId", + "paymentMethodId", + "shippingMethodId", + "countryId", + "navigationCategoryId", + "accessKey", + "createdAt", "name", - "priority", - "createdAt" + "homeEnabled" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "typeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "priority": { + "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" }, - "description": { + "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" }, - "invalid": { - "type": "boolean", - "readOnly": true + "shortName": { + "type": "string" }, - "areas": { + "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 - }, - "readOnly": true + } }, "customFields": { "type": "object" }, - "moduleTypes": { - "type": "object" + "paymentMethodIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true }, - "createdAt": { + "homeCmsPageId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "homeCmsPageVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "extensions": { - "properties": { - "subscriptionPlans": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionPlans" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_plan" - }, - "id": { - "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" - } - } - } - } - }, - "type": "object" - }, - "subscriptionIntervals": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionIntervals" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_interval" - }, - "id": { - "type": "string", - "example": "28e0fbf8d26aa147681d2241c60ef075" - } - } - } - } - }, - "type": "object" - }, - "warehouseGroup": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "1768e3071b62161d415e0c24332055ed" - } - } - } - } - }, - "type": "object" - } - }, + "homeSlotConfig": { "type": "object" }, - "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": { + "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", @@ -54795,7 +80198,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/productPrices" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" } } }, @@ -54806,11 +80209,11 @@ "properties": { "type": { "type": "string", - "example": "product_price" + "example": "theme" }, "id": { "type": "string", - "example": "186169119da6d813def53830287d0b9a" + "example": "fe021943dcda87150f590b3475afaded" } } } @@ -54818,7 +80221,7 @@ }, "type": "object" }, - "shippingMethodPrices": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -54826,7 +80229,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPrices" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/subscriptions" } } }, @@ -54837,11 +80240,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method_price" + "example": "subscription" }, "id": { "type": "string", - "example": "3702bcc7b41585828b44acbbdcd83b23" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -54849,7 +80252,7 @@ }, "type": "object" }, - "shippingMethodPriceCalculations": { + "quotes": { "properties": { "links": { "type": "object", @@ -54857,7 +80260,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethodPriceCalculations" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/quotes" } } }, @@ -54868,19 +80271,24 @@ "properties": { "type": { "type": "string", - "example": "shipping_method_price" + "example": "quote" }, "id": { "type": "string", - "example": "b8ea8aac272229a90f9a6cb1fcada8d1" + "example": "2150fd65034a9bcdb357943b3900a918" } } } } }, "type": "object" - }, - "shippingMethods": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "currencies": { "properties": { "links": { "type": "object", @@ -54888,7 +80296,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/shippingMethods" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currencies" } } }, @@ -54899,11 +80307,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "currency" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "7f24d9fc4140045241b3f97bcf36bf03" } } } @@ -54911,7 +80319,7 @@ }, "type": "object" }, - "paymentMethods": { + "languages": { "properties": { "links": { "type": "object", @@ -54919,7 +80327,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/paymentMethods" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/languages" } } }, @@ -54930,11 +80338,11 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "language" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "f3e334d42863e8250c7d03efefbfd387" } } } @@ -54942,7 +80350,7 @@ }, "type": "object" }, - "personaPromotions": { + "countries": { "properties": { "links": { "type": "object", @@ -54950,7 +80358,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/personaPromotions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/countries" } } }, @@ -54961,11 +80369,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "country" }, "id": { "type": "string", - "example": "e6c8f116c04f26f18410d2d0dbd677db" + "example": "71bee43a7a930f904d6194833b9619c9" } } } @@ -54973,7 +80381,7 @@ }, "type": "object" }, - "flowSequences": { + "paymentMethods": { "properties": { "links": { "type": "object", @@ -54981,7 +80389,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/flowSequences" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethods" } } }, @@ -54992,11 +80400,11 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "payment_method" }, "id": { "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + "example": "b631b1ab565525e892f9cdc1242cca14" } } } @@ -55004,7 +80412,7 @@ }, "type": "object" }, - "taxProviders": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -55012,7 +80420,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/taxProviders" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethods" } } }, @@ -55023,11 +80431,11 @@ "properties": { "type": { "type": "string", - "example": "tax_provider" + "example": "shipping_method" }, "id": { "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" + "example": "8268b0a6c902fbde485094c2f627b854" } } } @@ -55035,7 +80443,7 @@ }, "type": "object" }, - "tags": { + "type": { "properties": { "links": { "type": "object", @@ -55043,61 +80451,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/tags" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/type" } } }, "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": { "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" - } + "example": "sales_channel_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, - "cartPromotions": { + "language": { "properties": { "links": { "type": "object", @@ -55105,30 +80480,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/cartPromotions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/language" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion" - }, - "id": { - "type": "string", - "example": "2ce52c5be33293c67fb55f29fa4046a7" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "promotionDiscounts": { + "customerGroup": { "properties": { "links": { "type": "object", @@ -55136,30 +80509,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionDiscounts" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroup" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion_discount" - }, - "id": { - "type": "string", - "example": "3ddb3f7d5ec4f032dc51f294409b68f9" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, - "promotionSetGroups": { + "currency": { "properties": { "links": { "type": "object", @@ -55167,327 +80538,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/promotionSetGroups" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currency" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion_setgroup" - }, - "id": { - "type": "string", - "example": "b71b82231d40fdedf42133c0e71384f8" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "currency" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Rule": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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 - }, - "extensions": { - "properties": { - "subscriptionPlans": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionPlans" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_plan" - }, - "id": { - "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" - } - } - } - } - }, - "type": "object" - }, - "subscriptionIntervals": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/subscriptionIntervals" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_interval" - }, - "id": { - "type": "string", - "example": "28e0fbf8d26aa147681d2241c60ef075" - } - } - } - } - }, - "type": "object" - }, - "warehouseGroup": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/warehouseGroup" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "1768e3071b62161d415e0c24332055ed" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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": [ - "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": { + "paymentMethod": { "properties": { "links": { "type": "object", @@ -55495,7 +80567,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/rule" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethod" } } }, @@ -55504,19 +80576,19 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, - "appScriptCondition": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -55524,7 +80596,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/appScriptCondition" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethod" } } }, @@ -55533,19 +80605,19 @@ "properties": { "type": { "type": "string", - "example": "app_script_condition" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d84ccced9bafd192ec0c6b5a8a49bc07" + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "parent": { + "country": { "properties": { "links": { "type": "object", @@ -55553,7 +80625,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/parent" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/country" } } }, @@ -55562,19 +80634,19 @@ "properties": { "type": { "type": "string", - "example": "rule_condition" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "children": { + "orders": { "properties": { "links": { "type": "object", @@ -55582,7 +80654,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/rule-condition/5e1af56f1ebb8e4b634d38961afe4930/children" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/orders" } } }, @@ -55593,297 +80665,19 @@ "properties": { "type": { "type": "string", - "example": "rule_condition" + "example": "order" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "12c500ed0b7879105fb46af0f246be87" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "RuleCondition": { - "description": "Added since version: 6.0.0.0", - "required": [ - "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": [ - "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": { + }, + "customers": { "properties": { "links": { "type": "object", @@ -55891,7 +80685,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/themes" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customers" } } }, @@ -55902,11 +80696,11 @@ "properties": { "type": { "type": "string", - "example": "theme" + "example": "customer" }, "id": { "type": "string", - "example": "fe021943dcda87150f590b3475afaded" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -55914,7 +80708,7 @@ }, "type": "object" }, - "subscriptions": { + "homeCmsPage": { "properties": { "links": { "type": "object", @@ -55922,30 +80716,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/subscriptions" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/homeCmsPage" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "00bba78f79ca4792a3162942ac65c768" } } } }, "type": "object" }, - "quotes": { + "domains": { "properties": { "links": { "type": "object", @@ -55953,7 +80745,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/quotes" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/domains" } } }, @@ -55964,24 +80756,19 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "e4e46deb7f9cc58c7abfb32e5570b6f3" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "currencies": { + }, + "systemConfigs": { "properties": { "links": { "type": "object", @@ -55989,7 +80776,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currencies" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/systemConfigs" } } }, @@ -56000,11 +80787,11 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "system_config" }, "id": { "type": "string", - "example": "7f24d9fc4140045241b3f97bcf36bf03" + "example": "dbcfb7a885e393eeb296543d06485547" } } } @@ -56012,7 +80799,7 @@ }, "type": "object" }, - "languages": { + "navigationCategory": { "properties": { "links": { "type": "object", @@ -56020,30 +80807,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/languages" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/navigationCategory" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "example": "f3e334d42863e8250c7d03efefbfd387" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2194fe03b676158bb7a3a03f1b98b80e" } } } }, "type": "object" }, - "countries": { + "footerCategory": { "properties": { "links": { "type": "object", @@ -56051,30 +80836,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/countries" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/footerCategory" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "example": "71bee43a7a930f904d6194833b9619c9" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a609a222a2767cf322ee21d72a0ddb3e" } } } }, "type": "object" }, - "paymentMethods": { + "serviceCategory": { "properties": { "links": { "type": "object", @@ -56082,30 +80865,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethods" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/serviceCategory" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bc70a595d052072b5d94cffea6d8d5bb" } } } }, "type": "object" }, - "shippingMethods": { + "productVisibilities": { "properties": { "links": { "type": "object", @@ -56113,7 +80894,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethods" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productVisibilities" } } }, @@ -56124,11 +80905,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "product_visibility" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "a3534dc8df51f93286fcf577a5f8b153" } } } @@ -56136,7 +80917,7 @@ }, "type": "object" }, - "type": { + "hreflangDefaultDomain": { "properties": { "links": { "type": "object", @@ -56144,7 +80925,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/type" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/hreflangDefaultDomain" } } }, @@ -56153,19 +80934,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_type" + "example": "sales_channel_domain" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "599dcce2998a6b40b1e38e8c6006cb0a" + "example": "7e80830860b9b8e5b8fc8d67262680b5" } } } }, "type": "object" }, - "language": { + "mailHeaderFooter": { "properties": { "links": { "type": "object", @@ -56173,7 +80954,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/language" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mailHeaderFooter" } } }, @@ -56182,19 +80963,81 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "mail_header_footer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "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" }, - "customerGroup": { + "promotionSalesChannels": { "properties": { "links": { "type": "object", @@ -56202,28 +81045,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroup" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/promotionSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "115091b01a7299f28a5ce7e1b712a222" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "promotion_sales_channel" + }, + "id": { + "type": "string", + "example": "ede6dfd9f261361e1f3ada8c5385d064" + } } } } }, "type": "object" }, - "currency": { + "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", @@ -56231,28 +81076,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/currency" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/documentBaseConfigSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "9c990fde5b38ff70fc1a07bf84c12a17" + } } } } }, "type": "object" }, - "paymentMethod": { + "productReviews": { "properties": { "links": { "type": "object", @@ -56260,28 +81107,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/paymentMethod" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviews" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review" + }, + "id": { + "type": "string", + "example": "01e78541ea343ed72424a5222796a4cd" + } } } } }, "type": "object" }, - "shippingMethod": { + "seoUrls": { "properties": { "links": { "type": "object", @@ -56289,28 +81138,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shippingMethod" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrls" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } } } } }, "type": "object" }, - "country": { + "seoUrlTemplates": { "properties": { "links": { "type": "object", @@ -56318,28 +81169,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/country" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrlTemplates" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url_template" + }, + "id": { + "type": "string", + "example": "02cde325fef3e680f529875e8abd60bb" + } } } } }, "type": "object" }, - "orders": { + "mainCategories": { "properties": { "links": { "type": "object", @@ -56347,7 +81200,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/orders" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mainCategories" } } }, @@ -56358,11 +81211,11 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "main_category" }, "id": { "type": "string", - "example": "12c500ed0b7879105fb46af0f246be87" + "example": "1fb731fc4139cbb575429e28846f0c39" } } } @@ -56370,7 +81223,7 @@ }, "type": "object" }, - "customers": { + "productExports": { "properties": { "links": { "type": "object", @@ -56378,7 +81231,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customers" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" } } }, @@ -56389,11 +81242,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "product_export" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "2cd8793787cda582174c0fc329fbc377" } } } @@ -56401,7 +81254,7 @@ }, "type": "object" }, - "homeCmsPage": { + "analytics": { "properties": { "links": { "type": "object", @@ -56409,7 +81262,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/homeCmsPage" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/analytics" } } }, @@ -56418,19 +81271,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "sales_channel_analytics" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "00bba78f79ca4792a3162942ac65c768" + "example": "68c4283db8074b12df1660b31c0220a9" } } } }, "type": "object" }, - "domains": { + "customerGroupsRegistrations": { "properties": { "links": { "type": "object", @@ -56438,7 +81291,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/domains" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroupsRegistrations" } } }, @@ -56449,11 +81302,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "customer_group" }, "id": { "type": "string", - "example": "e4e46deb7f9cc58c7abfb32e5570b6f3" + "example": "ea52a61e886aa27d777ef201c6fb7fff" } } } @@ -56461,7 +81314,7 @@ }, "type": "object" }, - "systemConfigs": { + "landingPages": { "properties": { "links": { "type": "object", @@ -56469,7 +81322,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/systemConfigs" + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/landingPages" } } }, @@ -56480,11 +81333,11 @@ "properties": { "type": { "type": "string", - "example": "system_config" + "example": "landing_page" }, "id": { "type": "string", - "example": "dbcfb7a885e393eeb296543d06485547" + "example": "d60b77f2b3bd69591e3d5e3100926b4d" } } } @@ -56492,7 +81345,7 @@ }, "type": "object" }, - "navigationCategory": { + "boundCustomers": { "properties": { "links": { "type": "object", @@ -56500,28 +81353,561 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/navigationCategory" + "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": { - "type": { - "type": "string", - "example": "category" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2194fe03b676158bb7a3a03f1b98b80e" + "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" + } + } }, - "footerCategory": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "fe021943dcda87150f590b3475afaded" + } + } + } + } + }, + "type": "object" + }, + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "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", @@ -56529,7 +81915,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/footerCategory" + "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/salesChannel" } } }, @@ -56538,19 +81924,180 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "a609a222a2767cf322ee21d72a0ddb3e" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" - }, - "serviceCategory": { + } + }, + "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", @@ -56558,7 +82105,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/serviceCategory" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannel" } } }, @@ -56567,50 +82114,19 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "sales_channel" }, "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" - } + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "hreflangDefaultDomain": { + "language": { "properties": { "links": { "type": "object", @@ -56618,7 +82134,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/hreflangDefaultDomain" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" } } }, @@ -56627,19 +82143,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7e80830860b9b8e5b8fc8d67262680b5" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "mailHeaderFooter": { + "currency": { "properties": { "links": { "type": "object", @@ -56647,7 +82163,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mailHeaderFooter" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/currency" } } }, @@ -56656,81 +82172,19 @@ "properties": { "type": { "type": "string", - "example": "mail_header_footer" + "example": "currency" }, "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" - } + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "promotionSalesChannels": { + "snippetSet": { "properties": { "links": { "type": "object", @@ -56738,30 +82192,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/promotionSalesChannels" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/snippetSet" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "promotion_sales_channel" - }, - "id": { - "type": "string", - "example": "ede6dfd9f261361e1f3ada8c5385d064" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "snippet_set" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "543af5fd1912efc00742534f621046d3" } } } }, "type": "object" }, - "documentBaseConfigSalesChannels": { + "salesChannelDefaultHreflang": { "properties": { "links": { "type": "object", @@ -56769,30 +82221,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/documentBaseConfigSalesChannels" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_base_config_sales_channel" - }, - "id": { - "type": "string", - "example": "9c990fde5b38ff70fc1a07bf84c12a17" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8d7b798a77667d73c422fb222603234c" } } } }, "type": "object" }, - "productReviews": { + "productExports": { "properties": { "links": { "type": "object", @@ -56800,7 +82250,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviews" + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/productExports" } } }, @@ -56811,19 +82261,245 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "product_export" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "2cd8793787cda582174c0fc329fbc377" } } } } }, "type": "object" - }, - "seoUrls": { + } + }, + "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", @@ -56831,7 +82507,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrls" + "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" } } }, @@ -56842,19 +82518,134 @@ "properties": { "type": { "type": "string", - "example": "seo_url" + "example": "sales_channel" }, "id": { "type": "string", - "example": "5321b5a71127b8b98cdd4b068ad56c4c" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" - }, - "seoUrlTemplates": { + } + }, + "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" + }, + "extensions": { + "properties": { + "subscriptionCustomers": { "properties": { "links": { "type": "object", @@ -56862,7 +82653,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/seoUrlTemplates" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomers" } } }, @@ -56873,11 +82664,11 @@ "properties": { "type": { "type": "string", - "example": "seo_url_template" + "example": "subscription_customer" }, "id": { "type": "string", - "example": "02cde325fef3e680f529875e8abd60bb" + "example": "ee8811605866488e8f21308857e1e5a8" } } } @@ -56885,7 +82676,7 @@ }, "type": "object" }, - "mainCategories": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -56893,7 +82684,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/mainCategories" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomerAddresses" } } }, @@ -56904,19 +82695,24 @@ "properties": { "type": { "type": "string", - "example": "main_category" + "example": "subscription_address" }, "id": { "type": "string", - "example": "1fb731fc4139cbb575429e28846f0c39" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } } }, "type": "object" - }, - "productExports": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customers": { "properties": { "links": { "type": "object", @@ -56924,7 +82720,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productExports" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" } } }, @@ -56935,11 +82731,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "customer" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -56947,36 +82743,7 @@ }, "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": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -56984,7 +82751,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/customerGroupsRegistrations" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" } } }, @@ -56995,11 +82762,11 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "customer_address" }, "id": { "type": "string", - "example": "ea52a61e886aa27d777ef201c6fb7fff" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -57007,7 +82774,7 @@ }, "type": "object" }, - "landingPages": { + "orderCustomers": { "properties": { "links": { "type": "object", @@ -57015,7 +82782,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/landingPages" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" } } }, @@ -57026,11 +82793,11 @@ "properties": { "type": { "type": "string", - "example": "landing_page" + "example": "order_customer" }, "id": { "type": "string", - "example": "d60b77f2b3bd69591e3d5e3100926b4d" + "example": "1e7dbe7e3bcb48d233fd80588f54c980" } } } @@ -57038,7 +82805,7 @@ }, "type": "object" }, - "boundCustomers": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -57046,7 +82813,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/boundCustomers" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" } } }, @@ -57057,11 +82824,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "order_address" }, "id": { "type": "string", - "example": "770f1f7d01437434bcdf89eee15d4bd2" + "example": "c3182f0dc0cc20b4982616d3e0221747" } } } @@ -57069,7 +82836,7 @@ }, "type": "object" }, - "wishlists": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -57077,7 +82844,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/wishlists" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" } } }, @@ -57088,11 +82855,11 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist" + "example": "newsletter_recipient" }, "id": { "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" + "example": "2217f01dc5cddfd5b60387c39867f58e" } } } @@ -57108,163 +82875,32 @@ } ] }, - "SalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "typeId", - "languageId", - "customerGroupId", - "currencyId", - "paymentMethodId", - "shippingMethodId", - "countryId", - "navigationCategoryId", - "accessKey", + "Salutation": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "salutationKey", "createdAt", - "name", - "homeEnabled" + "displayName", + "letterName" ], "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": { + "salutationKey": { "type": "string" }, - "taxCalculationType": { + "displayName": { "type": "string" }, - "accessKey": { + "letterName": { "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", @@ -57280,38 +82916,7 @@ }, "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" - }, - "subscriptions": { + "subscriptionCustomers": { "properties": { "links": { "type": "object", @@ -57319,7 +82924,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/subscriptions" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomers" } } }, @@ -57330,11 +82935,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "subscription_customer" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "ee8811605866488e8f21308857e1e5a8" } } } @@ -57342,7 +82947,7 @@ }, "type": "object" }, - "quotes": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -57350,7 +82955,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/quotes" + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomerAddresses" } } }, @@ -57361,11 +82966,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "subscription_address" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -57376,197 +82981,169 @@ }, "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": { + "customerAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/CustomerAddress" } }, - "systemConfigs": { + "orderCustomers": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/OrderCustomer" } }, - "navigationCategory": { - "$ref": "#/components/schemas/Category" - }, - "footerCategory": { - "$ref": "#/components/schemas/Category" - }, - "serviceCategory": { - "$ref": "#/components/schemas/Category" - }, - "productVisibilities": { + "orderAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/OrderAddress" } }, - "hreflangDefaultDomain": { - "$ref": "#/components/schemas/SalesChannelDomain" - }, - "mailHeaderFooter": { - "$ref": "#/components/schemas/MailHeaderFooter" - }, "newsletterRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/NewsletterRecipient" } + } + }, + "type": "object" + }, + "ScheduledTaskJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "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" - } + { + "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}$" }, - "seoUrls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "name": { + "type": "string" }, - "seoUrlTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } + "scheduledTaskClass": { + "type": "string" }, - "mainCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "runInterval": { + "type": "integer", + "format": "int64" }, - "productExports": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } + "defaultRunInterval": { + "type": "integer", + "format": "int64" }, - "analytics": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "status": { + "type": "string" }, - "customerGroupsRegistrations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } + "lastExecutionTime": { + "type": "string", + "format": "date-time" }, - "landingPages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } + "nextExecutionTime": { + "type": "string", + "format": "date-time" }, - "boundCustomers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "wishlists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, "type": "object" }, - "SalesChannelAnalyticsJsonApi": { - "description": "Added since version: 6.2.0.0", + "ScriptJsonApi": { + "description": "Added since version: 6.4.7.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ + "id", + "script", + "hook", + "name", + "active", "createdAt" ], "properties": { @@ -57574,18 +83151,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "trackingId": { + "script": { "type": "string" }, - "active": { - "type": "boolean" + "hook": { + "type": "string" }, - "trackOrders": { - "type": "boolean" + "name": { + "type": "string" }, - "anonymizeIp": { + "active": { "type": "boolean" }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -57598,7 +83179,7 @@ }, "relationships": { "properties": { - "salesChannel": { + "app": { "properties": { "links": { "type": "object", @@ -57606,7 +83187,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-analytics/d2c88e9b92761eeb97980a50c7d2cdc0/salesChannel" + "example": "/script/f907e651164789346ae0a1e257c462d8/app" } } }, @@ -57615,12 +83196,12 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -57635,101 +83216,54 @@ } ] }, - "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", - "required": [ - "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", + "Script": { + "description": "Added since version: 6.4.7.0", "required": [ - "salesChannelId", - "countryId" + "id", + "script", + "hook", + "name", + "active", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "script": { + "type": "string" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "hook": { + "type": "string" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "name": { + "type": "string" }, - "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}$" + "active": { + "type": "boolean" }, - "salesChannelId": { + "appId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "currency": { - "$ref": "#/components/schemas/Currency" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "SalesChannelDomainJsonApi": { + "SeoUrlJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -57737,11 +83271,12 @@ }, { "required": [ - "url", - "salesChannelId", + "id", "languageId", - "currencyId", - "snippetSetId", + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo", "createdAt" ], "properties": { @@ -57749,9 +83284,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { - "type": "string" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -57760,17 +83292,36 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "foreignKey": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "snippetSetId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "routeName": { + "type": "string" }, - "hreflangUseOnlyLocale": { + "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" }, @@ -57786,35 +83337,6 @@ }, "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": { @@ -57823,7 +83345,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/language" + "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" } } }, @@ -57844,65 +83366,7 @@ }, "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": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -57910,7 +83374,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/salesChannelDefaultHreflang" + "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/salesChannel" } } }, @@ -57924,38 +83388,7 @@ "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" - } + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -57970,14 +83403,15 @@ } ] }, - "SalesChannelDomain": { + "SeoUrl": { "description": "Added since version: 6.0.0.0", "required": [ - "url", - "salesChannelId", + "id", "languageId", - "currencyId", - "snippetSetId", + "foreignKey", + "routeName", + "pathInfo", + "seoPathInfo", "createdAt" ], "properties": { @@ -57985,9 +83419,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "url": { - "type": "string" - }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -57996,17 +83427,36 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { + "foreignKey": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "snippetSetId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "routeName": { + "type": "string" }, - "hreflangUseOnlyLocale": { + "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" }, @@ -58020,115 +83470,16 @@ "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": { + "SeoUrlTemplateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -58136,37 +83487,31 @@ }, { "required": [ - "createdAt", - "name" + "id", + "entityName", + "routeName", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverUrl": { - "type": "string" - }, - "iconName": { - "type": "string" - }, - "screenshotUrls": { - "type": "array", - "items": { - "type": "string" - } + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "entityName": { "type": "string" }, - "manufacturer": { + "routeName": { "type": "string" }, - "description": { + "template": { "type": "string" }, - "descriptionLong": { - "type": "string" + "isValid": { + "type": "boolean" }, "customFields": { "type": "object" @@ -58181,12 +83526,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannels": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -58194,23 +83536,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/sales-channel-type/569a394914261338c70075564274cb38/salesChannels" + "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/salesChannel" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -58225,40 +83565,34 @@ } ] }, - "SalesChannelType": { + "SeoUrlTemplate": { "description": "Added since version: 6.0.0.0", "required": [ - "createdAt", - "name" + "id", + "entityName", + "routeName", + "createdAt" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverUrl": { - "type": "string" - }, - "iconName": { - "type": "string" - }, - "screenshotUrls": { - "type": "array", - "items": { - "type": "string" - } + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "entityName": { "type": "string" }, - "manufacturer": { + "routeName": { "type": "string" }, - "description": { + "template": { "type": "string" }, - "descriptionLong": { - "type": "string" + "isValid": { + "type": "boolean" }, "customFields": { "type": "object" @@ -58273,19 +83607,13 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "SalutationJsonApi": { + "ShippingMethodJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -58293,28 +83621,58 @@ }, { "required": [ - "salutationKey", + "id", + "deliveryTimeId", + "taxType", "createdAt", - "displayName", - "letterName" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationKey": { + "name": { "type": "string" }, - "displayName": { - "type": "string" + "active": { + "type": "boolean" }, - "letterName": { - "type": "string" + "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", @@ -58330,7 +83688,7 @@ }, "extensions": { "properties": { - "subscriptionCustomers": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -58338,7 +83696,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomers" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/subscriptions" } } }, @@ -58349,11 +83707,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_customer" + "example": "subscription" }, "id": { "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -58361,7 +83719,7 @@ }, "type": "object" }, - "subscriptionCustomerAddresses": { + "quoteDeliveries": { "properties": { "links": { "type": "object", @@ -58369,7 +83727,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomerAddresses" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/quoteDeliveries" } } }, @@ -58380,11 +83738,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_address" + "example": "quote_delivery" }, "id": { "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" + "example": "2aabe64723fb0f621446cd7b5c04f15e" } } } @@ -58397,7 +83755,7 @@ }, "relationships": { "properties": { - "customers": { + "deliveryTime": { "properties": { "links": { "type": "object", @@ -58405,7 +83763,65 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customers" + "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" } } }, @@ -58416,11 +83832,11 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "shipping_method_price" }, "id": { "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" + "example": "afae32efe0f84fece3f96b377b768b33" } } } @@ -58428,7 +83844,7 @@ }, "type": "object" }, - "customerAddresses": { + "media": { "properties": { "links": { "type": "object", @@ -58436,7 +83852,36 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/customerAddresses" + "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" } } }, @@ -58447,11 +83892,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "tag" }, "id": { "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -58459,7 +83904,7 @@ }, "type": "object" }, - "orderCustomers": { + "orderDeliveries": { "properties": { "links": { "type": "object", @@ -58467,7 +83912,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderCustomers" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/orderDeliveries" } } }, @@ -58478,11 +83923,11 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "order_delivery" }, "id": { "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" + "example": "0ba472de56dd7ba2e7bb878434321e26" } } } @@ -58490,7 +83935,7 @@ }, "type": "object" }, - "orderAddresses": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -58498,7 +83943,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/orderAddresses" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannels" } } }, @@ -58509,11 +83954,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "sales_channel" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -58521,7 +83966,7 @@ }, "type": "object" }, - "newsletterRecipients": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -58529,7 +83974,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/newsletterRecipients" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannelDefaultAssignments" } } }, @@ -58540,17 +83985,75 @@ "properties": { "type": { "type": "string", - "example": "newsletter_recipient" + "example": "sales_channel" }, "id": { "type": "string", - "example": "2217f01dc5cddfd5b60387c39867f58e" + "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" @@ -58560,31 +84063,61 @@ } ] }, - "Salutation": { + "ShippingMethod": { "description": "Added since version: 6.0.0.0", "required": [ - "salutationKey", + "id", + "deliveryTimeId", + "taxType", "createdAt", - "displayName", - "letterName" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationKey": { + "name": { "type": "string" }, - "displayName": { - "type": "string" + "active": { + "type": "boolean" }, - "letterName": { - "type": "string" + "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", @@ -58600,7 +84133,7 @@ }, "extensions": { "properties": { - "subscriptionCustomers": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -58608,7 +84141,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomers" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/subscriptions" } } }, @@ -58619,11 +84152,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_customer" + "example": "subscription" }, "id": { "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -58631,7 +84164,7 @@ }, "type": "object" }, - "subscriptionCustomerAddresses": { + "quoteDeliveries": { "properties": { "links": { "type": "object", @@ -58639,7 +84172,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/subscriptionCustomerAddresses" + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/quoteDeliveries" } } }, @@ -58650,298 +84183,70 @@ "properties": { "type": { "type": "string", - "example": "subscription_address" + "example": "quote_delivery" }, "id": { "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" + "example": "2aabe64723fb0f621446cd7b5c04f15e" } } } } }, - "type": "object" - } - }, - "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": [ - "name", - "scheduledTaskClass", - "runInterval", - "status", - "nextExecutionTime", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "scheduledTaskClass": { - "type": "string" - }, - "runInterval": { - "type": "integer", - "format": "int64" - }, - "status": { - "type": "string" - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time" - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time" - }, - "defaultRunInterval": { - "type": "integer", - "format": "int64" - }, - "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": [ - "name", - "scheduledTaskClass", - "runInterval", - "status", - "nextExecutionTime", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "scheduledTaskClass": { - "type": "string" - }, - "runInterval": { - "type": "integer", - "format": "int64" - }, - "status": { - "type": "string" - }, - "lastExecutionTime": { - "type": "string", - "format": "date-time" - }, - "nextExecutionTime": { - "type": "string", - "format": "date-time" - }, - "defaultRunInterval": { - "type": "integer", - "format": "int64" - }, - "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": [ - "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": [ - "script", - "hook", - "name", - "active", - "createdAt" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "object" + } + }, + "type": "object" }, - "script": { - "type": "string" + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime" }, - "hook": { - "type": "string" + "availabilityRule": { + "$ref": "#/components/schemas/Rule" }, - "name": { - "type": "string" + "prices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } }, - "active": { - "type": "boolean" + "media": { + "$ref": "#/components/schemas/Media" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "orderDeliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "app": { - "$ref": "#/components/schemas/App" + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "tax": { + "$ref": "#/components/schemas/Tax" + }, + "appShippingMethod": { + "$ref": "#/components/schemas/AppShippingMethod" } }, "type": "object" }, - "SeoUrlJsonApi": { + "ShippingMethodPriceJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -58949,11 +84254,8 @@ }, { "required": [ - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo", + "id", + "shippingMethodId", "createdAt" ], "properties": { @@ -58961,47 +84263,36 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { + "calculation": { + "type": "integer", + "format": "int64" + }, + "calculationRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "routeName": { - "type": "string" - }, - "pathInfo": { - "type": "string" - }, - "seoPathInfo": { - "type": "string" - }, - "isCanonical": { - "type": "boolean" - }, - "isModified": { - "type": "boolean" + "quantityStart": { + "type": "number", + "format": "float" }, - "isDeleted": { - "type": "boolean" + "quantityEnd": { + "type": "number", + "format": "float" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "currencyPrice": { + "type": "object" }, "customFields": { "type": "object" }, - "isValid": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -59014,7 +84305,7 @@ }, "relationships": { "properties": { - "language": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -59022,7 +84313,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/language" + "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/shippingMethod" } } }, @@ -59031,19 +84322,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "salesChannel": { + "rule": { "properties": { "links": { "type": "object", @@ -59051,7 +84342,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/seo-url/da349d0533b621e1f2a0c00b3a04cd46/salesChannel" + "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/rule" } } }, @@ -59060,12 +84351,41 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "rule" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" } } } @@ -59080,14 +84400,11 @@ } ] }, - "SeoUrl": { + "ShippingMethodPrice": { "description": "Added since version: 6.0.0.0", "required": [ - "languageId", - "foreignKey", - "routeName", - "pathInfo", - "seoPathInfo", + "id", + "shippingMethodId", "createdAt" ], "properties": { @@ -59095,47 +84412,36 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "shippingMethodId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "ruleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "foreignKey": { + "calculation": { + "type": "integer", + "format": "int64" + }, + "calculationRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "routeName": { - "type": "string" - }, - "pathInfo": { - "type": "string" - }, - "seoPathInfo": { - "type": "string" - }, - "isCanonical": { - "type": "boolean" - }, - "isModified": { - "type": "boolean" + "quantityStart": { + "type": "number", + "format": "float" }, - "isDeleted": { - "type": "boolean" + "quantityEnd": { + "type": "number", + "format": "float" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "string" + "currencyPrice": { + "type": "object" }, "customFields": { "type": "object" }, - "isValid": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, "createdAt": { "type": "string", "format": "date-time", @@ -59146,16 +84452,47 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "calculationRule": { + "$ref": "#/components/schemas/Rule" } }, "type": "object" }, - "SeoUrlTemplateJsonApi": { + "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": [ { @@ -59163,8 +84500,11 @@ }, { "required": [ - "entityName", - "routeName", + "id", + "setId", + "translationKey", + "value", + "author", "createdAt" ], "properties": { @@ -59172,22 +84512,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "setId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { + "translationKey": { "type": "string" }, - "routeName": { + "value": { "type": "string" }, - "template": { + "author": { "type": "string" }, - "isValid": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -59203,7 +84540,7 @@ }, "relationships": { "properties": { - "salesChannel": { + "set": { "properties": { "links": { "type": "object", @@ -59211,7 +84548,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/seo-url-template/58940688e95c02f54877a72861f930bb/salesChannel" + "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" } } }, @@ -59220,12 +84557,12 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "snippet_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" } } } @@ -59240,11 +84577,14 @@ } ] }, - "SeoUrlTemplate": { + "Snippet": { "description": "Added since version: 6.0.0.0", "required": [ - "entityName", - "routeName", + "id", + "setId", + "translationKey", + "value", + "author", "createdAt" ], "properties": { @@ -59252,22 +84592,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "setId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { + "translationKey": { "type": "string" }, - "routeName": { + "value": { "type": "string" }, - "template": { + "author": { "type": "string" }, - "isValid": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -59281,13 +84618,13 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "set": { + "$ref": "#/components/schemas/SnippetSet" } }, "type": "object" }, - "ShippingMethodJsonApi": { + "SnippetSetJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -59295,11 +84632,11 @@ }, { "required": [ - "availabilityRuleId", - "deliveryTimeId", - "taxType", - "createdAt", - "name" + "id", + "name", + "baseFile", + "iso", + "createdAt" ], "properties": { "id": { @@ -59309,43 +84646,14 @@ "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": { + "baseFile": { "type": "string" }, - "trackingUrl": { + "iso": { "type": "string" }, - "technicalName": { - "type": "string" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -59357,12 +84665,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { + "relationships": { "properties": { - "subscriptions": { + "snippets": { "properties": { "links": { "type": "object", @@ -59370,7 +84675,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/subscriptions" + "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" } } }, @@ -59381,11 +84686,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "snippet" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "67be68a348da3b850fb7daa10b034528" } } } @@ -59393,7 +84698,7 @@ }, "type": "object" }, - "quoteDeliveries": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -59401,7 +84706,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/quoteDeliveries" + "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" } } }, @@ -59412,11 +84717,11 @@ "properties": { "type": { "type": "string", - "example": "quote_delivery" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "2aabe64723fb0f621446cd7b5c04f15e" + "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } @@ -59426,159 +84731,191 @@ } }, "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" + }, + "SpatialRenderConfigSizeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "width", + "height", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "width": { + "type": "integer", + "format": "int64" + }, + "height": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "SpatialRenderConfigSize": { + "required": [ + "id", + "name", + "width", + "height", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "width": { + "type": "integer", + "format": "int64" + }, + "height": { + "type": "integer", + "format": "int64" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "SpatialSceneJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "backgroundEnabled": { + "type": "boolean" + }, + "backgroundColor": { + "type": "string" + }, + "floorEnabled": { + "type": "boolean" + }, + "floorColor": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, "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": { + "objects": { "properties": { "links": { "type": "object", @@ -59586,7 +84923,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/orderDeliveries" + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/objects" } } }, @@ -59597,11 +84934,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "spatial_scene_object" }, "id": { "type": "string", - "example": "0ba472de56dd7ba2e7bb878434321e26" + "example": "5891da2d64975cae48d175d1e001f5da" } } } @@ -59609,7 +84946,7 @@ }, "type": "object" }, - "salesChannels": { + "cameras": { "properties": { "links": { "type": "object", @@ -59617,7 +84954,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannels" + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/cameras" } } }, @@ -59628,11 +84965,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "spatial_scene_camera" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "036651ad64ffb926ca7a2759af327a8a" } } } @@ -59640,7 +84977,7 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "lights": { "properties": { "links": { "type": "object", @@ -59648,7 +84985,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/salesChannelDefaultAssignments" + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/lights" } } }, @@ -59659,48 +84996,133 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "spatial_scene_light" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "278e59671a1a559c4bc61d226cd217cd" } } } } }, "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": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SpatialScene": { + "required": [ + "id", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "backgroundEnabled": { + "type": "boolean" + }, + "backgroundColor": { + "type": "string" + }, + "floorEnabled": { + "type": "boolean" + }, + "floorColor": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + }, + "cameras": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + }, + "lights": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + }, + "type": "object" + }, + "SpatialSceneCameraJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "sceneId", + "type", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "type": "object" + }, + "target": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "scene": { "properties": { "links": { "type": "object", @@ -59708,7 +85130,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/appShippingMethod" + "example": "/spatial-scene-camera/d7d65fbdb516f0fc0e32feb511de5c33/scene" } } }, @@ -59717,12 +85139,12 @@ "properties": { "type": { "type": "string", - "example": "app_shipping_method" + "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "09f1214e961760dbae11d49b2bf9fa2c" + "example": "1e7f604b86415ade94e15fef8627609b" } } } @@ -59737,60 +85159,34 @@ } ] }, - "ShippingMethod": { - "description": "Added since version: 6.0.0.0", + "SpatialSceneCamera": { "required": [ - "availabilityRuleId", - "deliveryTimeId", - "taxType", - "createdAt", - "name" + "id", + "sceneId", + "type", + "name", + "createdAt" ], "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": { + "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "taxType": { + "type": { "type": "string" }, - "taxId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": { + "name": { "type": "string" }, - "trackingUrl": { - "type": "string" + "position": { + "type": "object" }, - "technicalName": { - "type": "string" + "target": { + "type": "object" }, "createdAt": { "type": "string", @@ -59802,133 +85198,172 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "scene": { + "$ref": "#/components/schemas/SpatialScene" + } + }, + "type": "object" + }, + "SpatialSceneLightJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "extensions": { + { + "required": [ + "id", + "sceneId", + "type", + "name", + "createdAt" + ], "properties": { - "subscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/subscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } - } - }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "enabled": { + "type": "boolean" + }, + "intensity": { + "type": "number", + "format": "float" + }, + "color": { + "type": "string" + }, + "position": { "type": "object" }, - "quoteDeliveries": { + "rotation": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { "properties": { - "links": { - "type": "object", + "scene": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/quoteDeliveries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_delivery" - }, - "id": { - "type": "string", - "example": "2aabe64723fb0f621446cd7b5c04f15e" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-light/fb2a55d47b419c2709f04f235c4eb7fe/scene" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1e7f604b86415ade94e15fef8627609b" + } } } - } + }, + "type": "object" } }, "type": "object" } }, "type": "object" + } + ] + }, + "SpatialSceneLight": { + "required": [ + "id", + "sceneId", + "type", + "name", + "createdAt" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "type": { + "type": "string" }, - "prices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } + "name": { + "type": "string" }, - "media": { - "$ref": "#/components/schemas/Media" + "enabled": { + "type": "boolean" }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "intensity": { + "type": "number", + "format": "float" }, - "orderDeliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } + "color": { + "type": "string" }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "position": { + "type": "object" }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "rotation": { + "type": "object" }, - "tax": { - "$ref": "#/components/schemas/Tax" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "appShippingMethod": { - "$ref": "#/components/schemas/AppShippingMethod" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "scene": { + "$ref": "#/components/schemas/SpatialScene" } }, "type": "object" }, - "ShippingMethodPriceJsonApi": { - "description": "Added since version: 6.0.0.0", + "SpatialSceneObjectJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "shippingMethodId", + "id", + "sceneId", + "mediaId", + "name", + "visible", "createdAt" ], "properties": { @@ -59936,34 +85371,27 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "calculation": { - "type": "integer", - "format": "int64" - }, - "calculationRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "quantityStart": { - "type": "number", - "format": "float" + "visible": { + "type": "boolean" }, - "quantityEnd": { - "type": "number", - "format": "float" + "position": { + "type": "object" }, - "currencyPrice": { + "rotation": { "type": "object" }, - "customFields": { + "scale": { "type": "object" }, "createdAt": { @@ -59978,36 +85406,7 @@ }, "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": { + "scene": { "properties": { "links": { "type": "object", @@ -60015,7 +85414,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/rule" + "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/scene" } } }, @@ -60024,19 +85423,19 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "spatial_scene" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" + "example": "1e7f604b86415ade94e15fef8627609b" } } } }, "type": "object" }, - "calculationRule": { + "media": { "properties": { "links": { "type": "object", @@ -60044,7 +85443,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/shipping-method-price/db327935c14793601a943097a4852a7b/calculationRule" + "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/media" } } }, @@ -60053,12 +85452,12 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "01b78fd34df634d784131ceefffbac99" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -60073,10 +85472,13 @@ } ] }, - "ShippingMethodPrice": { - "description": "Added since version: 6.0.0.0", + "SpatialSceneObject": { "required": [ - "shippingMethodId", + "id", + "sceneId", + "mediaId", + "name", + "visible", "createdAt" ], "properties": { @@ -60084,34 +85486,27 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "ruleId": { + "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "calculation": { - "type": "integer", - "format": "int64" - }, - "calculationRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "quantityStart": { - "type": "number", - "format": "float" + "visible": { + "type": "boolean" }, - "quantityEnd": { - "type": "number", - "format": "float" + "position": { + "type": "object" }, - "currencyPrice": { + "rotation": { "type": "object" }, - "customFields": { + "scale": { "type": "object" }, "createdAt": { @@ -60124,58 +85519,27 @@ "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" + "scene": { + "$ref": "#/components/schemas/SpatialScene" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "SnippetJsonApi": { - "description": "Added since version: 6.0.0.0", + "SsoProviderJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "setId", - "translationKey", - "value", - "author", + "id", + "name", + "type", + "active", + "config", "createdAt" ], "properties": { @@ -60183,22 +85547,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "setId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationKey": { + "name": { "type": "string" }, - "value": { + "type": { "type": "string" }, - "author": { - "type": "string" + "active": { + "type": "boolean" }, - "customFields": { + "config": { "type": "object" }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -60211,7 +85575,7 @@ }, "relationships": { "properties": { - "set": { + "ssoProviderCustomers": { "properties": { "links": { "type": "object", @@ -60219,7 +85583,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/snippet/c437bb5adb99c55aa0754151c5a61e3d/set" + "example": "/sso-provider/179b43520e8619ff3a0ff51723f7e827/ssoProviderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" + } + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sso-provider/179b43520e8619ff3a0ff51723f7e827/media" } } }, @@ -60228,12 +85623,12 @@ "properties": { "type": { "type": "string", - "example": "snippet_set" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cdaeeeba9b4a4c5ebf042c0215a7bb0e" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -60248,13 +85643,13 @@ } ] }, - "Snippet": { - "description": "Added since version: 6.0.0.0", + "SsoProvider": { "required": [ - "setId", - "translationKey", - "value", - "author", + "id", + "name", + "type", + "active", + "config", "createdAt" ], "properties": { @@ -60262,22 +85657,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "setId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "translationKey": { + "name": { "type": "string" }, - "value": { + "type": { "type": "string" }, - "author": { - "type": "string" + "active": { + "type": "boolean" }, - "customFields": { + "config": { "type": "object" }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -60288,23 +85683,29 @@ "format": "date-time", "readOnly": true }, - "set": { - "$ref": "#/components/schemas/SnippetSet" + "ssoProviderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + }, + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "SnippetSetJsonApi": { - "description": "Added since version: 6.0.0.0", + "SsoProviderCustomerJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" }, { "required": [ - "name", - "baseFile", - "iso", + "id", + "ssoProviderId", + "customerId", + "subject", "createdAt" ], "properties": { @@ -60312,18 +85713,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "ssoProviderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "baseFile": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iso": { + "subject": { "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -60336,7 +85736,7 @@ }, "relationships": { "properties": { - "snippets": { + "ssoProvider": { "properties": { "links": { "type": "object", @@ -60344,30 +85744,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/snippets" + "example": "/sso-provider-customer/bfea076e6e55c14790133b1314edcdb2/ssoProvider" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "snippet" - }, - "id": { - "type": "string", - "example": "67be68a348da3b850fb7daa10b034528" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "643b6966b5e1ecd3029a10a40f7b85ff" } } } }, "type": "object" }, - "salesChannelDomains": { + "customer": { "properties": { "links": { "type": "object", @@ -60375,23 +85773,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/snippet-set/9f6e11952dab122bb6c007faaa8d4880/salesChannelDomains" + "example": "/sso-provider-customer/bfea076e6e55c14790133b1314edcdb2/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel_domain" - }, - "id": { - "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -60406,12 +85802,12 @@ } ] }, - "SnippetSet": { - "description": "Added since version: 6.0.0.0", + "SsoProviderCustomer": { "required": [ - "name", - "baseFile", - "iso", + "id", + "ssoProviderId", + "customerId", + "subject", "createdAt" ], "properties": { @@ -60419,18 +85815,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "ssoProviderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "baseFile": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "iso": { + "subject": { "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -60441,17 +85836,11 @@ "format": "date-time", "readOnly": true }, - "snippets": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } + "ssoProvider": { + "$ref": "#/components/schemas/SsoProvider" }, - "salesChannelDomains": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } + "customer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" @@ -60464,6 +85853,7 @@ }, { "required": [ + "id", "technicalName", "createdAt", "name" @@ -60605,6 +85995,7 @@ "StateMachine": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "createdAt", "name" @@ -60669,11 +86060,13 @@ }, { "required": [ + "id", + "referencedId", + "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId", - "entityId", "createdAt" ], "properties": { @@ -60681,6 +86074,14 @@ "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}$" @@ -60703,18 +86104,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityId": { - "type": "object", - "deprecated": true - }, - "referencedId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -60854,11 +86243,13 @@ "StateMachineHistory": { "description": "Added since version: 6.0.0.0", "required": [ + "id", + "referencedId", + "referencedVersionId", "stateMachineId", "entityName", "fromStateId", "toStateId", - "entityId", "createdAt" ], "properties": { @@ -60866,6 +86257,14 @@ "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}$" @@ -60888,18 +86287,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityId": { - "type": "object", - "deprecated": true - }, - "referencedId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -60933,6 +86320,7 @@ }, { "required": [ + "id", "technicalName", "stateMachineId", "createdAt", @@ -61481,6 +86869,7 @@ "StateMachineState": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "technicalName", "stateMachineId", "createdAt", @@ -61776,6 +87165,7 @@ }, { "required": [ + "id", "actionName", "stateMachineId", "fromStateId", @@ -61915,6 +87305,7 @@ "StateMachineTransition": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "actionName", "stateMachineId", "fromStateId", @@ -61973,6 +87364,7 @@ }, { "required": [ + "id", "convertedOrder", "subscriptionNumber", "nextSchedule", @@ -62078,6 +87470,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -62094,6 +87491,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -62543,6 +87945,7 @@ }, "Subscription": { "required": [ + "id", "convertedOrder", "subscriptionNumber", "nextSchedule", @@ -62648,6 +88051,11 @@ "type": "object" }, "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -62664,6 +88072,11 @@ "type": "object" }, "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { "decimals": { "type": "integer", @@ -62750,6 +88163,7 @@ }, { "required": [ + "id", "countryId", "subscriptionId", "firstName", @@ -63014,6 +88428,7 @@ }, "SubscriptionAddress": { "required": [ + "id", "countryId", "subscriptionId", "firstName", @@ -63120,6 +88535,7 @@ }, { "required": [ + "id", "subscriptionId", "salutationId", "email", @@ -63283,6 +88699,7 @@ }, "SubscriptionCustomer": { "required": [ + "id", "subscriptionId", "salutationId", "email", @@ -63366,6 +88783,7 @@ }, { "required": [ + "id", "name", "active", "dateInterval", @@ -63509,6 +88927,7 @@ }, "SubscriptionInterval": { "required": [ + "id", "name", "active", "dateInterval", @@ -63574,6 +88993,7 @@ }, { "required": [ + "id", "name", "active", "activeStorefrontLabel", @@ -63758,6 +89178,7 @@ }, "SubscriptionPlan": { "required": [ + "id", "name", "active", "activeStorefrontLabel", @@ -63924,6 +89345,7 @@ }, { "required": [ + "id", "flowId", "executionTime", "stored", @@ -64105,6 +89527,7 @@ }, "SwagDelayAction": { "required": [ + "id", "flowId", "executionTime", "stored", @@ -64208,6 +89631,7 @@ }, { "required": [ + "id", "configurationKey", "configurationValue", "createdAt" @@ -64284,6 +89708,7 @@ "SystemConfig": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "configurationKey", "configurationValue", "createdAt" @@ -64332,6 +89757,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -64681,6 +90107,7 @@ "Tag": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "createdAt" ], @@ -64803,6 +90230,7 @@ }, { "required": [ + "id", "taxRate", "name", "position", @@ -64944,6 +90372,7 @@ "Tax": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "taxRate", "name", "position", @@ -65008,6 +90437,7 @@ }, { "required": [ + "id", "identifier", "priority", "createdAt", @@ -65129,6 +90559,7 @@ "TaxProvider": { "description": "Added since version: 6.5.0.0", "required": [ + "id", "identifier", "priority", "createdAt", @@ -65196,6 +90627,7 @@ }, { "required": [ + "id", "taxRuleTypeId", "countryId", "taxRate", @@ -65358,6 +90790,7 @@ "TaxRule": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "taxRuleTypeId", "countryId", "taxRate", @@ -65440,6 +90873,7 @@ }, { "required": [ + "id", "technicalName", "position", "createdAt", @@ -65518,6 +90952,7 @@ "TaxRuleType": { "description": "Added since version: 6.1.0.0", "required": [ + "id", "technicalName", "position", "createdAt", @@ -65569,6 +91004,7 @@ }, { "required": [ + "id", "name", "author", "active", @@ -65768,6 +91204,7 @@ "Theme": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "name", "author", "active", @@ -65948,6 +91385,7 @@ }, { "required": [ + "id", "createdAt", "shortCode", "name" @@ -66023,6 +91461,7 @@ "Unit": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "createdAt", "shortCode", "name" @@ -66071,6 +91510,7 @@ }, { "required": [ + "id", "localeId", "username", "firstName", @@ -66765,6 +92205,7 @@ "User": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "localeId", "username", "firstName", @@ -67129,6 +92570,7 @@ }, { "required": [ + "id", "userId", "accessKey", "secretAccessKey", @@ -67208,6 +92650,7 @@ "UserAccessKey": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "userId", "accessKey", "secretAccessKey", @@ -67259,6 +92702,7 @@ }, { "required": [ + "id", "userId", "key", "createdAt" @@ -67330,6 +92774,7 @@ "UserConfig": { "description": "Added since version: 6.3.5.0", "required": [ + "id", "userId", "key", "createdAt" @@ -67373,6 +92818,7 @@ }, { "required": [ + "id", "hash", "userId", "createdAt" @@ -67441,6 +92887,7 @@ "UserRecovery": { "description": "Added since version: 6.0.0.0", "required": [ + "id", "hash", "userId", "createdAt" @@ -67480,6 +92927,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -67609,6 +93057,7 @@ }, "Warehouse": { "required": [ + "id", "name", "createdAt" ], @@ -67661,6 +93110,7 @@ }, { "required": [ + "id", "name", "createdAt" ], @@ -67796,6 +93246,7 @@ }, "WarehouseGroup": { "required": [ + "id", "name", "createdAt" ], @@ -67885,6 +93336,7 @@ }, { "required": [ + "id", "name", "eventName", "url", @@ -67972,6 +93424,7 @@ "Webhook": { "description": "Added since version: 6.3.1.0", "required": [ + "id", "name", "eventName", "url", @@ -68031,6 +93484,7 @@ }, { "required": [ + "id", "webhookName", "eventName", "deliveryStatus", @@ -68141,6 +93595,7 @@ "WebhookEventLog": { "description": "Added since version: 6.4.1.0", "required": [ + "id", "webhookName", "eventName", "deliveryStatus", @@ -68203,108 +93658,48 @@ "readOnly": true }, "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "flowSequences": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/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" - }, - "flowBulderActionsResponse": { - "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" - } - } - } - }, - "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" + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "flowSequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/flowSequences" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" + } + } + } + } + }, + "type": "object" } }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" - } - } + "type": "object" } - } + }, + "type": "object" }, "infoConfigResponse": { "type": "object", @@ -68368,6 +93763,164 @@ } } }, + "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)", @@ -68505,129 +94058,221 @@ } } }, - "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" - ] + "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" + } + } + } }, - "OAuthGrant": { + "CustomPricingDeleteOperation": { "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" + "action", + "payload" ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + "properties": { + "action": { + "description": "A specific verb defining what operation should be actioned for a specific data record", + "type": "string", + "enum": [ + "delete" + ] + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "anyOf": [ + { + "title": "productIds", + "type": "array", + "description": "An array of product entity UUIDs", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "title": "customerIds", + "type": "array", + "description": "An array of customer entity UUIDs", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "title": "customerGroupIds", + "type": "array", + "description": "An array of customerGroup entity UUIDs", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ] + } } } }, - "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" + "CustomPricingUpsertOperation": { + "type": "object", + "required": [ + "action", + "payload" + ], + "properties": { + "action": { + "description": "A specific verb defining what operation should be actioned for a specific data record", + "type": "string", + "enum": [ + "upsert" ] - } - ] - }, - "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" + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object", + "required": [ + "productId", + "prices" + ], + "description": "A definition almost symmetric with Sync API payload", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "description": "This parameter should be specified, or 'customerGroupId', not both", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "description": "This parameter should be specified, or 'customerId', not both", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPricingPrice" + } + } } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] + } } - ] + } }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + "CustomPricingPrice": { + "type": "object", + "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", + "required": [ + "quantityStart", + "price" + ], + "properties": { + "quantityStart": { + "type": "integer", + "format": "int64" }, - { - "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" + "quantityEnd": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "price": { + "type": "array", + "items": { + "type": "object", + "description": "This field should house all the normal facets of the `product_price`.`price` column", + "required": [ + "currencyId", + "gross", + "net", + "linked" + ], + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + }, + "listPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + }, + "regulationPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + } } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] + } } - ] + } }, "CustomPricingResponse": { "type": "object", @@ -68681,196 +94326,6 @@ } } } - }, - "CustomPricingDeleteOperation": { - "type": "object", - "required": [ - "action", - "payload" - ], - "properties": { - "action": { - "description": "A specific verb defining what operation should be actioned for a specific data record", - "type": "string", - "enum": [ - "delete" - ] - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "anyOf": [ - { - "title": "productIds", - "type": "array", - "description": "An array of product entity UUIDs", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "title": "customerIds", - "type": "array", - "description": "An array of customer entity UUIDs", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "title": "customerGroupIds", - "type": "array", - "description": "An array of customerGroup entity UUIDs", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ] - } - } - } - }, - "CustomPricingUpsertOperation": { - "type": "object", - "required": [ - "action", - "payload" - ], - "properties": { - "action": { - "description": "A specific verb defining what operation should be actioned for a specific data record", - "type": "string", - "enum": [ - "upsert" - ] - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object", - "required": [ - "productId", - "prices" - ], - "description": "A definition almost symmetric with Sync API payload", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "description": "This parameter should be specified, or 'customerGroupId', not both", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { - "type": "string", - "description": "This parameter should be specified, or 'customerId', not both", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomPricingPrice" - } - } - } - } - } - } - }, - "CustomPricingPrice": { - "type": "object", - "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", - "required": [ - "quantityStart", - "price" - ], - "properties": { - "quantityStart": { - "type": "integer", - "format": "int64" - }, - "quantityEnd": { - "type": "integer", - "format": "int64", - "minimum": 1 - }, - "price": { - "type": "array", - "items": { - "type": "object", - "description": "This field should house all the normal facets of the `product_price`.`price` column", - "required": [ - "currencyId", - "gross", - "net", - "linked" - ], - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - }, - "listPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - }, - "regulationPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - } - } - } - } - } } }, "responses": { @@ -69008,6 +94463,195 @@ }, "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": { @@ -69123,10 +94767,34 @@ "name": "B2b Business Partner", "description": "The endpoint for operations on B2b Business Partner" }, + { + "name": "B2b Components Approval Rule", + "description": "The endpoint for operations on B2b Components Approval Rule" + }, + { + "name": "B2b Components Approval Rule App Script Condition", + "description": "The endpoint for operations on B2b Components Approval Rule App Script Condition" + }, + { + "name": "B2b Components Pending Order", + "description": "The endpoint for operations on B2b Components Pending Order" + }, + { + "name": "B2b Components Pending Order Address", + "description": "The endpoint for operations on B2b Components Pending Order Address" + }, { "name": "B2b Components Role", "description": "The endpoint for operations on B2b Components Role" }, + { + "name": "B2b Components Shopping List", + "description": "The endpoint for operations on B2b Components Shopping List" + }, + { + "name": "B2b Components Shopping List Line Item", + "description": "The endpoint for operations on B2b Components Shopping List Line Item" + }, { "name": "B2b Employee", "description": "The endpoint for operations on B2b Employee" @@ -69559,6 +95227,10 @@ "name": "Quote Delivery Position", "description": "The endpoint for operations on Quote Delivery Position" }, + { + "name": "Quote Document", + "description": "The endpoint for operations on Quote Document" + }, { "name": "Quote Employee", "description": "The endpoint for operations on Quote Employee" @@ -69631,6 +95303,34 @@ "name": "Snippet Set", "description": "The endpoint for operations on Snippet Set" }, + { + "name": "Spatial Render Config Size", + "description": "The endpoint for operations on Spatial Render Config Size" + }, + { + "name": "Spatial Scene", + "description": "The endpoint for operations on Spatial Scene" + }, + { + "name": "Spatial Scene Camera", + "description": "The endpoint for operations on Spatial Scene Camera" + }, + { + "name": "Spatial Scene Light", + "description": "The endpoint for operations on Spatial Scene Light" + }, + { + "name": "Spatial Scene Object", + "description": "The endpoint for operations on Spatial Scene Object" + }, + { + "name": "Sso Provider", + "description": "The endpoint for operations on Sso Provider" + }, + { + "name": "Sso Provider Customer", + "description": "The endpoint for operations on Sso Provider Customer" + }, { "name": "State Machine", "description": "The endpoint for operations on State Machine" From 9c9a87dd0d971a5a877bc70c6cd61f95a768ee59 Mon Sep 17 00:00:00 2001 From: Micha Date: Mon, 14 Oct 2024 15:16:54 +0200 Subject: [PATCH 24/63] Added dep --- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 11115e4..c2c1c67 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -15,7 +15,7 @@ on: env: PLUGIN_NAME: SwagDigitalSalesRooms PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagdigitalsalesrooms.git - COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.4 spatie/icalendar-generator ^2.6 + COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.4 spatie/icalendar-generator ^2.6 firebase/php-jwt ^6.0 # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: From 861ef7aca9e5ee1f52595167dacb37c4edc88fae Mon Sep 17 00:00:00 2001 From: Micha Date: Mon, 14 Oct 2024 16:20:40 +0200 Subject: [PATCH 25/63] Added fixed tagged version --- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index c2c1c67..2d9c682 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -14,7 +14,7 @@ on: env: PLUGIN_NAME: SwagDigitalSalesRooms - PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagdigitalsalesrooms.git + PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagdigitalsalesrooms.git -b v3.3.1 COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.4 spatie/icalendar-generator ^2.6 firebase/php-jwt ^6.0 # A workflow run is made up of one or more jobs that can run sequentially or in parallel From 84553b0509d6da693385c27a7d5145880bcb3670 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:42:18 +0200 Subject: [PATCH 26/63] [create-pull-request] automated change (#319) Co-authored-by: shopwareBot --- adminapi.json | 2683 +++++++++++++++++++++++-------------------------- 1 file changed, 1234 insertions(+), 1449 deletions(-) diff --git a/adminapi.json b/adminapi.json index 1857bc9..34b507b 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.6.1" + "version": "6.6.7.0" }, "servers": [ { @@ -52511,7 +52511,7 @@ "tags": [ "Salutation" ], - "summary": "Create a new Salutation resources.", + "summary": "Fetches salutations with a criteria obj.", "description": "Fetches salutations with a criteria obj.", "operationId": "createSalutation", "parameters": [ @@ -65490,335 +65490,6 @@ } } }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" - } - } - } - } - } - } - }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { - "tags": [ - "Document Management" - ], - "summary": "Reserve or preview a document number", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "description": "Number range not found" - } - } - } - }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "endpoints" - ], - "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - }, - "/_action/index": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { - "tags": [ - "Document Management" - ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document to be downloaded.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "The document.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } - } - } - } - }, - "/_action/document/{documentId}/upload": { - "post": { - "tags": [ - "Document Management" - ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document the new file should be added to.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Document uploaded successful", - "content": { - "application/json": { - "schema": { - "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/container_cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." - } - } - } - }, "/_action/mail-template/send": { "post": { "tags": [ @@ -66092,60 +65763,76 @@ } } }, - "/oauth/token": { + "/_info/openapi3.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/OpenApi3" + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { "post": { "tags": [ - "Authorization & Authentication" + "Customer impersonation" ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" } - ] + }, + "type": "object" } } } }, "responses": { "200": { - "description": "Authorized successfully.", + "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "token": { + "description": "The generated customer impersonation token", "type": "string" } }, @@ -66153,26 +65840,38 @@ } } } - }, - "400": { - "$ref": "#/components/responses/400" } } } }, - "/_action/order_transaction_capture_refund/{refundId}": { + "/_action/indexing": { "post": { "tags": [ - "Order Management" + "System Operations" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", "parameters": [ { - "name": "refundId", + "name": "indexer", "in": "path", - "description": "Identifier of the order transaction capture refund.", + "description": "Name of the indexer to iterate.", "required": true, "schema": { "type": "string", @@ -66180,37 +65879,35 @@ } } ], - "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } + } } - } - } - }, - "/_action/scheduled-task/run": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", + }, "responses": { "200": { - "description": "Returns a success message indicating a successful run.", + "description": "Returns information about the iteration.", "content": { "application/json": { "schema": { "properties": { - "message": { - "description": "Success message", - "type": "string" + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" } }, "type": "object" @@ -66221,27 +65918,21 @@ } } }, - "/_action/scheduled-task/min-run-interval": { + "/_info/flow-actions.json": { "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", "responses": { "200": { - "description": "Returns the minimum interval.", + "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } @@ -66249,19 +65940,52 @@ } } }, - "/_action/order/{orderId}/order-address": { + "/_action/index": { "post": { "tags": [ - "Order address" + "System Operations" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." + } + } + } + }, + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", "parameters": [ { - "name": "orderId", + "name": "refundId", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier of the order transaction capture refund.", "required": true, "schema": { "type": "string", @@ -66269,47 +65993,88 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "type": "string", - "description": "The ID of the delivery (optional)", - "nullable": true - } - }, - "required": [ - "customerAddressId", - "type" - ] + "responses": { + "204": { + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_action/cleanup": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cleanup finished." + } + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", + "responses": { + "200": { + "description": "Information about the cache state.", + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { + "description": "The active environment.", + "type": "string" }, - "description": "The mapping of order addresses" - } + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" + } + }, + "type": "object" } } } - }, - "required": true - }, + } + } + } + }, + "/_info/config": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get API information", + "description": "Get information about the API", + "operationId": "config", "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." + "200": { + "description": "Returns information about the API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/infoConfigResponse" + } + } + } } } } @@ -66386,73 +66151,66 @@ } } }, - "/_action/indexing": { - "post": { + "/_action/cache": { + "delete": { "tags": [ "System Operations" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Returns an empty response indicating that the indexing process started." + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_action/indexing/{indexer}": { + "/_action/index-products": { "post": { "tags": [ "System Operations" ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", - "parameters": [ - { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." } + } + } + }, + "/_action/order/document/download": { + "post": { + "tags": [ + "Document Management" ], + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", "requestBody": { + "description": "documentIds", "content": { "application/json": { "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } } } }, "responses": { "200": { - "description": "Returns information about the iteration.", + "description": "The documents.", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" - } - }, - "type": "object" + "type": "string", + "format": "binary" } } } @@ -66460,86 +66218,94 @@ } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/order/document/{documentTypeName}/create": { "post": { "tags": [ - "Customer impersonation" + "Document Management" + ], + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", + "parameters": [ + { + "name": "documentTypeName", + "in": "path", + "description": "The type of document to create", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", "requestBody": { + "description": "test", "required": true, "content": { "application/json": { "schema": { - "required": [ - "customerId", - "salesChannelId" - ], - "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" - }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "The generated customer impersonation token.", - "content": { - "application/json": { - "schema": { + "type": "array", + "items": { + "type": "object", + "required": [ + "orderId", + "type" + ], "properties": { - "token": { - "description": "The generated customer impersonation token", + "orderId": { + "description": "Identifier of the order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Type of the document to be generated.", "type": "string" + }, + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" + }, + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", + "type": "string", + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" } - }, - "type": "object" + } } } } } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", + }, "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." + "200": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", "parameters": [ { - "name": "orderTransactionId", + "name": "orderId", "in": "path", - "description": "Identifier of the order transaction.", + "description": "Identifier of the order.", "required": true, "schema": { "type": "string", @@ -66582,7 +66348,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "description": "This is the state column within the order database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" } @@ -66594,36 +66360,136 @@ }, "responses": { "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" + "description": "Todo: Use ref of `state_machine_transition` here" } } } }, - "/_action/cache_info": { + "/_action/container_cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." + } + } + } + }, + "/_action/scheduled-task/run": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", + "responses": { + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/scheduled-task/min-run-interval": { "get": { "tags": [ "System Operations" ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", "responses": { "200": { - "description": "Information about the cache state.", + "description": "Returns the minimum interval.", "content": { "application/json": { "schema": { "properties": { - "environment": { - "description": "The active environment.", + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/oauth/token": { + "post": { + "tags": [ + "Authorization & Authentication" + ], + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" + }, + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Authorized successfully.", + "content": { + "application/json": { + "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], + "properties": { + "token_type": { + "description": "Type of the token.", "type": "string" }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" }, - "cacheAdapter": { - "description": "The active cache adapter.", + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", "type": "string" } }, @@ -66631,47 +66497,102 @@ } } } + }, + "400": { + "$ref": "#/components/responses/400" } } } }, - "/_action/message-queue/consume": { + "/_action/sync": { "post": { "tags": [ - "System Operations" + "Bulk Operations" + ], + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", + "parameters": [ + { + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "schema": { + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] + } + } ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "required": [ - "receiver" - ], - "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" - } - }, - "type": "object" + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "type": "object" + } } } } }, "responses": { "200": { - "description": "Returns information about handled messages", + "description": "Returns a sync result containing information about the updated entities", "content": { "application/json": { "schema": { "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" } }, "type": "object" @@ -66682,17 +66603,74 @@ } } }, - "/_action/cleanup": { - "delete": { + "/_info/version": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "200": { + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } + } + } + } } } } @@ -66773,21 +66751,21 @@ } } }, - "/_info/config": { + "/_info/events.json": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Get API information", - "description": "Get information about the API", - "operationId": "config", + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { "200": { - "description": "Returns information about the API.", + "description": "Returns a list of about the business events.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/infoConfigResponse" + "$ref": "#/components/schemas/businessEventsResponse" } } } @@ -66795,59 +66773,47 @@ } } }, - "/_info/version": { + "/_action/document/{documentId}/{deepLinkCode}": { "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/order/document/download": { - "post": { "tags": [ "Document Management" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", - "requestBody": { - "description": "documentIds", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false } } - }, + ], "responses": { "200": { - "description": "The documents.", + "description": "The document.", "content": { "application/octet-stream": { "schema": { @@ -66860,19 +66826,38 @@ } } }, - "/_action/order/document/{documentTypeName}/create": { + "/_action/document/{documentId}/upload": { "post": { "tags": [ "Document Management" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", "parameters": [ { - "name": "documentTypeName", + "name": "documentId", "in": "path", - "description": "The type of document to create", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", "required": true, "schema": { "type": "string" @@ -66880,119 +66865,134 @@ } ], "requestBody": { - "description": "test", - "required": true, "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "required": [ - "orderId", - "type" - ], + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Document uploaded successful", + "content": { + "application/json": { + "schema": { "properties": { - "orderId": { - "description": "Identifier of the order.", + "documentId": { + "description": "Identifier of the document.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "description": "Type of the document to be generated.", + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", - "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", - "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" } - } + }, + "type": "object" } } } } - }, - "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." - } } } }, - "/_action/order/{orderId}/state/{transition}": { - "post": { + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { "tags": [ - "Order Management" + "Document Management" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", "parameters": [ { - "name": "orderId", + "name": "type", "in": "path", - "description": "Identifier of the order.", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "transition", + "name": "saleschannel", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", "required": true, "schema": { "type": "string" } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } } ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, + "/_action/message-queue/consume": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { + "required": [ + "receiver" + ], "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" } }, "type": "object" @@ -67002,7 +67002,20 @@ }, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "description": "Returns information about handled messages", + "content": { + "application/json": { + "schema": { + "properties": { + "handledMessages": { + "description": "The number of messages processed.", + "type": "integer" + } + }, + "type": "object" + } + } + } } } } @@ -67089,152 +67102,139 @@ } } }, - "/_info/openapi3.json": { - "get": { + "/_action/order/{orderId}/order-address": { + "post": { "tags": [ - "System Info & Health Check" + "Order address" ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", "parameters": [ { - "name": "type", - "in": "query", - "description": "Type of the api", + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, "schema": { "type": "string", - "enum": [ - "jsonapi", - "json" - ] + "pattern": "^[0-9a-f]{32}$" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "type": "string", + "description": "The ID of the delivery (optional)", + "nullable": true + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } + }, + "required": true + }, "responses": { - "200": { - "$ref": "#/components/responses/OpenApi3" + "204": { + "description": "Returns a no content response indicating that the update has been made." } } } }, - "/_action/sync": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ - "Bulk Operations" + "Order Management" ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "name": "orderTransactionId", + "in": "path", + "description": "Identifier of the order transaction.", + "required": true, "schema": { - "type": "boolean", - "default": true + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] + "type": "string" } } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], - "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", + "properties": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } + "pattern": "^[0-9a-f]{32}$" } }, - "type": "object" - } - } - } - } - }, - "responses": { - "200": { - "description": "Returns a sync result containing information about the updated entities", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" - }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" - }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "type": "object" - } + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" } } } - } - } - }, - "/_info/events.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + }, "responses": { "200": { - "description": "Returns a list of about the business events.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/businessEventsResponse" - } - } - } + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } @@ -67601,9 +67601,7 @@ { "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -67742,9 +67740,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -67805,8 +67801,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "userId", - "aclRoleId", - "createdAt" + "aclRoleId" ], "properties": { "id": { @@ -67854,13 +67849,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -67934,6 +67925,15 @@ "checkoutGatewayUrl": { "type": "string" }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, "label": { "type": "string" }, @@ -68351,13 +68351,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -68448,6 +68444,15 @@ "checkoutGatewayUrl": { "type": "string" }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, "label": { "type": "string", "description": "Label given to an app." @@ -68571,7 +68576,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -68659,7 +68663,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -68724,8 +68727,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -68764,8 +68766,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -68814,7 +68815,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -68902,7 +68902,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -68968,7 +68967,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -69120,7 +69118,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -69230,8 +69227,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -69340,8 +69336,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -69402,8 +69397,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -69559,8 +69553,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -69649,7 +69642,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -69769,7 +69761,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -69844,8 +69835,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -69983,8 +69973,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -70043,8 +70032,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -70120,8 +70108,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -70171,10 +70158,6 @@ { "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -70729,10 +70712,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -71026,8 +71005,7 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -71219,8 +71197,7 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -71352,8 +71329,7 @@ { "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -71605,8 +71581,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -71718,8 +71693,7 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -71902,8 +71876,7 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -72025,8 +71998,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -72125,8 +72097,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -72209,8 +72180,6 @@ { "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -72561,8 +72530,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -72764,7 +72731,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -72912,7 +72878,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -72993,7 +72958,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -73324,7 +73288,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -73492,8 +73455,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -73635,8 +73597,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -73731,8 +73692,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -73794,8 +73754,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -73868,8 +73827,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -73983,8 +73941,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -74052,8 +74009,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -74226,8 +74182,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -74305,8 +74260,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -74374,8 +74328,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -74426,9 +74379,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -75182,9 +75133,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -75482,8 +75431,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -75687,8 +75635,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -75798,7 +75745,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -75950,7 +75896,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -76030,8 +75975,7 @@ "description": "Added since version: 6.3.1.0", "required": [ "customerGroupId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -76073,8 +76017,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -76142,8 +76085,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -76217,8 +76159,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -76350,8 +76291,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -76408,8 +76348,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -76511,8 +76450,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -76566,8 +76504,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -76683,8 +76620,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -76756,8 +76692,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -76980,8 +76915,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -77082,9 +77016,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -77234,9 +77166,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -77317,8 +77247,7 @@ { "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -77448,8 +77377,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -77504,7 +77432,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -77642,7 +77569,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -77708,8 +77634,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -77828,8 +77753,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -77903,8 +77827,7 @@ { "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -78118,8 +78041,7 @@ "description": "Added since version: 6.4.6.0", "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -78214,8 +78136,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -78247,8 +78168,7 @@ "description": "Added since version: 6.4.18.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -78288,8 +78208,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -78368,8 +78287,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -78427,8 +78345,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -78645,8 +78562,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -78744,8 +78660,7 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { @@ -78850,8 +78765,7 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { @@ -78938,8 +78852,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -79091,8 +79004,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -79235,7 +79147,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -79429,7 +79340,6 @@ "description": "Added since version: 6.4.0.0", "required": [ "id", - "createdAt", "name", "url" ], @@ -79606,8 +79516,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -80083,8 +79992,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -80210,7 +80118,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -80321,7 +80228,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -80384,8 +80290,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -80426,8 +80331,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -80477,7 +80381,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -80564,7 +80467,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -80634,7 +80536,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -80757,7 +80658,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -80880,7 +80780,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -80962,7 +80861,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -81025,8 +80923,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -81166,8 +81063,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -81230,8 +81126,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -82104,8 +81999,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -82416,8 +82310,7 @@ { "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -82483,8 +82376,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -82526,8 +82418,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -82738,8 +82629,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -82827,8 +82717,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -82939,8 +82828,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -83067,8 +82955,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -83154,8 +83041,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -83217,8 +83103,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -83292,8 +83177,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -83347,8 +83231,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -83547,8 +83430,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -83685,8 +83567,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -83800,8 +83681,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -83871,7 +83751,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -84022,7 +83901,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -84100,8 +83978,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -84232,8 +84109,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -84288,8 +84164,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -84358,8 +84233,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -84402,7 +84276,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -84512,7 +84385,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -84583,8 +84455,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -85281,8 +85152,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -85666,8 +85536,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -85913,8 +85782,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -86047,8 +85915,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -86219,8 +86086,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -86327,10 +86193,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -86614,10 +86478,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -86789,8 +86651,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -86972,8 +86833,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -87124,11 +86984,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -87580,11 +87438,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -87839,8 +87695,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -87958,8 +87813,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -88067,8 +87921,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -88303,8 +88156,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -88476,8 +88328,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -88678,8 +88529,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -88844,8 +88694,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -89049,8 +88898,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -89219,8 +89067,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -89401,8 +89248,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -89573,7 +89419,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -89923,7 +89768,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -90084,7 +89928,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -90218,7 +90061,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -90349,7 +90191,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -90418,7 +90259,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -90497,7 +90341,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -91572,7 +91419,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -91656,7 +91502,10 @@ "description": "Unique identity of CMS page's version." }, "price": { - "type": "object", + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + }, "description": "Price of the product." }, "productNumber": { @@ -91756,7 +91605,10 @@ "description": "Indicates weather the shipping price is free or not." }, "purchasePrices": { - "type": "object", + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + }, "description": "Actual/cost price of the product." }, "markAsTopseller": { @@ -92178,8 +92030,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -92328,8 +92179,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -92407,10 +92257,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -92569,10 +92416,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -92664,8 +92508,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -92771,8 +92614,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -92865,8 +92707,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -92979,8 +92820,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -93055,8 +92895,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -93303,8 +93142,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -93428,7 +93266,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -93503,7 +93340,6 @@ "description": "Added since version: 6.3.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -93654,7 +93490,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -93769,7 +93604,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -93840,8 +93674,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -93985,8 +93818,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -94096,8 +93928,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -94121,7 +93952,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -94219,8 +94053,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -94249,7 +94082,10 @@ "description": "Unique identity of the rule." }, "price": { - "type": "object", + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + }, "description": "Price of the Product." }, "quantityStart": { @@ -94334,8 +94170,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -94531,8 +94366,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -94632,10 +94466,7 @@ { "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -94743,10 +94574,7 @@ "description": "Added since version: 6.3.5.0", "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -94807,11 +94635,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -94922,11 +94746,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -94992,8 +94812,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -95108,8 +94927,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -95178,7 +94996,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -95231,7 +95048,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -95291,7 +95107,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -95467,7 +95282,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -95549,8 +95363,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -95701,8 +95514,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -95859,8 +95671,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -95967,8 +95778,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -95979,22 +95789,22 @@ "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product visibility." + "description": "Unique identity of the product." }, "productVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product visibility." + "description": "Unique identity of the product's version." }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product visibility." + "description": "Unique identity of the sales channel." }, "visibility": { "type": "integer", "format": "int64", - "description": "Unique identity of product visibility." + "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listing`, `20` indicates `Hide in listings and search` and `30` indicates `Visible` everywhere." }, "createdAt": { "type": "string", @@ -96024,14 +95834,6 @@ { "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -96414,14 +96216,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -96633,8 +96427,7 @@ "scope", "type", "value", - "considerAdvancedRules", - "createdAt" + "considerAdvancedRules" ], "properties": { "id": { @@ -96793,8 +96586,7 @@ "scope", "type", "value", - "considerAdvancedRules", - "createdAt" + "considerAdvancedRules" ], "properties": { "id": { @@ -96884,8 +96676,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -96988,8 +96779,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -97072,8 +96862,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -97144,8 +96933,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -97286,8 +97074,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -97390,8 +97177,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -97445,8 +97231,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -97554,8 +97339,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -97643,9 +97427,6 @@ { "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -97736,9 +97517,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -97813,7 +97591,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -98021,7 +97798,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -98108,8 +97884,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -98603,8 +98378,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -98757,8 +98531,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -98933,8 +98706,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -99051,7 +98823,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -100387,7 +100158,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -100810,8 +100580,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -100882,8 +100651,7 @@ "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -100998,8 +100766,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -101235,8 +101002,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -101412,7 +101178,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -101505,7 +101270,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -101581,7 +101345,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -101785,7 +101548,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -101871,9 +101633,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -101928,9 +101688,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -101995,8 +101753,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -102075,8 +101832,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -102133,8 +101889,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -102268,8 +102023,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -102357,8 +102111,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -102438,8 +102191,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -102498,8 +102250,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -102876,8 +102626,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -103009,8 +102757,7 @@ { "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -103042,7 +102789,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -103158,8 +102908,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -103198,7 +102947,10 @@ "description": "Ending range of quantity of an item." }, "currencyPrice": { - "type": "object", + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + }, "description": "Contains currency-based price." }, "customFields": { @@ -103270,8 +103022,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -103350,8 +103101,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -103407,8 +103157,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -103515,8 +103264,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -103574,7 +103322,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -103716,7 +103463,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -103789,8 +103535,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -103972,8 +103717,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -104058,7 +103802,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -104416,7 +104159,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -104528,8 +104270,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -104668,8 +104409,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -104732,8 +104472,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -104809,8 +104548,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -104861,8 +104599,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -105175,8 +104912,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -105265,9 +105001,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -105407,9 +105141,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -105477,7 +105209,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -105599,7 +105330,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -105678,8 +105408,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -105841,8 +105570,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -105933,7 +105661,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -106012,7 +105739,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -106069,8 +105795,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -106269,8 +105994,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -106472,7 +106196,6 @@ { "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -106548,7 +106271,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -106606,9 +106328,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -107115,9 +106835,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -107305,8 +107023,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -107385,8 +107102,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -107442,8 +107158,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -107514,8 +107229,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -107562,8 +107276,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -107631,8 +107344,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -107676,9 +107388,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -107764,9 +107474,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -107832,8 +107540,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -107907,8 +107614,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -108049,6 +107755,162 @@ } } }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "properties": { + "name": { + "description": "Unique name of the businessEventsResponse." + }, + "class": { + "description": "Class name of business event." + }, + "data": { + "description": "Internal field." + }, + "aware": { + "description": "Parameter that indicates the areas in which the business event is supported." + }, + "extensions": { + "description": "Internal field." + } + } + }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", @@ -108173,57 +108035,6 @@ } ] }, - "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" - } - } - } - }, - "properties": { - "name": { - "description": "Unique name of the businessEventsResponse." - }, - "class": { - "description": "Class name of business event." - }, - "data": { - "description": "Internal field." - }, - "aware": { - "description": "Parameter that indicates the areas in which the business event is supported." - }, - "extensions": { - "description": "Internal field." - } - } - }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -108394,32 +108205,6 @@ } } }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, "Cart": { "properties": { "id": { From 2979299c868410973d2a8b409827c2211ee413d6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:43:15 +0200 Subject: [PATCH 27/63] [create-pull-request] automated change (#317) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 1310 ++++++++---------- SwagCustomizedProducts-adminapi.summary.json | 1 + 2 files changed, 548 insertions(+), 763 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 38c05dc..9256faa 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.6.5.1" + "version": "6.6.7.0" }, "servers": [ { @@ -5227,9 +5227,7 @@ { "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -5368,9 +5366,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -5426,8 +5422,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "userId", - "aclRoleId", - "createdAt" + "aclRoleId" ], "properties": { "id": { @@ -5472,13 +5467,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -5552,6 +5543,15 @@ "checkoutGatewayUrl": { "type": "string" }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, "label": { "type": "string" }, @@ -5969,13 +5969,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -6049,6 +6045,15 @@ "checkoutGatewayUrl": { "type": "string" }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, "label": { "type": "string" }, @@ -6165,7 +6170,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -6253,7 +6257,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -6310,8 +6313,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -6350,8 +6352,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -6396,7 +6397,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -6484,7 +6484,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -6542,7 +6541,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -6694,7 +6692,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -6792,8 +6789,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -6902,8 +6898,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -6959,8 +6954,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -7116,8 +7110,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -7194,7 +7187,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -7314,7 +7306,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -7380,8 +7371,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -7519,8 +7509,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -7579,8 +7568,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -7656,8 +7644,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -7702,10 +7689,6 @@ { "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -8260,10 +8243,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -8521,8 +8500,7 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -8714,8 +8692,7 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -8826,8 +8803,7 @@ { "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -9079,8 +9055,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -9181,8 +9156,7 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -9365,8 +9339,7 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -9470,8 +9443,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -9570,8 +9542,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -9640,8 +9611,6 @@ { "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -9992,8 +9961,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -10169,7 +10136,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -10317,7 +10283,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -10390,7 +10355,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -10721,7 +10685,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -10873,8 +10836,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -11016,8 +10978,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -11103,8 +11064,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -11166,8 +11126,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -11232,8 +11191,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -11347,8 +11305,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -11408,8 +11365,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -11582,8 +11538,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -11654,8 +11609,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -11723,8 +11677,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -11772,9 +11725,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -12528,9 +12479,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -12790,8 +12739,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -12995,8 +12943,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -13089,7 +13036,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -13241,7 +13187,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -13311,8 +13256,7 @@ "description": "Added since version: 6.3.1.0", "required": [ "customerGroupId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -13351,8 +13295,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -13420,8 +13363,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -13489,8 +13431,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -13622,8 +13563,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -13676,8 +13616,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -13779,8 +13718,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -13830,8 +13768,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -13947,8 +13884,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -14013,8 +13949,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -14237,8 +14172,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -14327,9 +14261,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -14479,9 +14411,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -14551,8 +14481,7 @@ { "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -14682,8 +14611,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -14734,7 +14662,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -14872,7 +14799,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -14933,8 +14859,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -15053,8 +14978,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -15119,8 +15043,7 @@ { "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -15334,8 +15257,7 @@ "description": "Added since version: 6.4.6.0", "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -15418,8 +15340,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -15451,8 +15372,7 @@ "description": "Added since version: 6.4.18.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -15489,8 +15409,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -15569,8 +15488,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -15622,8 +15540,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -15840,8 +15757,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -15927,8 +15843,7 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { @@ -16033,8 +15948,7 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { @@ -16110,8 +16024,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -16263,8 +16176,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -16389,7 +16301,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -16583,7 +16494,6 @@ "description": "Added since version: 6.4.0.0", "required": [ "id", - "createdAt", "name", "url" ], @@ -16739,8 +16649,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -17216,8 +17125,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -17337,7 +17245,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -17448,7 +17355,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -17505,8 +17411,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -17547,8 +17452,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -17593,7 +17497,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -17680,7 +17583,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -17741,7 +17643,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -17864,7 +17765,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -17972,7 +17872,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -18054,7 +17953,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -18110,8 +18008,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -18251,8 +18148,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -18309,8 +18205,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -19214,8 +19109,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -19541,8 +19435,7 @@ { "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -19608,8 +19501,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -19648,8 +19540,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -19860,8 +19751,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -19940,8 +19830,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -20052,8 +19941,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -20171,8 +20059,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20258,8 +20145,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20316,8 +20202,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20391,8 +20276,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -20442,8 +20326,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -20642,8 +20525,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -20762,8 +20644,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -20877,8 +20758,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -20941,7 +20821,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -21092,7 +20971,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -21161,8 +21039,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -21293,8 +21170,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -21345,8 +21221,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -21415,8 +21290,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -21457,7 +21331,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -21567,7 +21440,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -21632,8 +21504,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -22330,8 +22201,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -22665,8 +22535,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -22912,8 +22781,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -23026,8 +22894,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -23198,8 +23065,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -23291,10 +23157,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -23578,10 +23442,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -23731,8 +23593,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -23914,8 +23775,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -24046,11 +23906,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -24079,8 +23937,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -24503,11 +24360,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -24536,8 +24391,7 @@ }, "promotionId": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -24727,8 +24581,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -24846,8 +24699,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -24943,8 +24795,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -25179,8 +25030,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -25309,8 +25159,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25511,8 +25360,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25634,8 +25482,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25839,8 +25686,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -25965,8 +25811,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -26147,8 +25992,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -26273,7 +26117,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -26623,7 +26466,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -26771,7 +26613,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -26905,7 +26746,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -27012,7 +26852,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -27081,7 +26920,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -27160,7 +27002,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -28269,7 +28114,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -28338,7 +28182,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -28417,7 +28264,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -28834,8 +28684,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -28984,8 +28833,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -29054,10 +28902,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29216,10 +29061,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29299,8 +29141,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29406,8 +29247,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -29491,8 +29331,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -29605,8 +29444,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -29674,8 +29512,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -29922,8 +29759,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -30028,7 +29864,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30103,7 +29938,6 @@ "description": "Added since version: 6.3.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30245,7 +30079,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30360,7 +30193,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -30423,8 +30255,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -30568,8 +30399,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -30668,8 +30498,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -30693,7 +30522,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -30791,8 +30623,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -30816,7 +30647,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -30893,8 +30727,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -31090,8 +30923,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -31177,10 +31009,7 @@ { "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -31288,10 +31117,7 @@ "description": "Added since version: 6.3.5.0", "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -31347,11 +31173,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -31462,11 +31284,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -31525,8 +31343,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -31641,8 +31458,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -31704,7 +31520,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -31757,7 +31572,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -31809,7 +31623,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -31985,7 +31798,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -32060,8 +31872,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -32212,8 +32023,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -32350,8 +32160,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -32458,8 +32267,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -32510,14 +32318,6 @@ { "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -32900,14 +32700,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -33095,8 +32887,7 @@ "scope", "type", "value", - "considerAdvancedRules", - "createdAt" + "considerAdvancedRules" ], "properties": { "id": { @@ -33255,8 +33046,7 @@ "scope", "type", "value", - "considerAdvancedRules", - "createdAt" + "considerAdvancedRules" ], "properties": { "id": { @@ -33335,8 +33125,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -33439,8 +33228,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -33516,8 +33304,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -33588,8 +33375,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -33717,8 +33503,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -33821,8 +33606,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -33872,8 +33656,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -33981,8 +33764,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -34062,9 +33844,6 @@ { "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -34155,9 +33934,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -34222,7 +33998,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -34430,7 +34205,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -34509,8 +34283,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -35071,8 +34844,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -35281,8 +35053,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -35457,8 +35228,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -35564,7 +35334,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -36900,7 +36669,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -37285,8 +37053,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -37357,8 +37124,7 @@ "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -37462,8 +37228,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -37699,8 +37464,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -37859,7 +37623,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -37952,7 +37715,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -38019,7 +37781,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -38223,7 +37984,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -38303,9 +38063,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -38360,9 +38118,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -38419,8 +38175,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -38499,8 +38254,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -38552,8 +38306,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -38687,8 +38440,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -38765,8 +38517,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -38846,8 +38597,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -38899,8 +38649,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -39277,8 +39025,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -39397,8 +39143,7 @@ { "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -39430,7 +39175,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -39546,8 +39294,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -39579,7 +39326,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -39646,8 +39396,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -39726,8 +39475,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -39777,8 +39525,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -39885,8 +39632,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -39940,7 +39686,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -40082,7 +39827,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -40151,8 +39895,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -40334,8 +40077,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -40408,7 +40150,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -40766,7 +40507,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -40872,8 +40612,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -41012,8 +40751,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -41069,7 +40807,6 @@ "required": [ "id", "internalName", - "createdAt", "displayName" ], "properties": { @@ -41294,7 +41031,6 @@ "required": [ "id", "internalName", - "createdAt", "displayName" ], "properties": { @@ -41392,8 +41128,7 @@ "id", "hash", "configuration", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41503,8 +41238,7 @@ "id", "hash", "configuration", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41559,9 +41293,7 @@ { "required": [ "id", - "oneTime", - "templateConfigurationId", - "createdAt" + "templateConfigurationId" ], "properties": { "id": { @@ -41635,9 +41367,7 @@ "SwagCustomizedProductsTemplateConfigurationShare": { "required": [ "id", - "oneTime", - "templateConfigurationId", - "createdAt" + "templateConfigurationId" ], "properties": { "id": { @@ -41684,8 +41414,7 @@ "required": [ "id", "name", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41791,8 +41520,7 @@ "required": [ "id", "name", - "templateId", - "createdAt" + "templateId" ], "properties": { "id": { @@ -41846,8 +41574,7 @@ "id", "templateExclusionId", "templateOptionId", - "templateExclusionOperatorId", - "createdAt" + "templateExclusionOperatorId" ], "properties": { "id": { @@ -42021,8 +41748,7 @@ "id", "templateExclusionId", "templateOptionId", - "templateExclusionOperatorId", - "createdAt" + "templateExclusionOperatorId" ], "properties": { "id": { @@ -42084,8 +41810,7 @@ "SwagCustomizedProductsTemplateExclusionConditionValues": { "required": [ "templateExclusionConditionId", - "templateOptionValueId", - "createdAt" + "templateOptionValueId" ], "properties": { "id": { @@ -42137,7 +41862,6 @@ "id", "operator", "templateOptionType", - "createdAt", "label" ], "properties": { @@ -42213,7 +41937,6 @@ "id", "operator", "templateOptionType", - "createdAt", "label" ], "properties": { @@ -42262,7 +41985,6 @@ "id", "type", "templateId", - "createdAt", "displayName" ], "properties": { @@ -42313,7 +42035,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "calculatedPrice": { "type": "object" @@ -42509,7 +42234,6 @@ "id", "type", "templateId", - "createdAt", "displayName" ], "properties": { @@ -42560,7 +42284,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "calculatedPrice": { "type": "object" @@ -42625,8 +42352,7 @@ { "required": [ "id", - "templateOptionId", - "createdAt" + "templateOptionId" ], "properties": { "id": { @@ -42646,7 +42372,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -42737,8 +42466,7 @@ "SwagCustomizedProductsTemplateOptionPrice": { "required": [ "id", - "templateOptionId", - "createdAt" + "templateOptionId" ], "properties": { "id": { @@ -42758,7 +42486,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -42797,7 +42528,6 @@ "id", "templateOptionId", "position", - "createdAt", "displayName" ], "properties": { @@ -42843,7 +42573,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43001,7 +42734,6 @@ "id", "templateOptionId", "position", - "createdAt", "displayName" ], "properties": { @@ -43047,7 +42779,10 @@ "format": "int64" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43099,8 +42834,7 @@ { "required": [ "id", - "templateOptionValueId", - "createdAt" + "templateOptionValueId" ], "properties": { "id": { @@ -43120,7 +42854,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43211,8 +42948,7 @@ "SwagCustomizedProductsTemplateOptionValuePrice": { "required": [ "id", - "templateOptionValueId", - "createdAt" + "templateOptionValueId" ], "properties": { "id": { @@ -43232,7 +42968,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "percentageSurcharge": { "type": "number", @@ -43271,8 +43010,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -43348,8 +43086,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -43396,8 +43133,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -43710,8 +43446,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -43798,9 +43533,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -44007,9 +43740,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -44140,7 +43871,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -44262,7 +43992,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -44331,8 +44060,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -44494,8 +44222,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -44576,7 +44303,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -44655,7 +44381,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -44707,8 +44432,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -44907,8 +44631,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -45086,7 +44809,6 @@ { "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -45162,7 +44884,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -45215,9 +44936,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -45724,9 +45443,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -45901,8 +45618,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -45981,8 +45697,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -46032,8 +45747,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -46104,8 +45818,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -46148,8 +45861,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -46217,8 +45929,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -46259,9 +45970,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -46347,9 +46056,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -46408,8 +46115,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -46483,8 +46189,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -46549,32 +46254,6 @@ }, "type": "object" }, - "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" - } - } - } - }, "infoConfigResponse": { "type": "object", "properties": { @@ -46637,140 +46316,142 @@ } } }, - "Criteria": { + "Price": { "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)", + "description": "Price object", "properties": { - "page": { - "description": "Search result page", - "type": "integer" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "limit": { - "description": "Number of items per result page", - "type": "integer" + "gross": { + "description": "", + "type": "number" }, - "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" - ] - } + "net": { + "description": "", + "type": "number" }, - "sort": { - "type": "array", - "description": "Sorting in the search result.", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string" - }, - "order": { - "type": "string" - }, - "naturalSorting": { - "type": "boolean" - } - }, - "required": [ - "field" - ] - } + "linked": { + "description": "", + "type": "boolean" }, - "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" - } + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "required": [ - "type", - "field", - "value" - ] - } + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] }, - "associations": { + "regulationPrice": { + "description": "", "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" - } + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "required": [ - "name", - "type", - "field" - ] - } - }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "Name of a field" + "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" } - }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { + } + } + }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "Name of a field" + "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" + } } - }, - "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" - ] } } }, @@ -46898,37 +46579,140 @@ } ] }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { + "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 the event" - }, - "class": { + "description": "Name of a field" + } + }, + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { "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" - } + "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" + ] } } } diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index a3268e6..ffc21ce 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -200,6 +200,7 @@ "PaymentMethodJsonApi", "Plugin", "PluginJsonApi", + "Price", "Product", "ProductCategory", "ProductCategoryTree", From 266645d6437ed88a4c2ce93a301a30cc796b403b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:44:05 +0200 Subject: [PATCH 28/63] [create-pull-request] automated change (#320) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 49382 ++++++++++++++++++ SwagDigitalSalesRooms-adminapi.summary.json | 1 + 2 files changed, 49383 insertions(+) create mode 100644 SwagDigitalSalesRooms-adminapi.json diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json new file mode 100644 index 0000000..18c1962 --- /dev/null +++ b/SwagDigitalSalesRooms-adminapi.json @@ -0,0 +1,49382 @@ +{ + "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.7.0" + }, + "servers": [ + { + "url": "http://localhost:8000/api" + } + ], + "paths": { + "/dsr-appointment": { + "get": { + "tags": [ + "Dsr Appointment" + ], + "summary": "List with basic information of Dsr Appointment resources.", + "description": "", + "operationId": "getDsrAppointmentList", + "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 Dsr Appointment 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/DsrAppointment" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment?limit=25" + }, + "last": { + "example": "/dsr-appointment?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Appointment" + ], + "summary": "Create a new Dsr Appointment resources.", + "description": "", + "operationId": "createDsrAppointment", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-appointment": { + "post": { + "tags": [ + "Dsr Appointment" + ], + "summary": "Search for the Dsr Appointment resources.", + "description": "", + "operationId": "searchDsrAppointment", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment/{id}": { + "get": { + "tags": [ + "Dsr Appointment" + ], + "summary": "Detailed information about a Dsr Appointment resource.", + "description": "", + "operationId": "getDsrAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Appointment" + ], + "summary": "Delete a Dsr Appointment resource.", + "description": "", + "operationId": "deleteDsrAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment" + ], + "summary": "Partially update information about a Dsr Appointment resource.", + "description": "", + "operationId": "updateDsrAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Appointment resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-attendee": { + "get": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "List with basic information of Dsr Appointment Attendee resources.", + "description": "", + "operationId": "getDsrAppointmentAttendeeList", + "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 Dsr Appointment Attendee 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/DsrAppointmentAttendee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-attendee?limit=25" + }, + "last": { + "example": "/dsr-appointment-attendee?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-attendee?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-attendee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "Create a new Dsr Appointment Attendee resources.", + "description": "", + "operationId": "createDsrAppointmentAttendee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-appointment-attendee": { + "post": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "Search for the Dsr Appointment Attendee resources.", + "description": "", + "operationId": "searchDsrAppointmentAttendee", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-attendee/{id}": { + "get": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "getDsrAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "Delete a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "deleteDsrAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "updateDsrAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Appointment Attendee resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentAttendee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-request": { + "get": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "List with basic information of Dsr Appointment Request resources.", + "description": "", + "operationId": "getDsrAppointmentRequestList", + "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 Dsr Appointment Request 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/DsrAppointmentRequest" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-request?limit=25" + }, + "last": { + "example": "/dsr-appointment-request?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-request?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-request?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "Create a new Dsr Appointment Request resources.", + "description": "", + "operationId": "createDsrAppointmentRequest", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentRequest", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-appointment-request": { + "post": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "Search for the Dsr Appointment Request resources.", + "description": "", + "operationId": "searchDsrAppointmentRequest", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAppointmentRequest", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-request/{id}": { + "get": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "Detailed information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "getDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAppointmentRequest", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "Delete a Dsr Appointment Request resource.", + "description": "", + "operationId": "deleteDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "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": [ + "Dsr Appointment Request" + ], + "summary": "Partially update information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "updateDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "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 Dsr Appointment Request resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentRequest", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-video-chat": { + "get": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "List with basic information of Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "getDsrAppointmentVideoChatList", + "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 Dsr Appointment Video Chat 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/DsrAppointmentVideoChat" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-video-chat?limit=25" + }, + "last": { + "example": "/dsr-appointment-video-chat?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-video-chat?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-video-chat?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Create a new Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "createDsrAppointmentVideoChat", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-appointment-video-chat": { + "post": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Search for the Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "searchDsrAppointmentVideoChat", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-video-chat/{id}": { + "get": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Detailed information about a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "getDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Delete a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "deleteDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Partially update information about a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "updateDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Appointment Video Chat resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-attendee-product-collection": { + "get": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "List with basic information of Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "getDsrAttendeeProductCollectionList", + "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 Dsr Attendee Product Collection 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/DsrAttendeeProductCollection" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-attendee-product-collection?limit=25" + }, + "last": { + "example": "/dsr-attendee-product-collection?limit=25&page=11" + }, + "next": { + "example": "/dsr-attendee-product-collection?limit=25&page=4" + }, + "prev": { + "example": "/dsr-attendee-product-collection?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Create a new Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "createDsrAttendeeProductCollection", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-attendee-product-collection": { + "post": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Search for the Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "searchDsrAttendeeProductCollection", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-attendee-product-collection/{id}": { + "get": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Detailed information about a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "getDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Delete a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "deleteDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Partially update information about a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "updateDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Attendee Product Collection resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-interaction": { + "get": { + "tags": [ + "Dsr Interaction" + ], + "summary": "List with basic information of Dsr Interaction resources.", + "description": "", + "operationId": "getDsrInteractionList", + "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 Dsr Interaction 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/DsrInteraction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-interaction?limit=25" + }, + "last": { + "example": "/dsr-interaction?limit=25&page=11" + }, + "next": { + "example": "/dsr-interaction?limit=25&page=4" + }, + "prev": { + "example": "/dsr-interaction?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Create a new Dsr Interaction resources.", + "description": "", + "operationId": "createDsrInteraction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-interaction": { + "post": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Search for the Dsr Interaction resources.", + "description": "", + "operationId": "searchDsrInteraction", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-interaction/{id}": { + "get": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Detailed information about a Dsr Interaction resource.", + "description": "", + "operationId": "getDsrInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Delete a Dsr Interaction resource.", + "description": "", + "operationId": "deleteDsrInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Partially update information about a Dsr Interaction resource.", + "description": "", + "operationId": "updateDsrInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Interaction resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation": { + "get": { + "tags": [ + "Dsr Presentation" + ], + "summary": "List with basic information of Dsr Presentation resources.", + "description": "", + "operationId": "getDsrPresentationList", + "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 Dsr Presentation 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/DsrPresentation" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-presentation?limit=25" + }, + "last": { + "example": "/dsr-presentation?limit=25&page=11" + }, + "next": { + "example": "/dsr-presentation?limit=25&page=4" + }, + "prev": { + "example": "/dsr-presentation?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Create a new Dsr Presentation resources.", + "description": "", + "operationId": "createDsrPresentation", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-presentation": { + "post": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Search for the Dsr Presentation resources.", + "description": "", + "operationId": "searchDsrPresentation", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation/{id}": { + "get": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Detailed information about a Dsr Presentation resource.", + "description": "", + "operationId": "getDsrPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Delete a Dsr Presentation resource.", + "description": "", + "operationId": "deleteDsrPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Partially update information about a Dsr Presentation resource.", + "description": "", + "operationId": "updateDsrPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Presentation resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation-cms-page": { + "get": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "List with basic information of Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPageList", + "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 Dsr Presentation Cms Page 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/DsrPresentationCmsPage" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-presentation-cms-page?limit=25" + }, + "last": { + "example": "/dsr-presentation-cms-page?limit=25&page=11" + }, + "next": { + "example": "/dsr-presentation-cms-page?limit=25&page=4" + }, + "prev": { + "example": "/dsr-presentation-cms-page?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Create a new Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDsrPresentationCmsPage", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } + ], + "requestBody": { + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-presentation-cms-page": { + "post": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Search for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDsrPresentationCmsPage", + "requestBody": { + "required": true, + "content": { + "application/vnd.api+json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation-cms-page/{id}": { + "get": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Detailed information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Delete a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "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": [ + "Dsr Presentation Cms Page" + ], + "summary": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Presentation Cms Page resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinAppointmentResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/start": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/end": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "End a presentation for a appointment", + "description": "Complete all needed data and remove unneeded to close the presentation", + "operationId": "endAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the sw-context-token for a attendee", + "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", + "operationId": "getAttendeeToken", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "The sw-context-token from the attendee", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attendee-sw-context-token": { + "type": "string" + } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" + } + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/instant-listing": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "productIds" + ], + "properties": { + "productIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Created a new instant listing", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The current index of the instant listing which is created by this request" + } + }, + "example": { + "index": 1 + } + } + } + } + } + } + }, + "patch": { + "tags": [ + "Appointment" + ], + "summary": "Update a instant listing from the presentation", + "description": "Updates the products for the given listing", + "operationId": "updateInstantListing", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], + "properties": { + "addProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "removeProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be removed to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Updated the instant listing", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the instant listing page" + }, + "pickedProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which are picked for the instant listing" + }, + "title": { + "type": "string", + "description": "The title of the instant listing" + } + }, + "example": { + "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", + "pickedProductIds": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ], + "title": "Default Digital Sales Rooms product listing page" + } + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidePresentationStateResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VideoChatCreateStruct" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Appointment" + ], + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": [] + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get attendee insights", + "description": "Get attendee insights for the given appointment", + "operationId": "getAttendeeInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get cart insights", + "description": "Get cart insights for the given appointment", + "operationId": "getCartInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCartInsightsResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get cart statistics", + "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", + "operationId": "getCartStatistics", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get last seen products insights", + "description": "Get last seen products of all attendees for the given appointment", + "operationId": "getLastSeenProductsInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "limit": { + "type": "integer", + "description": "The limit of the products which should be returned", + "default": 10 + }, + "page": { + "type": "integer", + "description": "The page of the products which should be returned", + "default": 1 + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The attendee id for which the last seen products should be returned" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" + } + }, + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" + } + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Get ids of last seen products", + "description": "Get all product ids of that attendee has seen", + "operationId": "getLastSeenProductIds", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "collection": { + "type": "object", + "properties": { + "lastSeen": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "example": { + "collection": { + "lastSeen": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ] + } + } + } + } + } + } + } + } + } + }, + "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" + ], + "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" + ], + "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" + ], + "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", + "version", + "integrationId", + "aclRoleId", + "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" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "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", + "version", + "integrationId", + "aclRoleId", + "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" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "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", + "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", + "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" + ], + "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" + ], + "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", + "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", + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "template", + "path", + "active", + "appId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + }, + "extensions": { + "properties": { + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "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" + }, + "extensions": { + "properties": { + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "sections": { + "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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "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 + }, + "translated": { + "type": "object" + }, + "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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "type": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "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 + }, + "translated": { + "type": "object" + }, + "page": { + "$ref": "#/components/schemas/CmsPage" + }, + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + }, + "type": "object" + }, + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "slot": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "block": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_block" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "14511f2f5564650d129ca7cabc333278" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "slot": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "block": { + "$ref": "#/components/schemas/CmsBlock" + } + }, + "type": "object" + }, + "CountryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "type": "string" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "shippingAvailable": { + "type": "boolean" + }, + "iso3": { + "type": "string" + }, + "displayStateInRegistration": { + "type": "boolean" + }, + "forceStateInRegistration": { + "type": "boolean" + }, + "checkVatIdPattern": { + "type": "boolean" + }, + "vatIdRequired": { + "type": "boolean" + }, + "vatIdPattern": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "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", + "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", + "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", + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "defaultPaymentMethodId" + ], + "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 + }, + "extensions": { + "properties": { + "attendee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "group": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "db0f6f37ebeb6ea09489124345af2a45" + } + } + } + }, + "type": "object" + }, + "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", + "defaultPaymentMethodId" + ], + "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 + }, + "extensions": { + "properties": { + "attendee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "type": "object" + }, + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "wishlistId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "wishlist": { + "properties": { + "links": { + "type": "object", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "wishlist": { + "$ref": "#/components/schemas/CustomerWishlist" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "DeliveryTimeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "min", + "max", + "unit" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "min": { + "type": "integer", + "format": "int64" + }, + "max": { + "type": "integer", + "format": "int64" + }, + "unit": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "shippingMethods": { + "properties": { + "links": { + "type": "object", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + }, + "DsrAppointmentJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "presentationId", + "salesChannelDomainId", + "presentationPath", + "name", + "createdById" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "presentationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "dsrPresentationVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "salesChannelDomainId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "presentationPath": { + "type": "string" + }, + "accessibleFrom": { + "type": "string", + "format": "date-time" + }, + "accessibleTo": { + "type": "string", + "format": "date-time" + }, + "attendeeRuleIds": { + "type": "object" + }, + "guideUserId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mode": { + "type": "string" + }, + "message": { + "type": "string" + }, + "attendeeRestrictionType": { + "type": "string" + }, + "isPreview": { + "type": "boolean" + }, + "videoAudioSettings": { + "type": "string" + }, + "name": { + "type": "string" + }, + "startedAt": { + "type": "string", + "format": "date-time" + }, + "endedAt": { + "type": "string", + "format": "date-time" + }, + "default": { + "type": "boolean" + }, + "canSendRequestEmail": { + "type": "boolean" + }, + "canBookNewAppointment": { + "type": "boolean" + }, + "bookingLink": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "presentation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/presentation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2486923a98e77fd0740381d01acd1782" + } + } + } + }, + "type": "object" + }, + "videoChat": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/videoChat" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_video_chat" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b23b1765cc6500512065f5a39a713b75" + } + } + } + }, + "type": "object" + }, + "guideUser": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/guideUser" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7d58fd6cf68b2c4c00b51069f10a25eb" + } + } + } + }, + "type": "object" + }, + "salesChannelDomain": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/salesChannelDomain" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel_domain" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "29c8b34b04e94e35e95e8346954b7fb4" + } + } + } + }, + "type": "object" + }, + "attendees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/attendees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "example": "4d77992a742c290d1e37290f3986fd4e" + } + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/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": "/dsr-appointment/d4b6eb231829bcaaa3d1e4689cded46e/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" + } + ] + }, + "DsrAppointment": { + "required": [ + "id", + "presentationId", + "salesChannelDomainId", + "presentationPath", + "name", + "createdById" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "presentationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "dsrPresentationVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "salesChannelDomainId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "presentationPath": { + "type": "string" + }, + "accessibleFrom": { + "type": "string", + "format": "date-time" + }, + "accessibleTo": { + "type": "string", + "format": "date-time" + }, + "attendeeRuleIds": { + "type": "object" + }, + "guideUserId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mode": { + "type": "string" + }, + "message": { + "type": "string" + }, + "attendeeRestrictionType": { + "type": "string" + }, + "isPreview": { + "type": "boolean" + }, + "videoAudioSettings": { + "type": "string" + }, + "name": { + "type": "string" + }, + "startedAt": { + "type": "string", + "format": "date-time" + }, + "endedAt": { + "type": "string", + "format": "date-time" + }, + "default": { + "type": "boolean" + }, + "canSendRequestEmail": { + "type": "boolean" + }, + "canBookNewAppointment": { + "type": "boolean" + }, + "bookingLink": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "presentation": { + "$ref": "#/components/schemas/DsrPresentation" + }, + "videoChat": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + }, + "guideUser": { + "$ref": "#/components/schemas/User" + }, + "salesChannelDomain": { + "$ref": "#/components/schemas/SalesChannelDomain" + }, + "attendees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "DsrAppointmentAttendeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appointmentId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "guideCartPermissionsGranted": { + "type": "boolean" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "videoUserId": { + "type": "string" + }, + "attendeeName": { + "type": "string" + }, + "attendeeEmail": { + "type": "string" + }, + "type": { + "type": "string" + }, + "invitationStatus": { + "type": "string" + }, + "joinedAt": { + "type": "string", + "format": "date-time" + }, + "lastActive": { + "type": "string", + "format": "date-time" + }, + "isBlocked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "appointment": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/appointment" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b1caa385c37f1fec467494c8fde4f49b" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "user": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/user" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ee11cbb19052e40b07aac0ca060c23ee" + } + } + } + }, + "type": "object" + }, + "interactions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/interactions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_interaction" + }, + "id": { + "type": "string", + "example": "85aa9c704a544e104741012bf72b6572" + } + } + } + } + }, + "type": "object" + }, + "productCollections": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-attendee/6013089be5c669cea75294147f34dbc0/productCollections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_attendee_product_collection" + }, + "id": { + "type": "string", + "example": "3fa1ecbee1fa3d24671a2e81d9b71d17" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DsrAppointmentAttendee": { + "required": [ + "id", + "appointmentId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "guideCartPermissionsGranted": { + "type": "boolean" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "videoUserId": { + "type": "string" + }, + "attendeeName": { + "type": "string" + }, + "attendeeEmail": { + "type": "string" + }, + "type": { + "type": "string" + }, + "invitationStatus": { + "type": "string" + }, + "joinedAt": { + "type": "string", + "format": "date-time" + }, + "lastActive": { + "type": "string", + "format": "date-time" + }, + "isBlocked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "appointment": { + "$ref": "#/components/schemas/DsrAppointment" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "user": { + "$ref": "#/components/schemas/User" + }, + "interactions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + }, + "productCollections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + }, + "type": "object" + }, + "DsrAppointmentRequestJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appointmentId", + "salutationId", + "firstName", + "lastName", + "emailAddress", + "subject", + "requestedById" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "companyName": { + "type": "string" + }, + "emailAddress": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "message": { + "type": "string" + }, + "requestedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handledById": { + "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": { + "appointment": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/appointment" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b1caa385c37f1fec467494c8fde4f49b" + } + } + } + }, + "type": "object" + }, + "salutation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + } + } + } + }, + "type": "object" + }, + "requester": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/requester" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0bc2b09c07005b410cae62912ae70206" + } + } + } + }, + "type": "object" + }, + "handler": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-request/3c71739b4a19fe331ce2b32a35e8ef4d/handler" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c1cbfe271a40788a00e8bf8574d94d4b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DsrAppointmentRequest": { + "required": [ + "id", + "appointmentId", + "salutationId", + "firstName", + "lastName", + "emailAddress", + "subject", + "requestedById" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "companyName": { + "type": "string" + }, + "emailAddress": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "subject": { + "type": "string" + }, + "message": { + "type": "string" + }, + "requestedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handledById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "appointment": { + "$ref": "#/components/schemas/DsrAppointment" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "requester": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + }, + "handler": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "DsrAppointmentVideoChatJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appointmentId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "ownerToken": { + "type": "string" + }, + "userToken": { + "type": "string" + }, + "url": { + "type": "string" + }, + "startAsBroadcast": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "appointment": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-appointment-video-chat/21851f23492d55e9e0c82d97fd789730/appointment" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b1caa385c37f1fec467494c8fde4f49b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DsrAppointmentVideoChat": { + "required": [ + "id", + "appointmentId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appointmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "ownerToken": { + "type": "string" + }, + "userToken": { + "type": "string" + }, + "url": { + "type": "string" + }, + "startAsBroadcast": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "appointment": { + "$ref": "#/components/schemas/DsrAppointment" + } + }, + "type": "object" + }, + "DsrAttendeeProductCollectionJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "attendeeId", + "productId", + "alias" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "alias": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "attendee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-attendee-product-collection/a8b5d04acd1993d5f7b24baee1b1fc33/attendee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-attendee-product-collection/a8b5d04acd1993d5f7b24baee1b1fc33/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" + } + ] + }, + "DsrAttendeeProductCollection": { + "required": [ + "id", + "attendeeId", + "productId", + "alias" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "alias": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "attendee": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "DsrInteractionJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "triggeredAt", + "attendeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "triggeredAt": { + "type": "string", + "format": "date-time" + }, + "payload": { + "type": "object" + }, + "attendeeId": { + "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": { + "attendee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-interaction/3d3949b2e83fa3ca98a32f354273a62a/attendee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DsrInteraction": { + "required": [ + "id", + "name", + "triggeredAt", + "attendeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "triggeredAt": { + "type": "string", + "format": "date-time" + }, + "payload": { + "type": "object" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "attendee": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + }, + "type": "object" + }, + "DsrPresentationJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "createdById", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "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": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" + } + } + } + }, + "type": "object" + }, + "appointments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/appointments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "2417b53255206bdce189add39d85fca1" + } + } + } + } + }, + "type": "object" + }, + "cmsPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/cmsPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_cms_page" + }, + "id": { + "type": "string", + "example": "e676148cc6ffb82b89b3903ecaed2d16" + } + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/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": "/dsr-presentation/f770a896b93bc3b86dbb8be6f107a869/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" + } + ] + }, + "DsrPresentation": { + "required": [ + "id", + "createdById", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "parent": { + "$ref": "#/components/schemas/DsrPresentation" + }, + "appointments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + }, + "cmsPages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + } + }, + "type": "object" + }, + "DsrPresentationCmsPageJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "presentationId", + "cmsPageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "presentationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "dsrPresentationVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "title": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pickedProductIds": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "isInstantListing": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "presentation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/presentation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2486923a98e77fd0740381d01acd1782" + } + } + } + }, + "type": "object" + }, + "cmsPage": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/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": "/dsr-presentation-cms-page/e8696be98208356b4da4a941d92738fe/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DsrPresentationCmsPage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "presentationId", + "cmsPageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "presentationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "dsrPresentationVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "title": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "slotConfig": { + "type": "object" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pickedProductIds": { + "type": "object" + }, + "position": { + "type": "integer", + "format": "int64" + }, + "isInstantListing": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "presentation": { + "$ref": "#/components/schemas/DsrPresentation" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "product": { + "$ref": "#/components/schemas/Product" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + } + }, + "type": "object" + }, + "FlowJsonApi": { + "description": "Added since version: 6.4.6.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "eventName" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "config": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + } + ] + }, + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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 + }, + "extensions": { + "properties": { + "presentationTranslation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_translation" + }, + "id": { + "type": "string", + "example": "e22d79f2b1909484a375a5dc228ef751" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "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 + }, + "extensions": { + "properties": { + "presentationTranslation": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/presentationTranslation" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_translation" + }, + "id": { + "type": "string", + "example": "e22d79f2b1909484a375a5dc228ef751" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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", + "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", + "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" + ], + "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" + ], + "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", + "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", + "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", + "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", + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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": [ + "url", + "mediaId", + "width", + "height" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "shippingDateEarliest", + "shippingDateLatest" + ], + "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", + "shippingDateEarliest", + "shippingDateLatest" + ], + "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" + ], + "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" + ], + "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", + "states", + "price", + "children" + ], + "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", + "states", + "price", + "children" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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", + "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", + "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", + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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" + }, + "extensions": { + "properties": { + "attendeeProductCollections": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_attendee_product_collection" + }, + "id": { + "type": "string", + "example": "0a7b3b2f4b81f36910a74f22826f35df" + } + } + } + } + }, + "type": "object" + }, + "presentationCmsPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_cms_page" + }, + "id": { + "type": "string", + "example": "30c725082807b69914fddd7e82d0d741" + } + } + } + } + }, + "type": "object" + } + }, + "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", + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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" + }, + "extensions": { + "properties": { + "attendeeProductCollections": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/attendeeProductCollections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_attendee_product_collection" + }, + "id": { + "type": "string", + "example": "0a7b3b2f4b81f36910a74f22826f35df" + } + } + } + } + }, + "type": "object" + }, + "presentationCmsPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/presentationCmsPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_cms_page" + }, + "id": { + "type": "string", + "example": "30c725082807b69914fddd7e82d0d741" + } + } + } + } + }, + "type": "object" + } + }, + "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" + ], + "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" + ], + "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", + "productId" + ], + "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", + "productId" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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", + "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", + "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" + ], + "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" + ], + "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" + } + }, + "thumbnails": { + "$ref": "#/components/schemas/MediaThumbnail" + } + }, + "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" + ], + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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" + ], + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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", + "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" + }, + "extensions": { + "properties": { + "presentationCmsPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_cms_page" + }, + "id": { + "type": "string", + "example": "30c725082807b69914fddd7e82d0d741" + } + } + } + } + }, + "type": "object" + } + }, + "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", + "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" + }, + "extensions": { + "properties": { + "presentationCmsPages": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/presentationCmsPages" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation_cms_page" + }, + "id": { + "type": "string", + "example": "30c725082807b69914fddd7e82d0d741" + } + } + } + } + }, + "type": "object" + } + }, + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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 + }, + "extensions": { + "properties": { + "dsrAppointmentGuideSalesChannelDomain": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/dsrAppointmentGuideSalesChannelDomain" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "d68bf355eb36d46d6fa55a4db7696181" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "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 + }, + "extensions": { + "properties": { + "dsrAppointmentGuideSalesChannelDomain": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel-domain/e8e8de5eb87653b51534931bb0714095/dsrAppointmentGuideSalesChannelDomain" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "d68bf355eb36d46d6fa55a4db7696181" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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", + "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", + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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" + ], + "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": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + ], + "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", + "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", + "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" + ], + "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" + }, + "dsrAppointmentGuideUser": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/dsrAppointmentGuideUser" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "e8e8e4db862bed157007764e46f5aecb" + } + } + } + } + }, + "type": "object" + }, + "createdPresentations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "example": "d1e11035d87216918d95e78a7ac396da" + } + } + } + } + }, + "type": "object" + }, + "updatedPresentations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "example": "49fb9c4fad69d4a3da998a936016c88d" + } + } + } + } + }, + "type": "object" + }, + "createdAppointments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "888e350c3c9a465bc4d7c8a80840b2aa" + } + } + } + } + }, + "type": "object" + }, + "updatedAppointments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "b64277a1e650794e2c57924c07825014" + } + } + } + } + }, + "type": "object" + }, + "createdLayouts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "example": "22b76a69d00feab60733ea096895a432" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "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" + }, + "dsrAppointmentGuideUser": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/dsrAppointmentGuideUser" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "e8e8e4db862bed157007764e46f5aecb" + } + } + } + } + }, + "type": "object" + }, + "createdPresentations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "example": "d1e11035d87216918d95e78a7ac396da" + } + } + } + } + }, + "type": "object" + }, + "updatedPresentations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_presentation" + }, + "id": { + "type": "string", + "example": "49fb9c4fad69d4a3da998a936016c88d" + } + } + } + } + }, + "type": "object" + }, + "createdAppointments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "888e350c3c9a465bc4d7c8a80840b2aa" + } + } + } + } + }, + "type": "object" + }, + "updatedAppointments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment" + }, + "id": { + "type": "string", + "example": "b64277a1e650794e2c57924c07825014" + } + } + } + } + }, + "type": "object" + }, + "createdLayouts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "example": "22b76a69d00feab60733ea096895a432" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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." + } + } + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "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" + } + } + } + }, + "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" + } + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "refresh_token" + ] + } + ] + }, + "Criteria": { + "type": "object", + "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", + "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" + ] + } + } + }, + "GuidePresentationStateResponse": { + "type": "object", + "properties": { + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" + }, + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" + }, + "stateForMe": { + "$ref": "#/components/schemas/StateForMe" + } + }, + "example": { + "extensions": [], + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "allowUserActionsForGuide": true, + "broadcastMode": false, + "extensions": [] + }, + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "guideCartPermissionsGranted": false, + "hasJoined": false + }, + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "guideCartPermissionsGranted": false, + "hasJoined": true + }, + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "guideCartPermissionsGranted": true, + "hasJoined": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "guideCartPermissionsGranted": false, + "hasJoined": true + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "guideCartPermissionsGranted": false, + "hasJoined": false + } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "guideCartPermissionsGranted": false, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + }, + "stateForMe": { + "attendeeId": "018e789e117c701b8d12a64eae0faac8", + "attendeeName": " admin", + "videoUserId": "e57c6922-903e-4b08-a612-20ad921d9b6f", + "guideCartPermissionsGranted": false, + "extensions": [] + } + } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity" + ] + }, + "LineItem": { + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "dataContextHash": { + "type": "string" + }, + "dataTimestamp": { + "type": "string" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { + "type": "string" + }, + "good": { + "type": "boolean" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "$ref": "#/components/schemas/ProductJsonApi" + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + } + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] + }, + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" + } + } + }, + "referencedId": { + "type": "string" + }, + "removable": { + "type": "boolean" + }, + "stackable": { + "type": "boolean" + }, + "states": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { + "type": "string" + } + }, + "required": [ + "id", + "type" + ] + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] + }, + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" + ] + } + } + }, + "height": { + "type": "integer" + }, + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" + } + }, + "required": [ + "apiAlias" + ] + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "GetAttendeeInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current attendees within the appointment.", + "properties": { + "attendees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AttendeeInsights" + } + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencySymbol": { + "type": "string" + } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + }, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" + } + }, + "Cart": { + "type": "object", + "properties": { + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" + }, + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + }, + "errors": { + "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "items": { + "$ref": "#/components/schemas/CartError" + } + }, + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } + }, + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", + "type": "array", + "items": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" + }, + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + } + }, + "modified": { + "type": "boolean" + }, + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true + }, + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true + } + } + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "GetCartInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current carts within the appointment.", + "properties": { + "cartSum": { + "type": "number", + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" + }, + "productCount": { + "type": "number", + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" + }, + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" + }, + "topProducts": { + "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], + "properties": { + "byQuantity": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" + }, + "value": { + "type": "number", + "description": "The quantity in carts of this product" + } + }, + "required": [ + "productId", + "value" + ] + } + }, + "byRevenue": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "object", + "properties": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" + }, + "value": { + "type": "number", + "description": "The net revenue in the shown currency in carts of this product" + } + }, + "required": [ + "productId", + "value" + ] + } + } + } + } + }, + "example": { + "extensions": [], + "cartSum": 6770.53, + "productCount": 3, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$", + "topProducts": { + "byQuantity": [ + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1 + }, + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 1 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 1 + } + ], + "byRevenue": [ + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 5333.03 + }, + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 + } + ] + } + } + }, + "WidgetProductListing": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "extensions": { + "type": "array", + "description": "List of extensions", + "default": [] + }, + "products": { + "type": "array", + "description": "List of last seen products", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "total": { + "type": "integer", + "description": "The total number of products" + }, + "page": { + "type": "integer", + "description": "The current page" + }, + "limit": { + "type": "integer", + "description": "The number of products per page" + } + } + }, + "JoinAppointmentResponse": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "mercureSubscriberTopics": { + "type": "array", + "items": { + "type": "string", + "description": "mercure topic" + }, + "description": "The topics to which the attendee/guide can subscribe for" + }, + "mercurePublisherTopic": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The topic to which the attendee/guide can send updates" + }, + "JWTMercureSubscriberToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to publish updates" + }, + "mercureHubPublicUrl": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The mercure hub url to connect for subscribing and updating" + }, + "JWTMercurePublisherToken": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The JWT mercure token to subscribe for updates" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The appointment id" + }, + "newContextToken": { + "type": "string", + "description": "The new context token" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The created Id for the attendee" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the current sales channel" + }, + "salesChannelName": { + "type": "string", + "description": "The name of the current sales channel" + }, + "appointmentName": { + "type": "string", + "description": "The name of the appointment" + }, + "presentationGuideMode": { + "type": "string", + "enum": [ + "self", + "guided" + ], + "description": "The type of the appointment" + }, + "isPreview": { + "type": "boolean", + "description": "To see if it's a preview appointment" + } + }, + "example": { + "mercureSubscriberTopics": [ + "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" + ], + "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", + "JWTMercureSubscriberToken": "jwt token for subscribing to updates", + "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", + "JWTMercurePublisherToken": "jwt token for publishing updates", + "id": "2d2c358f1ca04098aacf12873c2eed82", + "newContextToken": "new context token to call the other routes", + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", + "salesChannelName": "Storefront", + "appointmentName": "Test Appointment", + "presentationGuideMode": "guided", + "isPreview": false, + "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" + } + }, + "AttendeeInsights": { + "type": "object", + "description": "Attendee Insights", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" + }, + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" + }, + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" + } + }, + "example": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + } + }, + "StateForMe": { + "type": "object", + "properties": { + "attendeeId": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "attendeeName": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "videoUserId": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "guideCartPermissionGranted": { + "type": "boolean", + "default": false + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "PresentationCmsPage": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The presentation cms page id" + }, + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The title of presentation cms page" + }, + "presentationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The presentation using this presentation cms page" + }, + "dsrPresentationVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The CMS page id the presentation using" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The CMS page version id the presentation using" + }, + "productId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ], + "description": "The product id is assigned to presentation if it's product detail" + }, + "productStreamId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ], + "description": "The product stream id is assigned to presentation if it's product listing" + }, + "pickedProductIds": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } + }, + { + "type": "null" + } + ], + "description": "The product id is assigned to presentation if it's product listing or instant listing" + }, + "position": { + "type": "integer", + "description": "The position of slide" + }, + "isInstantListing": { + "type": "boolean", + "description": "True if this slide is an instant listing" + }, + "createdAt": { + "type": "string", + "format": "date-time" + }, + "updatedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "customFields": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ] + }, + "translated": { + "type": "object", + "properties": { + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + }, + "CartError": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + } + } + } + }, + "VideoChatCreateStruct": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" + }, + "roomName": { + "type": "string", + "description": "Name of the video room in daily" + }, + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" + }, + "ownerToken": { + "type": "string", + "description": "Token for the room owner (guide) to connect to the daily room" + }, + "startAsBroadcast": { + "type": "boolean", + "default": false + } + }, + "example": { + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "dummy user token", + "ownerToken": "dummy owner token", + "roomName": "rSq20mrgwsj4eIXo1u95", + "startAsBroadcast": false, + "extensions": [] + } + }, + "CalculatedPrice": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "unitPrice": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "rawTotal": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" + ] + }, + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "quickViewState": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "CartPriceQuantity": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" + ] + }, + "isCalculated": { + "type": "boolean" + }, + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + }, + "type": { + "type": "string" + } + }, + "required": [ + "apiAlias" + ] + }, + "GetListBodyRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" + }, + "page": { + "type": "integer", + "description": "The page to be returned" + } + } + }, + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "StateForAll": { + "type": "object", + "properties": { + "currentGuideProductId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "lastActiveGuideSection": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentSectionId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentSlideAlias": { + "type": "integer", + "default": 0 + }, + "currentSlideData": { + "anyOf": [ + { + "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" + }, + { + "type": "null" + } + ] + }, + "currentDynamicPage": { + "$ref": "#/components/schemas/DynamicPageOpenedPayload" + }, + "started": { + "type": "boolean", + "default": false + }, + "running": { + "type": "boolean", + "default": false + }, + "ended": { + "type": "boolean", + "default": false + }, + "startedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "endedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "accessibleFrom": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "accessibleTo": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" + } + ] + }, + "appointmentMode": { + "type": "string", + "enum": [ + "guided", + "self" + ] + }, + "videoAudioSettings": { + "type": "string", + "enum": [ + "both", + "none", + "audio-only" + ], + "default": "none" + }, + "videoRoomUrl": { + "type": "string", + "default": "" + }, + "attendeeRestrictionType": { + "anyOf": [ + { + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] + }, + { + "type": "null" + } + ] + }, + "productDetailDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "quickviewPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "productListingDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "allowUserActionsForGuide": { + "type": "boolean", + "default": false + }, + "broadcastMode": { + "type": "boolean", + "default": false + }, + "viewMode": { + "type": "string", + "enum": [ + "onlyYou", + "presentation", + "videoGrid" + ], + "default": "presentation" + }, + "extensions": { + "type": "array", + "default": [] + } + } + } + }, + "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": "Dsr Appointment", + "description": "The endpoint for operations on Dsr Appointment" + }, + { + "name": "Dsr Appointment Attendee", + "description": "The endpoint for operations on Dsr Appointment Attendee" + }, + { + "name": "Dsr Appointment Request", + "description": "The endpoint for operations on Dsr Appointment Request" + }, + { + "name": "Dsr Appointment Video Chat", + "description": "The endpoint for operations on Dsr Appointment Video Chat" + }, + { + "name": "Dsr Attendee Product Collection", + "description": "The endpoint for operations on Dsr Attendee Product Collection" + }, + { + "name": "Dsr Interaction", + "description": "The endpoint for operations on Dsr Interaction" + }, + { + "name": "Dsr Presentation", + "description": "The endpoint for operations on Dsr Presentation" + }, + { + "name": "Dsr Presentation Cms Page", + "description": "The endpoint for operations on Dsr Presentation Cms Page" + }, + { + "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/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index d469189..923f014 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -352,6 +352,7 @@ "SnippetSetJsonApi", "StateForAll", "StateForGuides", + "StateForMe", "StateMachine", "StateMachineHistory", "StateMachineHistoryJsonApi", From 92add553d4a504ee39118e39d6a546cd6bbeda86 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 14 Oct 2024 16:44:14 +0200 Subject: [PATCH 29/63] [create-pull-request] automated change (#318) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 20032 ++++++++------------------------- 1 file changed, 4541 insertions(+), 15491 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index c862467..44ffa0c 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.6.6.1" + "version": "6.6.7.0" }, "servers": [ { @@ -15,80 +15,6 @@ } ], "paths": { - "/search/acl-role": { - "post": { - "tags": [ - "Acl Role" - ], - "summary": "Search for the Acl Role resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchAclRole", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of AclRole", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, "/advanced-search-action": { "get": { "tags": [ @@ -3969,32 +3895,43 @@ } } }, - "/search/app": { - "post": { + "/b2b-business-partner": { + "get": { "tags": [ - "App" + "B2b Business Partner" ], - "summary": "Search for the App resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchApp", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of B2b Business Partner resources.", + "description": "", + "operationId": "getB2bBusinessPartnerList", + "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 App", + "description": "List of B2b Business Partner resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4006,10 +3943,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/App" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-business-partner?limit=25" + }, + "last": { + "example": "/b2b-business-partner?limit=25&page=11" + }, + "next": { + "example": "/b2b-business-partner?limit=25&page=4" + }, + "prev": { + "example": "/b2b-business-partner?limit=25&page=2" + } + } + } + ] } } } @@ -4026,7 +3994,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/App" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4034,41 +4002,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/app-action-button": { + }, "post": { "tags": [ - "App Action Button" + "B2b Business Partner" + ], + "summary": "Create a new B2b Business Partner resources.", + "description": "", + "operationId": "createB2bBusinessPartner", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the App Action Button resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchAppActionButton", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } }, "responses": { "200": { - "description": "List of AppActionButton", + "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4080,10 +4068,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4093,15 +4078,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4117,14 +4099,14 @@ } } }, - "/search/app-administration-snippet": { + "/search/b2b-business-partner": { "post": { "tags": [ - "App Administration Snippet" + "B2b Business Partner" ], - "summary": "Search for the App Administration Snippet resources.", - "description": "Available since: 6.4.15.0", - "operationId": "searchAppAdministrationSnippet", + "summary": "Search for the B2b Business Partner resources.", + "description": "", + "operationId": "searchB2bBusinessPartner", "requestBody": { "required": true, "content": { @@ -4142,7 +4124,7 @@ }, "responses": { "200": { - "description": "List of AppAdministrationSnippet", + "description": "List of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4156,7 +4138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4174,7 +4156,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4191,32 +4173,29 @@ } } }, - "/search/app-cms-block": { - "post": { + "/b2b-business-partner/{id}": { + "get": { "tags": [ - "App Cms Block" + "B2b Business Partner" ], - "summary": "Search for the App Cms Block resources.", - "description": "Available since: 6.4.2.0", - "operationId": "searchAppCmsBlock", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a B2b Business Partner resource.", + "description": "", + "operationId": "getB2bBusinessPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_business_partner", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of AppCmsBlock", + "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4228,10 +4207,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4241,56 +4217,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } + "$ref": "#/components/schemas/B2bBusinessPartner" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/app-flow-action": { - "post": { + }, + "delete": { + "tags": [ + "B2b Business Partner" + ], + "summary": "Delete a B2b Business Partner resource.", + "description": "", + "operationId": "deleteB2bBusinessPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_business_partner", + "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": [ - "App Flow Action" + "B2b Business Partner" + ], + "summary": "Partially update information about a B2b Business Partner resource.", + "description": "", + "operationId": "updateB2bBusinessPartner", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_business_partner", + "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" + } + } ], - "summary": "Search for the App Flow Action resources.", - "description": "Available since: 6.4.10.0", - "operationId": "searchAppFlowAction", "requestBody": { - "required": true, + "description": "Partially update information about a B2b Business Partner resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bBusinessPartner" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/B2bBusinessPartner" } } } }, "responses": { "200": { - "description": "List of AppFlowAction", + "description": "Detail of B2bBusinessPartner", "content": { "application/vnd.api+json": { "schema": { @@ -4302,10 +4346,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4315,15 +4356,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } + "$ref": "#/components/schemas/B2bBusinessPartner" } } } @@ -4333,38 +4371,52 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/search/app-flow-event": { - "post": { + "/b2b-components-approval-rule": { + "get": { "tags": [ - "App Flow Event" + "B2b Components Approval Rule" ], - "summary": "Search for the App Flow Event resources.", - "description": "Available since: 6.5.2.0", - "operationId": "searchAppFlowEvent", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRuleList", + "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 AppFlowEvent", + "description": "List of B2b Components Approval Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4376,10 +4428,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/b2b-components-approval-rule?limit=25" + }, + "last": { + "example": "/b2b-components-approval-rule?limit=25&page=11" + }, + "next": { + "example": "/b2b-components-approval-rule?limit=25&page=4" + }, + "prev": { + "example": "/b2b-components-approval-rule?limit=25&page=2" + } + } + } + ] } } } @@ -4396,7 +4479,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppFlowEvent" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4404,41 +4487,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/app-payment-method": { + }, "post": { "tags": [ - "App Payment Method" + "B2b Components Approval Rule" + ], + "summary": "Create a new B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsApprovalRule", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the App Payment Method resources.", - "description": "Available since: 6.4.1.0", - "operationId": "searchAppPaymentMethod", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "List of AppPaymentMethod", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -4450,10 +4553,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4463,15 +4563,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4487,15 +4584,15 @@ } } }, - "/search/app-script-condition": { + "/search/b2b-components-approval-rule": { "post": { "tags": [ - "App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Search for the App Script Condition resources.", - "description": "Available since: 6.4.10.3", - "operationId": "searchAppScriptCondition", - "requestBody": { + "summary": "Search for the B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsApprovalRule", + "requestBody": { "required": true, "content": { "application/vnd.api+json": { @@ -4512,7 +4609,7 @@ }, "responses": { "200": { - "description": "List of AppScriptCondition", + "description": "List of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -4526,7 +4623,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4544,9 +4641,213 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-approval-rule/{id}": { + "get": { + "tags": [ + "B2b Components Approval Rule" + ], + "summary": "Detailed information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_components_approval_rule", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of B2bComponentsApprovalRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "B2b Components Approval Rule" + ], + "summary": "Delete a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsApprovalRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_components_approval_rule", + "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": [ + "B2b Components Approval Rule" + ], + "summary": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsApprovalRule", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the b2b_components_approval_rule", + "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 B2b Components Approval Rule resource.", + "content": { + "application/vnd.api+json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of B2bComponentsApprovalRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } } } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } } } } @@ -4555,20 +4856,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/app-shipping-method": { + "/b2b-components-approval-rule-app-script-condition": { "get": { "tags": [ - "App Shipping Method" + "B2b Components Approval Rule App Script Condition" ], - "summary": "List with basic information of App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "getAppShippingMethodList", + "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", "parameters": [ { "name": "limit", @@ -4597,7 +4901,7 @@ ], "responses": { "200": { - "description": "List of App Shipping Method resources.", + "description": "List of B2b Components Approval Rule App Script Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4616,7 +4920,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } ] @@ -4630,16 +4934,16 @@ "type": "object", "properties": { "first": { - "example": "/app-shipping-method?limit=25" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25" }, "last": { - "example": "/app-shipping-method?limit=25&page=11" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" }, "next": { - "example": "/app-shipping-method?limit=25&page=4" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" }, "prev": { - "example": "/app-shipping-method?limit=25&page=2" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" } } } @@ -4660,7 +4964,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4675,11 +4979,11 @@ }, "post": { "tags": [ - "App Shipping Method" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Create a new App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "createAppShippingMethod", + "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "_response", @@ -4701,7 +5005,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" }, "included": { "type": "array", @@ -4715,14 +5019,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -4734,7 +5038,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4749,7 +5053,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4765,14 +5069,14 @@ } } }, - "/search/app-shipping-method": { + "/search/b2b-components-approval-rule-app-script-condition": { "post": { "tags": [ - "App Shipping Method" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Search for the App Shipping Method resources.", - "description": "Available since: 6.5.7.0", - "operationId": "searchAppShippingMethod", + "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", "requestBody": { "required": true, "content": { @@ -4790,7 +5094,7 @@ }, "responses": { "200": { - "description": "List of AppShippingMethod", + "description": "List of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -4804,7 +5108,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4822,7 +5126,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4839,19 +5143,19 @@ } } }, - "/app-shipping-method/{id}": { + "/b2b-components-approval-rule-app-script-condition/{id}": { "get": { "tags": [ - "App Shipping Method" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Detailed information about a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "getAppShippingMethod", + "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_shipping_method", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -4861,7 +5165,7 @@ ], "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -4873,7 +5177,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4888,7 +5192,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -4905,16 +5209,16 @@ }, "delete": { "tags": [ - "App Shipping Method" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Delete a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "deleteAppShippingMethod", + "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_shipping_method", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -4945,16 +5249,16 @@ }, "patch": { "tags": [ - "App Shipping Method" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Partially update information about a App Shipping Method resource.", - "description": "Available since: 6.5.7.0", - "operationId": "updateAppShippingMethod", + "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the app_shipping_method", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -4972,14 +5276,14 @@ } ], "requestBody": { - "description": "Partially update information about a App Shipping Method resource.", + "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" }, "included": { "type": "array", @@ -4993,14 +5297,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of AppShippingMethod", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5012,7 +5316,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5027,7 +5331,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/AppShippingMethod" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5046,88 +5350,14 @@ } } }, - "/search/app-template": { - "post": { - "tags": [ - "App Template" - ], - "summary": "Search for the App Template resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchAppTemplate", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of AppTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/b2b-business-partner": { + "/b2b-components-pending-order": { "get": { "tags": [ - "B2b Business Partner" + "B2b Components Pending Order" ], - "summary": "List with basic information of B2b Business Partner resources.", - "description": "", - "operationId": "getB2bBusinessPartnerList", + "summary": "List with basic information of B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderList", "parameters": [ { "name": "limit", @@ -5156,7 +5386,7 @@ ], "responses": { "200": { - "description": "List of B2b Business Partner resources.", + "description": "List of B2b Components Pending Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5175,7 +5405,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } ] @@ -5189,16 +5419,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-business-partner?limit=25" + "example": "/b2b-components-pending-order?limit=25" }, "last": { - "example": "/b2b-business-partner?limit=25&page=11" + "example": "/b2b-components-pending-order?limit=25&page=11" }, "next": { - "example": "/b2b-business-partner?limit=25&page=4" + "example": "/b2b-components-pending-order?limit=25&page=4" }, "prev": { - "example": "/b2b-business-partner?limit=25&page=2" + "example": "/b2b-components-pending-order?limit=25&page=2" } } } @@ -5219,7 +5449,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5234,11 +5464,11 @@ }, "post": { "tags": [ - "B2b Business Partner" + "B2b Components Pending Order" ], - "summary": "Create a new B2b Business Partner resources.", - "description": "", - "operationId": "createB2bBusinessPartner", + "summary": "Create a new B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrder", "parameters": [ { "name": "_response", @@ -5260,7 +5490,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, "included": { "type": "array", @@ -5274,14 +5504,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of B2bBusinessPartner", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5293,7 +5523,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5308,7 +5538,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5324,14 +5554,14 @@ } } }, - "/search/b2b-business-partner": { + "/search/b2b-components-pending-order": { "post": { "tags": [ - "B2b Business Partner" + "B2b Components Pending Order" ], - "summary": "Search for the B2b Business Partner resources.", - "description": "", - "operationId": "searchB2bBusinessPartner", + "summary": "Search for the B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrder", "requestBody": { "required": true, "content": { @@ -5349,7 +5579,7 @@ }, "responses": { "200": { - "description": "List of B2bBusinessPartner", + "description": "List of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5363,7 +5593,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5381,7 +5611,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5398,19 +5628,19 @@ } } }, - "/b2b-business-partner/{id}": { + "/b2b-components-pending-order/{id}": { "get": { "tags": [ - "B2b Business Partner" + "B2b Components Pending Order" ], - "summary": "Detailed information about a B2b Business Partner resource.", - "description": "", - "operationId": "getB2bBusinessPartner", + "summary": "Detailed information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_business_partner", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -5420,7 +5650,7 @@ ], "responses": { "200": { - "description": "Detail of B2bBusinessPartner", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5432,7 +5662,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5447,7 +5677,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5464,16 +5694,16 @@ }, "delete": { "tags": [ - "B2b Business Partner" + "B2b Components Pending Order" ], - "summary": "Delete a B2b Business Partner resource.", - "description": "", - "operationId": "deleteB2bBusinessPartner", + "summary": "Delete a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_business_partner", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -5504,16 +5734,16 @@ }, "patch": { "tags": [ - "B2b Business Partner" + "B2b Components Pending Order" ], - "summary": "Partially update information about a B2b Business Partner resource.", - "description": "", - "operationId": "updateB2bBusinessPartner", + "summary": "Partially update information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_business_partner", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -5531,14 +5761,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Business Partner resource.", + "description": "Partially update information about a B2b Components Pending Order resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" }, "included": { "type": "array", @@ -5552,14 +5782,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of B2bBusinessPartner", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -5571,7 +5801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5586,7 +5816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -5605,14 +5835,14 @@ } } }, - "/b2b-components-approval-rule": { + "/b2b-components-pending-order-address": { "get": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Pending Order Address" ], - "summary": "List with basic information of B2b Components Approval Rule resources.", + "summary": "List with basic information of B2b Components Pending Order Address resources.", "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsApprovalRuleList", + "operationId": "getB2bComponentsPendingOrderAddressList", "parameters": [ { "name": "limit", @@ -5641,7 +5871,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Approval Rule resources.", + "description": "List of B2b Components Pending Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5660,7 +5890,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } ] @@ -5674,16 +5904,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-approval-rule?limit=25" + "example": "/b2b-components-pending-order-address?limit=25" }, "last": { - "example": "/b2b-components-approval-rule?limit=25&page=11" + "example": "/b2b-components-pending-order-address?limit=25&page=11" }, "next": { - "example": "/b2b-components-approval-rule?limit=25&page=4" + "example": "/b2b-components-pending-order-address?limit=25&page=4" }, "prev": { - "example": "/b2b-components-approval-rule?limit=25&page=2" + "example": "/b2b-components-pending-order-address?limit=25&page=2" } } } @@ -5704,7 +5934,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5719,11 +5949,11 @@ }, "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Pending Order Address" ], - "summary": "Create a new B2b Components Approval Rule resources.", + "summary": "Create a new B2b Components Pending Order Address resources.", "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsApprovalRule", + "operationId": "createB2bComponentsPendingOrderAddress", "parameters": [ { "name": "_response", @@ -5745,7 +5975,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" }, "included": { "type": "array", @@ -5759,14 +5989,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -5778,7 +6008,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5793,7 +6023,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5809,14 +6039,14 @@ } } }, - "/search/b2b-components-approval-rule": { + "/search/b2b-components-pending-order-address": { "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Pending Order Address" ], - "summary": "Search for the B2b Components Approval Rule resources.", + "summary": "Search for the B2b Components Pending Order Address resources.", "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsApprovalRule", + "operationId": "searchB2bComponentsPendingOrderAddress", "requestBody": { "required": true, "content": { @@ -5834,7 +6064,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRule", + "description": "List of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -5848,7 +6078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5866,7 +6096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5883,19 +6113,19 @@ } } }, - "/b2b-components-approval-rule/{id}": { + "/b2b-components-pending-order-address/{id}": { "get": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Pending Order Address" ], - "summary": "Detailed information about a B2b Components Approval Rule resource.", + "summary": "Detailed information about a B2b Components Pending Order Address resource.", "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsApprovalRule", + "operationId": "getB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -5905,7 +6135,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -5917,7 +6147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5932,7 +6162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -5949,16 +6179,16 @@ }, "delete": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Pending Order Address" ], - "summary": "Delete a B2b Components Approval Rule resource.", + "summary": "Delete a B2b Components Pending Order Address resource.", "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsApprovalRule", + "operationId": "deleteB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -5989,16 +6219,16 @@ }, "patch": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Pending Order Address" ], - "summary": "Partially update information about a B2b Components Approval Rule resource.", + "summary": "Partially update information about a B2b Components Pending Order Address resource.", "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsApprovalRule", + "operationId": "updateB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -6016,14 +6246,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Partially update information about a B2b Components Pending Order Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" }, "included": { "type": "array", @@ -6037,14 +6267,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -6056,7 +6286,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -6071,7 +6301,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -6090,14 +6320,14 @@ } } }, - "/b2b-components-approval-rule-app-script-condition": { + "/b2b-components-role": { "get": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Role" ], - "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", + "summary": "List with basic information of B2b Components Role resources.", + "description": "", + "operationId": "getB2bComponentsRoleList", "parameters": [ { "name": "limit", @@ -6126,7 +6356,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Approval Rule App Script Condition resources.", + "description": "List of B2b Components Role resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6145,7 +6375,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } ] @@ -6159,16 +6389,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25" + "example": "/b2b-components-role?limit=25" }, "last": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" + "example": "/b2b-components-role?limit=25&page=11" }, "next": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" + "example": "/b2b-components-role?limit=25&page=4" }, "prev": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" + "example": "/b2b-components-role?limit=25&page=2" } } } @@ -6189,7 +6419,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6204,11 +6434,11 @@ }, "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Role" ], - "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Create a new B2b Components Role resources.", + "description": "", + "operationId": "createB2bComponentsRole", "parameters": [ { "name": "_response", @@ -6230,7 +6460,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" }, "included": { "type": "array", @@ -6244,14 +6474,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6263,7 +6493,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6278,7 +6508,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6294,14 +6524,14 @@ } } }, - "/search/b2b-components-approval-rule-app-script-condition": { + "/search/b2b-components-role": { "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Role" ], - "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Search for the B2b Components Role resources.", + "description": "", + "operationId": "searchB2bComponentsRole", "requestBody": { "required": true, "content": { @@ -6319,7 +6549,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRuleAppScriptCondition", + "description": "List of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6333,7 +6563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6351,7 +6581,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6368,19 +6598,19 @@ } } }, - "/b2b-components-approval-rule-app-script-condition/{id}": { + "/b2b-components-role/{id}": { "get": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Role" ], - "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Detailed information about a B2b Components Role resource.", + "description": "", + "operationId": "getB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -6390,7 +6620,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6402,7 +6632,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6417,7 +6647,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6434,16 +6664,16 @@ }, "delete": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Role" ], - "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Delete a B2b Components Role resource.", + "description": "", + "operationId": "deleteB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -6474,16 +6704,16 @@ }, "patch": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Role" ], - "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Partially update information about a B2b Components Role resource.", + "description": "", + "operationId": "updateB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -6501,14 +6731,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Partially update information about a B2b Components Role resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" }, "included": { "type": "array", @@ -6522,14 +6752,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -6541,7 +6771,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6556,7 +6786,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -6575,14 +6805,15 @@ } } }, - "/b2b-components-pending-order": { + "/b2b-components-shopping-list": { "get": { "tags": [ - "B2b Components Pending Order" + "B2b Components Shopping List", + "Experimental" ], - "summary": "List with basic information of B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderList", + "summary": "List with basic information of B2b Components Shopping List 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.2.0", + "operationId": "getB2bComponentsShoppingListList", "parameters": [ { "name": "limit", @@ -6611,7 +6842,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Pending Order resources.", + "description": "List of B2b Components Shopping List resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6630,7 +6861,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } ] @@ -6644,16 +6875,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-pending-order?limit=25" + "example": "/b2b-components-shopping-list?limit=25" }, "last": { - "example": "/b2b-components-pending-order?limit=25&page=11" + "example": "/b2b-components-shopping-list?limit=25&page=11" }, "next": { - "example": "/b2b-components-pending-order?limit=25&page=4" + "example": "/b2b-components-shopping-list?limit=25&page=4" }, "prev": { - "example": "/b2b-components-pending-order?limit=25&page=2" + "example": "/b2b-components-shopping-list?limit=25&page=2" } } } @@ -6674,7 +6905,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6689,11 +6920,12 @@ }, "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Create a new B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsPendingOrder", + "summary": "Create a new B2b Components Shopping List 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.2.0", + "operationId": "createB2bComponentsShoppingList", "parameters": [ { "name": "_response", @@ -6715,7 +6947,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, "included": { "type": "array", @@ -6729,14 +6961,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -6748,7 +6980,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6763,7 +6995,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6779,14 +7011,15 @@ } } }, - "/search/b2b-components-pending-order": { + "/search/b2b-components-shopping-list": { "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Search for the B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsPendingOrder", + "summary": "Search for the B2b Components Shopping List 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.2.0", + "operationId": "searchB2bComponentsShoppingList", "requestBody": { "required": true, "content": { @@ -6804,7 +7037,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrder", + "description": "List of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -6818,7 +7051,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6836,7 +7069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6853,19 +7086,20 @@ } } }, - "/b2b-components-pending-order/{id}": { + "/b2b-components-shopping-list/{id}": { "get": { "tags": [ - "B2b Components Pending Order" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Detailed information about a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrder", + "summary": "Detailed information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -6875,7 +7109,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -6887,7 +7121,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6902,7 +7136,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -6919,16 +7153,17 @@ }, "delete": { "tags": [ - "B2b Components Pending Order" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Delete a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsPendingOrder", + "summary": "Delete a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -6959,16 +7194,17 @@ }, "patch": { "tags": [ - "B2b Components Pending Order" + "B2b Components Shopping List", + "Experimental" ], - "summary": "Partially update information about a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsPendingOrder", + "summary": "Partially update information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -6986,14 +7222,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Pending Order resource.", + "description": "Partially update information about a B2b Components Shopping List resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, "included": { "type": "array", @@ -7007,14 +7243,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -7026,7 +7262,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -7041,7 +7277,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -7060,14 +7296,15 @@ } } }, - "/b2b-components-pending-order-address": { + "/b2b-components-shopping-list-line-item": { "get": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "List with basic information of B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderAddressList", + "summary": "List with basic information of B2b Components Shopping List Line Item 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.2.0", + "operationId": "getB2bComponentsShoppingListLineItemList", "parameters": [ { "name": "limit", @@ -7096,7 +7333,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Pending Order Address resources.", + "description": "List of B2b Components Shopping List Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7115,7 +7352,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } ] @@ -7129,16 +7366,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-pending-order-address?limit=25" + "example": "/b2b-components-shopping-list-line-item?limit=25" }, "last": { - "example": "/b2b-components-pending-order-address?limit=25&page=11" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" }, "next": { - "example": "/b2b-components-pending-order-address?limit=25&page=4" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" }, "prev": { - "example": "/b2b-components-pending-order-address?limit=25&page=2" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" } } } @@ -7159,7 +7396,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7174,11 +7411,12 @@ }, "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Create a new B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsPendingOrderAddress", + "summary": "Create a new B2b Components Shopping List Line Item 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.2.0", + "operationId": "createB2bComponentsShoppingListLineItem", "parameters": [ { "name": "_response", @@ -7200,7 +7438,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" }, "included": { "type": "array", @@ -7214,14 +7452,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7233,7 +7471,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7248,7 +7486,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7264,14 +7502,15 @@ } } }, - "/search/b2b-components-pending-order-address": { + "/search/b2b-components-shopping-list-line-item": { "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Search for the B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsPendingOrderAddress", + "summary": "Search for the B2b Components Shopping List Line Item 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.2.0", + "operationId": "searchB2bComponentsShoppingListLineItem", "requestBody": { "required": true, "content": { @@ -7289,7 +7528,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrderAddress", + "description": "List of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7303,7 +7542,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7321,7 +7560,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7338,19 +7577,20 @@ } } }, - "/b2b-components-pending-order-address/{id}": { + "/b2b-components-shopping-list-line-item/{id}": { "get": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Detailed information about a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderAddress", + "summary": "Detailed information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -7360,7 +7600,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7372,7 +7612,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7387,7 +7627,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7404,16 +7644,17 @@ }, "delete": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Delete a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsPendingOrderAddress", + "summary": "Delete a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -7444,16 +7685,17 @@ }, "patch": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Shopping List Line Item", + "Experimental" ], - "summary": "Partially update information about a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsPendingOrderAddress", + "summary": "Partially update information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -7471,14 +7713,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Pending Order Address resource.", + "description": "Partially update information about a B2b Components Shopping List Line Item resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" }, "included": { "type": "array", @@ -7492,14 +7734,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -7511,7 +7753,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7526,7 +7768,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -7545,14 +7787,14 @@ } } }, - "/b2b-components-role": { + "/b2b-employee": { "get": { "tags": [ - "B2b Components Role" + "B2b Employee" ], - "summary": "List with basic information of B2b Components Role resources.", + "summary": "List with basic information of B2b Employee resources.", "description": "", - "operationId": "getB2bComponentsRoleList", + "operationId": "getB2bEmployeeList", "parameters": [ { "name": "limit", @@ -7581,7 +7823,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Role resources.", + "description": "List of B2b Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7600,7 +7842,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } ] @@ -7614,16 +7856,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-role?limit=25" + "example": "/b2b-employee?limit=25" }, "last": { - "example": "/b2b-components-role?limit=25&page=11" + "example": "/b2b-employee?limit=25&page=11" }, "next": { - "example": "/b2b-components-role?limit=25&page=4" + "example": "/b2b-employee?limit=25&page=4" }, "prev": { - "example": "/b2b-components-role?limit=25&page=2" + "example": "/b2b-employee?limit=25&page=2" } } } @@ -7644,7 +7886,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7659,11 +7901,11 @@ }, "post": { "tags": [ - "B2b Components Role" + "B2b Employee" ], - "summary": "Create a new B2b Components Role resources.", + "summary": "Create a new B2b Employee resources.", "description": "", - "operationId": "createB2bComponentsRole", + "operationId": "createB2bEmployee", "parameters": [ { "name": "_response", @@ -7685,7 +7927,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" }, "included": { "type": "array", @@ -7699,14 +7941,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7718,7 +7960,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7733,7 +7975,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7749,14 +7991,14 @@ } } }, - "/search/b2b-components-role": { + "/search/b2b-employee": { "post": { "tags": [ - "B2b Components Role" + "B2b Employee" ], - "summary": "Search for the B2b Components Role resources.", + "summary": "Search for the B2b Employee resources.", "description": "", - "operationId": "searchB2bComponentsRole", + "operationId": "searchB2bEmployee", "requestBody": { "required": true, "content": { @@ -7774,7 +8016,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsRole", + "description": "List of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7788,7 +8030,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7806,7 +8048,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7823,19 +8065,19 @@ } } }, - "/b2b-components-role/{id}": { + "/b2b-employee/{id}": { "get": { "tags": [ - "B2b Components Role" + "B2b Employee" ], - "summary": "Detailed information about a B2b Components Role resource.", + "summary": "Detailed information about a B2b Employee resource.", "description": "", - "operationId": "getB2bComponentsRole", + "operationId": "getB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -7845,7 +8087,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7857,7 +8099,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7872,7 +8114,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -7889,16 +8131,16 @@ }, "delete": { "tags": [ - "B2b Components Role" + "B2b Employee" ], - "summary": "Delete a B2b Components Role resource.", + "summary": "Delete a B2b Employee resource.", "description": "", - "operationId": "deleteB2bComponentsRole", + "operationId": "deleteB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -7929,16 +8171,16 @@ }, "patch": { "tags": [ - "B2b Components Role" + "B2b Employee" ], - "summary": "Partially update information about a B2b Components Role resource.", + "summary": "Partially update information about a B2b Employee resource.", "description": "", - "operationId": "updateB2bComponentsRole", + "operationId": "updateB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -7956,14 +8198,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Role resource.", + "description": "Partially update information about a B2b Employee resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" }, "included": { "type": "array", @@ -7977,14 +8219,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -7996,7 +8238,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -8011,7 +8253,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -8030,15 +8272,14 @@ } } }, - "/b2b-components-shopping-list": { + "/b2b-order-employee": { "get": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Order Employee" ], - "summary": "List with basic information of B2b Components Shopping List 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.2.0", - "operationId": "getB2bComponentsShoppingListList", + "summary": "List with basic information of B2b Order Employee resources.", + "description": "", + "operationId": "getB2bOrderEmployeeList", "parameters": [ { "name": "limit", @@ -8067,7 +8308,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Shopping List resources.", + "description": "List of B2b Order Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8086,7 +8327,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } ] @@ -8100,16 +8341,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-shopping-list?limit=25" + "example": "/b2b-order-employee?limit=25" }, "last": { - "example": "/b2b-components-shopping-list?limit=25&page=11" + "example": "/b2b-order-employee?limit=25&page=11" }, "next": { - "example": "/b2b-components-shopping-list?limit=25&page=4" + "example": "/b2b-order-employee?limit=25&page=4" }, "prev": { - "example": "/b2b-components-shopping-list?limit=25&page=2" + "example": "/b2b-order-employee?limit=25&page=2" } } } @@ -8130,7 +8371,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8145,12 +8386,11 @@ }, "post": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Order Employee" ], - "summary": "Create a new B2b Components Shopping List 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.2.0", - "operationId": "createB2bComponentsShoppingList", + "summary": "Create a new B2b Order Employee resources.", + "description": "", + "operationId": "createB2bOrderEmployee", "parameters": [ { "name": "_response", @@ -8172,7 +8412,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" }, "included": { "type": "array", @@ -8186,14 +8426,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -8205,7 +8445,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8220,7 +8460,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8236,15 +8476,14 @@ } } }, - "/search/b2b-components-shopping-list": { + "/search/b2b-order-employee": { "post": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Order Employee" ], - "summary": "Search for the B2b Components Shopping List 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.2.0", - "operationId": "searchB2bComponentsShoppingList", + "summary": "Search for the B2b Order Employee resources.", + "description": "", + "operationId": "searchB2bOrderEmployee", "requestBody": { "required": true, "content": { @@ -8262,7 +8501,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingList", + "description": "List of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -8276,7 +8515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8294,7 +8533,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8311,20 +8550,19 @@ } } }, - "/b2b-components-shopping-list/{id}": { + "/b2b-order-employee/{id}": { "get": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Order Employee" ], - "summary": "Detailed information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingList", + "summary": "Detailed information about a B2b Order Employee resource.", + "description": "", + "operationId": "getB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -8334,7 +8572,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -8346,7 +8584,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8361,7 +8599,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8378,17 +8616,16 @@ }, "delete": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Order Employee" ], - "summary": "Delete a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "deleteB2bComponentsShoppingList", + "summary": "Delete a B2b Order Employee resource.", + "description": "", + "operationId": "deleteB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -8419,17 +8656,16 @@ }, "patch": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Order Employee" ], - "summary": "Partially update information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "updateB2bComponentsShoppingList", + "summary": "Partially update information about a B2b Order Employee resource.", + "description": "", + "operationId": "updateB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -8447,14 +8683,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Shopping List resource.", + "description": "Partially update information about a B2b Order Employee resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" }, "included": { "type": "array", @@ -8468,14 +8704,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -8487,7 +8723,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8502,7 +8738,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -8521,15 +8757,14 @@ } } }, - "/b2b-components-shopping-list-line-item": { + "/b2b-permission": { "get": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Permission" ], - "summary": "List with basic information of B2b Components Shopping List Line Item 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.2.0", - "operationId": "getB2bComponentsShoppingListLineItemList", + "summary": "List with basic information of B2b Permission resources.", + "description": "", + "operationId": "getB2bPermissionList", "parameters": [ { "name": "limit", @@ -8558,7 +8793,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Shopping List Line Item resources.", + "description": "List of B2b Permission resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8577,7 +8812,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } ] @@ -8591,16 +8826,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-shopping-list-line-item?limit=25" + "example": "/b2b-permission?limit=25" }, "last": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" + "example": "/b2b-permission?limit=25&page=11" }, "next": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" + "example": "/b2b-permission?limit=25&page=4" }, "prev": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" + "example": "/b2b-permission?limit=25&page=2" } } } @@ -8621,7 +8856,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8636,12 +8871,11 @@ }, "post": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Permission" ], - "summary": "Create a new B2b Components Shopping List Line Item 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.2.0", - "operationId": "createB2bComponentsShoppingListLineItem", + "summary": "Create a new B2b Permission resources.", + "description": "", + "operationId": "createB2bPermission", "parameters": [ { "name": "_response", @@ -8663,7 +8897,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" }, "included": { "type": "array", @@ -8677,14 +8911,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8696,7 +8930,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8711,7 +8945,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8727,15 +8961,14 @@ } } }, - "/search/b2b-components-shopping-list-line-item": { + "/search/b2b-permission": { "post": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Permission" ], - "summary": "Search for the B2b Components Shopping List Line Item 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.2.0", - "operationId": "searchB2bComponentsShoppingListLineItem", + "summary": "Search for the B2b Permission resources.", + "description": "", + "operationId": "searchB2bPermission", "requestBody": { "required": true, "content": { @@ -8753,7 +8986,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingListLineItem", + "description": "List of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8767,7 +9000,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8785,7 +9018,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8802,20 +9035,19 @@ } } }, - "/b2b-components-shopping-list-line-item/{id}": { + "/b2b-permission/{id}": { "get": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Permission" ], - "summary": "Detailed information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingListLineItem", + "summary": "Detailed information about a B2b Permission resource.", + "description": "", + "operationId": "getB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -8825,7 +9057,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8837,7 +9069,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8852,7 +9084,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8869,17 +9101,16 @@ }, "delete": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Permission" ], - "summary": "Delete a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "deleteB2bComponentsShoppingListLineItem", + "summary": "Delete a B2b Permission resource.", + "description": "", + "operationId": "deleteB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -8910,17 +9141,16 @@ }, "patch": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Permission" ], - "summary": "Partially update information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "updateB2bComponentsShoppingListLineItem", + "summary": "Partially update information about a B2b Permission resource.", + "description": "", + "operationId": "updateB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -8938,14 +9168,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Shopping List Line Item resource.", + "description": "Partially update information about a B2b Permission resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" }, "included": { "type": "array", @@ -8959,14 +9189,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -8978,7 +9208,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -8993,7 +9223,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -9012,14 +9242,14 @@ } } }, - "/b2b-employee": { + "/custom-price": { "get": { "tags": [ - "B2b Employee" + "Custom Price" ], - "summary": "List with basic information of B2b Employee resources.", + "summary": "List with basic information of Custom Price resources.", "description": "", - "operationId": "getB2bEmployeeList", + "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", @@ -9048,7 +9278,7 @@ ], "responses": { "200": { - "description": "List of B2b Employee resources.", + "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9067,7 +9297,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } ] @@ -9081,16 +9311,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-employee?limit=25" + "example": "/custom-price?limit=25" }, "last": { - "example": "/b2b-employee?limit=25&page=11" + "example": "/custom-price?limit=25&page=11" }, "next": { - "example": "/b2b-employee?limit=25&page=4" + "example": "/custom-price?limit=25&page=4" }, "prev": { - "example": "/b2b-employee?limit=25&page=2" + "example": "/custom-price?limit=25&page=2" } } } @@ -9111,7 +9341,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9126,11 +9356,11 @@ }, "post": { "tags": [ - "B2b Employee" + "Custom Price" ], - "summary": "Create a new B2b Employee resources.", + "summary": "Create a new Custom Price resources.", "description": "", - "operationId": "createB2bEmployee", + "operationId": "createCustomPrice", "parameters": [ { "name": "_response", @@ -9152,7 +9382,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" }, "included": { "type": "array", @@ -9166,14 +9396,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -9185,7 +9415,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9200,7 +9430,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9216,14 +9446,14 @@ } } }, - "/search/b2b-employee": { + "/search/custom-price": { "post": { "tags": [ - "B2b Employee" + "Custom Price" ], - "summary": "Search for the B2b Employee resources.", + "summary": "Search for the Custom Price resources.", "description": "", - "operationId": "searchB2bEmployee", + "operationId": "searchCustomPrice", "requestBody": { "required": true, "content": { @@ -9241,7 +9471,7 @@ }, "responses": { "200": { - "description": "List of B2bEmployee", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -9255,7 +9485,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9273,7 +9503,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9290,19 +9520,19 @@ } } }, - "/b2b-employee/{id}": { + "/custom-price/{id}": { "get": { "tags": [ - "B2b Employee" + "Custom Price" ], - "summary": "Detailed information about a B2b Employee resource.", + "summary": "Detailed information about a Custom Price resource.", "description": "", - "operationId": "getB2bEmployee", + "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -9312,7 +9542,7 @@ ], "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -9324,7 +9554,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9339,7 +9569,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9356,16 +9586,16 @@ }, "delete": { "tags": [ - "B2b Employee" + "Custom Price" ], - "summary": "Delete a B2b Employee resource.", + "summary": "Delete a Custom Price resource.", "description": "", - "operationId": "deleteB2bEmployee", + "operationId": "deleteCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -9396,16 +9626,16 @@ }, "patch": { "tags": [ - "B2b Employee" + "Custom Price" ], - "summary": "Partially update information about a B2b Employee resource.", + "summary": "Partially update information about a Custom Price resource.", "description": "", - "operationId": "updateB2bEmployee", + "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -9423,14 +9653,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Employee resource.", + "description": "Partially update information about a Custom Price resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" }, "included": { "type": "array", @@ -9444,14 +9674,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -9463,7 +9693,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9478,7 +9708,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -9497,14 +9727,14 @@ } } }, - "/b2b-order-employee": { + "/customer-specific-features": { "get": { "tags": [ - "B2b Order Employee" + "Customer Specific Features" ], - "summary": "List with basic information of B2b Order Employee resources.", + "summary": "List with basic information of Customer Specific Features resources.", "description": "", - "operationId": "getB2bOrderEmployeeList", + "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", @@ -9533,7 +9763,7 @@ ], "responses": { "200": { - "description": "List of B2b Order Employee resources.", + "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9552,7 +9782,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] @@ -9566,16 +9796,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-order-employee?limit=25" + "example": "/customer-specific-features?limit=25" }, "last": { - "example": "/b2b-order-employee?limit=25&page=11" + "example": "/customer-specific-features?limit=25&page=11" }, "next": { - "example": "/b2b-order-employee?limit=25&page=4" + "example": "/customer-specific-features?limit=25&page=4" }, "prev": { - "example": "/b2b-order-employee?limit=25&page=2" + "example": "/customer-specific-features?limit=25&page=2" } } } @@ -9596,7 +9826,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9611,11 +9841,11 @@ }, "post": { "tags": [ - "B2b Order Employee" + "Customer Specific Features" ], - "summary": "Create a new B2b Order Employee resources.", + "summary": "Create a new Customer Specific Features resources.", "description": "", - "operationId": "createB2bOrderEmployee", + "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", @@ -9637,7 +9867,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" }, "included": { "type": "array", @@ -9651,14 +9881,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -9670,7 +9900,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9685,7 +9915,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9701,14 +9931,14 @@ } } }, - "/search/b2b-order-employee": { + "/search/customer-specific-features": { "post": { "tags": [ - "B2b Order Employee" + "Customer Specific Features" ], - "summary": "Search for the B2b Order Employee resources.", + "summary": "Search for the Customer Specific Features resources.", "description": "", - "operationId": "searchB2bOrderEmployee", + "operationId": "searchCustomerSpecificFeatures", "requestBody": { "required": true, "content": { @@ -9726,7 +9956,7 @@ }, "responses": { "200": { - "description": "List of B2bOrderEmployee", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -9740,7 +9970,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9758,7 +9988,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9775,19 +10005,19 @@ } } }, - "/b2b-order-employee/{id}": { + "/customer-specific-features/{id}": { "get": { "tags": [ - "B2b Order Employee" + "Customer Specific Features" ], - "summary": "Detailed information about a B2b Order Employee resource.", + "summary": "Detailed information about a Customer Specific Features resource.", "description": "", - "operationId": "getB2bOrderEmployee", + "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -9797,7 +10027,7 @@ ], "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -9809,7 +10039,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9824,7 +10054,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9841,16 +10071,16 @@ }, "delete": { "tags": [ - "B2b Order Employee" + "Customer Specific Features" ], - "summary": "Delete a B2b Order Employee resource.", + "summary": "Delete a Customer Specific Features resource.", "description": "", - "operationId": "deleteB2bOrderEmployee", + "operationId": "deleteCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -9881,16 +10111,16 @@ }, "patch": { "tags": [ - "B2b Order Employee" + "Customer Specific Features" ], - "summary": "Partially update information about a B2b Order Employee resource.", + "summary": "Partially update information about a Customer Specific Features resource.", "description": "", - "operationId": "updateB2bOrderEmployee", + "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -9908,14 +10138,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Order Employee resource.", + "description": "Partially update information about a Customer Specific Features resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" }, "included": { "type": "array", @@ -9929,14 +10159,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -9948,7 +10178,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9963,7 +10193,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -9982,14 +10212,14 @@ } } }, - "/b2b-permission": { + "/media-ai-tag": { "get": { "tags": [ - "B2b Permission" + "Media Ai Tag" ], - "summary": "List with basic information of B2b Permission resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getB2bPermissionList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -10018,7 +10248,7 @@ ], "responses": { "200": { - "description": "List of B2b Permission resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10037,7 +10267,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -10051,16 +10281,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-permission?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/b2b-permission?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/b2b-permission?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/b2b-permission?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -10081,7 +10311,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10096,11 +10326,11 @@ }, "post": { "tags": [ - "B2b Permission" + "Media Ai Tag" ], - "summary": "Create a new B2b Permission resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createB2bPermission", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -10122,7 +10352,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" }, "included": { "type": "array", @@ -10136,14 +10366,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -10155,7 +10385,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10170,7 +10400,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10186,14 +10416,14 @@ } } }, - "/search/b2b-permission": { + "/search/media-ai-tag": { "post": { "tags": [ - "B2b Permission" + "Media Ai Tag" ], - "summary": "Search for the B2b Permission resources.", + "summary": "Search for the Media Ai Tag resources.", "description": "", - "operationId": "searchB2bPermission", + "operationId": "searchMediaAiTag", "requestBody": { "required": true, "content": { @@ -10211,7 +10441,7 @@ }, "responses": { "200": { - "description": "List of B2bPermission", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -10225,7 +10455,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10243,7 +10473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10260,19 +10490,19 @@ } } }, - "/b2b-permission/{id}": { + "/media-ai-tag/{id}": { "get": { "tags": [ - "B2b Permission" + "Media Ai Tag" ], - "summary": "Detailed information about a B2b Permission resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getB2bPermission", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -10282,7 +10512,7 @@ ], "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -10294,7 +10524,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10309,7 +10539,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10326,16 +10556,16 @@ }, "delete": { "tags": [ - "B2b Permission" + "Media Ai Tag" ], - "summary": "Delete a B2b Permission resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteB2bPermission", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -10366,16 +10596,16 @@ }, "patch": { "tags": [ - "B2b Permission" + "Media Ai Tag" ], - "summary": "Partially update information about a B2b Permission resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateB2bPermission", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -10393,14 +10623,14 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Permission resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" }, "included": { "type": "array", @@ -10414,14 +10644,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -10433,7 +10663,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10448,7 +10678,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -10467,32 +10697,43 @@ } } }, - "/search/category": { - "post": { + "/order-product-warehouse": { + "get": { "tags": [ - "Category" + "Order Product Warehouse" ], - "summary": "Search for the Category resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCategory", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of Order Product Warehouse resources.", + "description": "", + "operationId": "getOrderProductWarehouseList", + "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 Category", + "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10504,10 +10745,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-product-warehouse?limit=25" + }, + "last": { + "example": "/order-product-warehouse?limit=25&page=11" + }, + "next": { + "example": "/order-product-warehouse?limit=25&page=4" + }, + "prev": { + "example": "/order-product-warehouse?limit=25&page=2" + } + } + } + ] } } } @@ -10524,7 +10796,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -10532,41 +10804,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/cms-block": { + }, "post": { "tags": [ - "Cms Block" + "Order Product Warehouse" + ], + "summary": "Create a new Order Product Warehouse resources.", + "description": "", + "operationId": "createOrderProductWarehouse", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the Cms Block resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCmsBlock", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "List of CmsBlock", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -10578,10 +10870,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -10591,15 +10880,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -10615,14 +10901,14 @@ } } }, - "/search/cms-page": { + "/search/order-product-warehouse": { "post": { "tags": [ - "Cms Page" + "Order Product Warehouse" ], - "summary": "Search for the Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCmsPage", + "summary": "Search for the Order Product Warehouse resources.", + "description": "", + "operationId": "searchOrderProductWarehouse", "requestBody": { "required": true, "content": { @@ -10640,7 +10926,7 @@ }, "responses": { "200": { - "description": "List of CmsPage", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -10654,7 +10940,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -10672,7 +10958,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -10689,32 +10975,29 @@ } } }, - "/search/cms-section": { - "post": { + "/order-product-warehouse/{id}": { + "get": { "tags": [ - "Cms Section" + "Order Product Warehouse" ], - "summary": "Search for the Cms Section resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCmsSection", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a Order Product Warehouse resource.", + "description": "", + "operationId": "getOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of CmsSection", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -10726,10 +11009,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -10739,10826 +11019,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } + "$ref": "#/components/schemas/OrderProductWarehouse" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/cms-slot": { - "post": { + }, + "delete": { "tags": [ - "Cms Slot" + "Order Product Warehouse" ], - "summary": "Search for the Cms Slot resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCmsSlot", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Delete a Order Product Warehouse resource.", + "description": "", + "operationId": "deleteOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "200": { - "description": "List of CmsSlot", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/country": { - "post": { - "tags": [ - "Country" - ], - "summary": "Search for the Country resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCountry", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Country", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/country-state": { - "post": { - "tags": [ - "Country State" - ], - "summary": "Search for the Country State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCountryState", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CountryState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/currency": { - "post": { - "tags": [ - "Currency" - ], - "summary": "Search for the Currency resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCurrency", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Currency", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/currency-country-rounding": { - "post": { - "tags": [ - "Currency Country Rounding" - ], - "summary": "Search for the Currency Country Rounding resources.", - "description": "Available since: 6.4.0.0", - "operationId": "searchCurrencyCountryRounding", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CurrencyCountryRounding", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/custom-entity": { - "post": { - "tags": [ - "Custom Entity" - ], - "summary": "Search for the Custom Entity resources.", - "description": "Available since: 6.4.9.0", - "operationId": "searchCustomEntity", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomEntity", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/custom-field": { - "post": { - "tags": [ - "Custom Field" - ], - "summary": "Search for the Custom Field resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCustomField", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/custom-field-set": { - "post": { - "tags": [ - "Custom Field Set" - ], - "summary": "Search for the Custom Field Set resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCustomFieldSet", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomFieldSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/custom-field-set-relation": { - "post": { - "tags": [ - "Custom Field Set Relation" - ], - "summary": "Search for the Custom Field Set Relation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCustomFieldSetRelation", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomFieldSetRelation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-price": { - "get": { - "tags": [ - "Custom Price" - ], - "summary": "List with basic information of Custom Price resources.", - "description": "", - "operationId": "getCustomPriceList", - "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 Custom 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/CustomPrice" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/custom-price?limit=25" - }, - "last": { - "example": "/custom-price?limit=25&page=11" - }, - "next": { - "example": "/custom-price?limit=25&page=4" - }, - "prev": { - "example": "/custom-price?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Custom Price" - ], - "summary": "Create a new Custom Price resources.", - "description": "", - "operationId": "createCustomPrice", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/custom-price": { - "post": { - "tags": [ - "Custom Price" - ], - "summary": "Search for the Custom Price resources.", - "description": "", - "operationId": "searchCustomPrice", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/custom-price/{id}": { - "get": { - "tags": [ - "Custom Price" - ], - "summary": "Detailed information about a Custom Price resource.", - "description": "", - "operationId": "getCustomPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_price", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Custom Price" - ], - "summary": "Delete a Custom Price resource.", - "description": "", - "operationId": "deleteCustomPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_price", - "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": [ - "Custom Price" - ], - "summary": "Partially update information about a Custom Price resource.", - "description": "", - "operationId": "updateCustomPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the custom_price", - "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 Custom Price resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer": { - "post": { - "tags": [ - "Customer" - ], - "summary": "Search for the Customer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCustomer", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Customer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer-address": { - "post": { - "tags": [ - "Customer Address" - ], - "summary": "Search for the Customer Address resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCustomerAddress", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer-group": { - "post": { - "tags": [ - "Customer Group" - ], - "summary": "Search for the Customer Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCustomerGroup", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer-recovery": { - "post": { - "tags": [ - "Customer Recovery" - ], - "summary": "Search for the Customer Recovery resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchCustomerRecovery", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-specific-features": { - "get": { - "tags": [ - "Customer Specific Features" - ], - "summary": "List with basic information of Customer Specific Features resources.", - "description": "", - "operationId": "getCustomerSpecificFeaturesList", - "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 Customer Specific Features 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/CustomerSpecificFeatures" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/customer-specific-features?limit=25" - }, - "last": { - "example": "/customer-specific-features?limit=25&page=11" - }, - "next": { - "example": "/customer-specific-features?limit=25&page=4" - }, - "prev": { - "example": "/customer-specific-features?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Customer Specific Features" - ], - "summary": "Create a new Customer Specific Features resources.", - "description": "", - "operationId": "createCustomerSpecificFeatures", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerSpecificFeatures", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer-specific-features": { - "post": { - "tags": [ - "Customer Specific Features" - ], - "summary": "Search for the Customer Specific Features resources.", - "description": "", - "operationId": "searchCustomerSpecificFeatures", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerSpecificFeatures", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/customer-specific-features/{id}": { - "get": { - "tags": [ - "Customer Specific Features" - ], - "summary": "Detailed information about a Customer Specific Features resource.", - "description": "", - "operationId": "getCustomerSpecificFeatures", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_specific_features", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of CustomerSpecificFeatures", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Customer Specific Features" - ], - "summary": "Delete a Customer Specific Features resource.", - "description": "", - "operationId": "deleteCustomerSpecificFeatures", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_specific_features", - "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": [ - "Customer Specific Features" - ], - "summary": "Partially update information about a Customer Specific Features resource.", - "description": "", - "operationId": "updateCustomerSpecificFeatures", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the customer_specific_features", - "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 Customer Specific Features resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of CustomerSpecificFeatures", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer-wishlist": { - "post": { - "tags": [ - "Customer Wishlist" - ], - "summary": "Search for the Customer Wishlist resources.", - "description": "Available since: 6.3.4.0", - "operationId": "searchCustomerWishlist", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerWishlist", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/customer-wishlist-product": { - "post": { - "tags": [ - "Customer Wishlist Product" - ], - "summary": "Search for the Customer Wishlist Product resources.", - "description": "Available since: 6.3.4.0", - "operationId": "searchCustomerWishlistProduct", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerWishlistProduct", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/delivery-time": { - "post": { - "tags": [ - "Delivery Time" - ], - "summary": "Search for the Delivery Time resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDeliveryTime", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of DeliveryTime", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/document": { - "post": { - "tags": [ - "Document" - ], - "summary": "Search for the Document resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDocument", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Document", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/document-base-config": { - "post": { - "tags": [ - "Document Base Config" - ], - "summary": "Search for the Document Base Config resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDocumentBaseConfig", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of DocumentBaseConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/document-base-config-sales-channel": { - "post": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Search for the Document Base Config Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDocumentBaseConfigSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/document-type": { - "post": { - "tags": [ - "Document Type" - ], - "summary": "Search for the Document Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDocumentType", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of DocumentType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/flow": { - "post": { - "tags": [ - "Flow" - ], - "summary": "Search for the Flow resources.", - "description": "Available since: 6.4.6.0", - "operationId": "searchFlow", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Flow", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/flow-sequence": { - "post": { - "tags": [ - "Flow Sequence" - ], - "summary": "Search for the Flow Sequence resources.", - "description": "Available since: 6.4.6.0", - "operationId": "searchFlowSequence", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of FlowSequence", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/flow-template": { - "post": { - "tags": [ - "Flow Template" - ], - "summary": "Search for the Flow Template resources.", - "description": "Available since: 6.4.18.0", - "operationId": "searchFlowTemplate", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of FlowTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/import-export-file": { - "post": { - "tags": [ - "Import Export File" - ], - "summary": "Search for the Import Export File resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchImportExportFile", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ImportExportFile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/import-export-log": { - "post": { - "tags": [ - "Import Export Log" - ], - "summary": "Search for the Import Export Log resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchImportExportLog", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ImportExportLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/import-export-profile": { - "post": { - "tags": [ - "Import Export Profile" - ], - "summary": "Search for the Import Export Profile resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchImportExportProfile", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ImportExportProfile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/integration": { - "post": { - "tags": [ - "Integration" - ], - "summary": "Search for the Integration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchIntegration", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Integration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/landing-page": { - "post": { - "tags": [ - "Landing Page" - ], - "summary": "Search for the Landing Page resources.", - "description": "Available since: 6.4.0.0", - "operationId": "searchLandingPage", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of LandingPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/language": { - "post": { - "tags": [ - "Language" - ], - "summary": "Search for the Language resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchLanguage", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Language", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/locale": { - "post": { - "tags": [ - "Locale" - ], - "summary": "Search for the Locale resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchLocale", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Locale", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/log-entry": { - "post": { - "tags": [ - "Log Entry" - ], - "summary": "Search for the Log Entry resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchLogEntry", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of LogEntry", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/mail-header-footer": { - "post": { - "tags": [ - "Mail Header Footer" - ], - "summary": "Search for the Mail Header Footer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMailHeaderFooter", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MailHeaderFooter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/mail-template": { - "post": { - "tags": [ - "Mail Template" - ], - "summary": "Search for the Mail Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMailTemplate", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MailTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/mail-template-type": { - "post": { - "tags": [ - "Mail Template Type" - ], - "summary": "Search for the Mail Template Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMailTemplateType", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MailTemplateType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/main-category": { - "post": { - "tags": [ - "Main Category" - ], - "summary": "Search for the Main Category resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchMainCategory", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MainCategory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media": { - "post": { - "tags": [ - "Media" - ], - "summary": "Search for the Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMedia", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Media", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-ai-tag": { - "get": { - "tags": [ - "Media Ai Tag" - ], - "summary": "List with basic information of Media Ai Tag resources.", - "description": "", - "operationId": "getMediaAiTagList", - "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 Media Ai Tag 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/MediaAiTag" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/media-ai-tag?limit=25" - }, - "last": { - "example": "/media-ai-tag?limit=25&page=11" - }, - "next": { - "example": "/media-ai-tag?limit=25&page=4" - }, - "prev": { - "example": "/media-ai-tag?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Media Ai Tag" - ], - "summary": "Create a new Media Ai Tag resources.", - "description": "", - "operationId": "createMediaAiTag", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaAiTag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-ai-tag": { - "post": { - "tags": [ - "Media Ai Tag" - ], - "summary": "Search for the Media Ai Tag resources.", - "description": "", - "operationId": "searchMediaAiTag", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaAiTag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-ai-tag/{id}": { - "get": { - "tags": [ - "Media Ai Tag" - ], - "summary": "Detailed information about a Media Ai Tag resource.", - "description": "", - "operationId": "getMediaAiTag", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_ai_tag", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of MediaAiTag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Media Ai Tag" - ], - "summary": "Delete a Media Ai Tag resource.", - "description": "", - "operationId": "deleteMediaAiTag", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_ai_tag", - "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": [ - "Media Ai Tag" - ], - "summary": "Partially update information about a Media Ai Tag resource.", - "description": "", - "operationId": "updateMediaAiTag", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_ai_tag", - "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 Media Ai Tag resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of MediaAiTag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-default-folder": { - "post": { - "tags": [ - "Media Default Folder" - ], - "summary": "Search for the Media Default Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaDefaultFolder", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaDefaultFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-folder": { - "post": { - "tags": [ - "Media Folder" - ], - "summary": "Search for the Media Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaFolder", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-folder-configuration": { - "post": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "Search for the Media Folder Configuration resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaFolderConfiguration", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaFolderConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-thumbnail": { - "post": { - "tags": [ - "Media Thumbnail" - ], - "summary": "Search for the Media Thumbnail resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaThumbnail", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaThumbnail", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-thumbnail-size": { - "post": { - "tags": [ - "Media Thumbnail Size" - ], - "summary": "Search for the Media Thumbnail Size resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaThumbnailSize", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaThumbnailSize", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/newsletter-recipient": { - "post": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "Search for the Newsletter Recipient resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchNewsletterRecipient", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of NewsletterRecipient", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/notification": { - "post": { - "tags": [ - "Notification" - ], - "summary": "Search for the Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "searchNotification", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Notification", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/number-range": { - "post": { - "tags": [ - "Number Range" - ], - "summary": "Search for the Number Range resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRange", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRange", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/number-range-sales-channel": { - "post": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "Search for the Number Range Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRangeSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/number-range-state": { - "post": { - "tags": [ - "Number Range State" - ], - "summary": "Search for the Number Range State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRangeState", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/number-range-type": { - "post": { - "tags": [ - "Number Range Type" - ], - "summary": "Search for the Number Range Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRangeType", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order": { - "post": { - "tags": [ - "Order" - ], - "summary": "Search for the Order resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrder", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Order", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-address": { - "post": { - "tags": [ - "Order Address" - ], - "summary": "Search for the Order Address resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrderAddress", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-customer": { - "post": { - "tags": [ - "Order Customer" - ], - "summary": "Search for the Order Customer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrderCustomer", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-delivery": { - "post": { - "tags": [ - "Order Delivery" - ], - "summary": "Search for the Order Delivery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrderDelivery", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderDelivery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-delivery-position": { - "post": { - "tags": [ - "Order Delivery Position" - ], - "summary": "Search for the Order Delivery Position resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrderDeliveryPosition", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderDeliveryPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-line-item": { - "post": { - "tags": [ - "Order Line Item" - ], - "summary": "Search for the Order Line Item resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrderLineItem", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-line-item-download": { - "post": { - "tags": [ - "Order Line Item Download" - ], - "summary": "Search for the Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "searchOrderLineItemDownload", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderLineItemDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-product-warehouse": { - "get": { - "tags": [ - "Order Product Warehouse" - ], - "summary": "List with basic information of Order Product Warehouse resources.", - "description": "", - "operationId": "getOrderProductWarehouseList", - "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 Order Product Warehouse 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/OrderProductWarehouse" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-product-warehouse?limit=25" - }, - "last": { - "example": "/order-product-warehouse?limit=25&page=11" - }, - "next": { - "example": "/order-product-warehouse?limit=25&page=4" - }, - "prev": { - "example": "/order-product-warehouse?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Product Warehouse" - ], - "summary": "Create a new Order Product Warehouse resources.", - "description": "", - "operationId": "createOrderProductWarehouse", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-product-warehouse": { - "post": { - "tags": [ - "Order Product Warehouse" - ], - "summary": "Search for the Order Product Warehouse resources.", - "description": "", - "operationId": "searchOrderProductWarehouse", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-product-warehouse/{id}": { - "get": { - "tags": [ - "Order Product Warehouse" - ], - "summary": "Detailed information about a Order Product Warehouse resource.", - "description": "", - "operationId": "getOrderProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_product_warehouse", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Product Warehouse" - ], - "summary": "Delete a Order Product Warehouse resource.", - "description": "", - "operationId": "deleteOrderProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_product_warehouse", - "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": [ - "Order Product Warehouse" - ], - "summary": "Partially update information about a Order Product Warehouse resource.", - "description": "", - "operationId": "updateOrderProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_product_warehouse", - "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 Order Product Warehouse resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-return": { - "get": { - "tags": [ - "Order Return" - ], - "summary": "List with basic information of Order Return resources.", - "description": "", - "operationId": "getOrderReturnList", - "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 Order Return 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/OrderReturn" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-return?limit=25" - }, - "last": { - "example": "/order-return?limit=25&page=11" - }, - "next": { - "example": "/order-return?limit=25&page=4" - }, - "prev": { - "example": "/order-return?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Return" - ], - "summary": "Create a new Order Return resources.", - "description": "", - "operationId": "createOrderReturn", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderReturn", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-return": { - "post": { - "tags": [ - "Order Return" - ], - "summary": "Search for the Order Return resources.", - "description": "", - "operationId": "searchOrderReturn", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderReturn", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-return/{id}": { - "get": { - "tags": [ - "Order Return" - ], - "summary": "Detailed information about a Order Return resource.", - "description": "", - "operationId": "getOrderReturn", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderReturn", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Return" - ], - "summary": "Delete a Order Return resource.", - "description": "", - "operationId": "deleteOrderReturn", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return", - "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": [ - "Order Return" - ], - "summary": "Partially update information about a Order Return resource.", - "description": "", - "operationId": "updateOrderReturn", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return", - "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 Order Return resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderReturn", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-return-line-item": { - "get": { - "tags": [ - "Order Return Line Item" - ], - "summary": "List with basic information of Order Return Line Item resources.", - "description": "", - "operationId": "getOrderReturnLineItemList", - "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 Order Return Line Item 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/OrderReturnLineItem" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-return-line-item?limit=25" - }, - "last": { - "example": "/order-return-line-item?limit=25&page=11" - }, - "next": { - "example": "/order-return-line-item?limit=25&page=4" - }, - "prev": { - "example": "/order-return-line-item?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Return Line Item" - ], - "summary": "Create a new Order Return Line Item resources.", - "description": "", - "operationId": "createOrderReturnLineItem", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderReturnLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-return-line-item": { - "post": { - "tags": [ - "Order Return Line Item" - ], - "summary": "Search for the Order Return Line Item resources.", - "description": "", - "operationId": "searchOrderReturnLineItem", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderReturnLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-return-line-item/{id}": { - "get": { - "tags": [ - "Order Return Line Item" - ], - "summary": "Detailed information about a Order Return Line Item resource.", - "description": "", - "operationId": "getOrderReturnLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return_line_item", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderReturnLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Return Line Item" - ], - "summary": "Delete a Order Return Line Item resource.", - "description": "", - "operationId": "deleteOrderReturnLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return_line_item", - "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": [ - "Order Return Line Item" - ], - "summary": "Partially update information about a Order Return Line Item resource.", - "description": "", - "operationId": "updateOrderReturnLineItem", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return_line_item", - "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 Order Return Line Item resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderReturnLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-return-line-item-reason": { - "get": { - "tags": [ - "Order Return Line Item Reason" - ], - "summary": "List with basic information of Order Return Line Item Reason resources.", - "description": "", - "operationId": "getOrderReturnLineItemReasonList", - "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 Order Return Line Item Reason 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/OrderReturnLineItemReason" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-return-line-item-reason?limit=25" - }, - "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" - }, - "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" - }, - "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Return Line Item Reason" - ], - "summary": "Create a new Order Return Line Item Reason resources.", - "description": "", - "operationId": "createOrderReturnLineItemReason", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderReturnLineItemReason", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-return-line-item-reason": { - "post": { - "tags": [ - "Order Return Line Item Reason" - ], - "summary": "Search for the Order Return Line Item Reason resources.", - "description": "", - "operationId": "searchOrderReturnLineItemReason", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderReturnLineItemReason", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-return-line-item-reason/{id}": { - "get": { - "tags": [ - "Order Return Line Item Reason" - ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", - "description": "", - "operationId": "getOrderReturnLineItemReason", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return_line_item_reason", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderReturnLineItemReason", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Return Line Item Reason" - ], - "summary": "Delete a Order Return Line Item Reason resource.", - "description": "", - "operationId": "deleteOrderReturnLineItemReason", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return_line_item_reason", - "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": [ - "Order Return Line Item Reason" - ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", - "description": "", - "operationId": "updateOrderReturnLineItemReason", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_return_line_item_reason", - "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 Order Return Line Item Reason resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderReturnLineItemReason", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-transaction": { - "post": { - "tags": [ - "Order Transaction" - ], - "summary": "Search for the Order Transaction resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchOrderTransaction", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransaction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-transaction-capture": { - "post": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "Search for the Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCapture", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCapture", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-transaction-capture-refund": { - "post": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Search for the Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCaptureRefund", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-transaction-capture-refund-position": { - "post": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Search for the Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCaptureRefundPosition", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefundPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-warehouse-group": { - "get": { - "tags": [ - "Order Warehouse Group" - ], - "summary": "List with basic information of Order Warehouse Group resources.", - "description": "", - "operationId": "getOrderWarehouseGroupList", - "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 Order 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/OrderWarehouseGroup" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/order-warehouse-group?limit=25" - }, - "last": { - "example": "/order-warehouse-group?limit=25&page=11" - }, - "next": { - "example": "/order-warehouse-group?limit=25&page=4" - }, - "prev": { - "example": "/order-warehouse-group?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Order Warehouse Group" - ], - "summary": "Create a new Order Warehouse Group resources.", - "description": "", - "operationId": "createOrderWarehouseGroup", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderWarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-warehouse-group": { - "post": { - "tags": [ - "Order Warehouse Group" - ], - "summary": "Search for the Order Warehouse Group resources.", - "description": "", - "operationId": "searchOrderWarehouseGroup", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderWarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-warehouse-group/{id}": { - "get": { - "tags": [ - "Order Warehouse Group" - ], - "summary": "Detailed information about a Order Warehouse Group resource.", - "description": "", - "operationId": "getOrderWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_warehouse_group", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of OrderWarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Order Warehouse Group" - ], - "summary": "Delete a Order Warehouse Group resource.", - "description": "", - "operationId": "deleteOrderWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_warehouse_group", - "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": [ - "Order Warehouse Group" - ], - "summary": "Partially update information about a Order Warehouse Group resource.", - "description": "", - "operationId": "updateOrderWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_warehouse_group", - "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 Order Warehouse Group resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of OrderWarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/payment-method": { - "post": { - "tags": [ - "Payment Method" - ], - "summary": "Search for the Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPaymentMethod", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of PaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/plugin": { - "post": { - "tags": [ - "Plugin" - ], - "summary": "Search for the Plugin resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPlugin", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Plugin", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product": { - "post": { - "tags": [ - "Product" - ], - "summary": "Search for the Product resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProduct", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Product", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-configurator-setting": { - "post": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "Search for the Product Configurator Setting resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductConfiguratorSetting", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductConfiguratorSetting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-cross-selling": { - "post": { - "tags": [ - "Product Cross Selling" - ], - "summary": "Search for the Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchProductCrossSelling", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductCrossSelling", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-cross-selling-assigned-products": { - "post": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Search for the Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "searchProductCrossSellingAssignedProducts", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductCrossSellingAssignedProducts", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-download": { - "post": { - "tags": [ - "Product Download" - ], - "summary": "Search for the Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "searchProductDownload", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-export": { - "post": { - "tags": [ - "Product Export" - ], - "summary": "Search for the Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchProductExport", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductExport", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-feature-set": { - "post": { - "tags": [ - "Product Feature Set" - ], - "summary": "Search for the Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "searchProductFeatureSet", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductFeatureSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-keyword-dictionary": { - "post": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "Search for the Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductKeywordDictionary", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductKeywordDictionary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-manufacturer": { - "post": { - "tags": [ - "Product Manufacturer" - ], - "summary": "Search for the Product Manufacturer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductManufacturer", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductManufacturer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-media": { - "post": { - "tags": [ - "Product Media" - ], - "summary": "Search for the Product Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductMedia", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductMedia", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-price": { - "post": { - "tags": [ - "Product Price" - ], - "summary": "Search for the Product Price resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductPrice", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-review": { - "post": { - "tags": [ - "Product Review" - ], - "summary": "Search for the Product Review resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductReview", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductReview", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-review-summary": { - "get": { - "tags": [ - "Product Review Summary" - ], - "summary": "List with basic information of Product Review Summary resources.", - "description": "", - "operationId": "getProductReviewSummaryList", - "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 Product Review Summary 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/ProductReviewSummary" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-review-summary?limit=25" - }, - "last": { - "example": "/product-review-summary?limit=25&page=11" - }, - "next": { - "example": "/product-review-summary?limit=25&page=4" - }, - "prev": { - "example": "/product-review-summary?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Review Summary" - ], - "summary": "Create a new Product Review Summary resources.", - "description": "", - "operationId": "createProductReviewSummary", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductReviewSummary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-review-summary": { - "post": { - "tags": [ - "Product Review Summary" - ], - "summary": "Search for the Product Review Summary resources.", - "description": "", - "operationId": "searchProductReviewSummary", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductReviewSummary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-review-summary/{id}": { - "get": { - "tags": [ - "Product Review Summary" - ], - "summary": "Detailed information about a Product Review Summary resource.", - "description": "", - "operationId": "getProductReviewSummary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review_summary", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductReviewSummary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Review Summary" - ], - "summary": "Delete a Product Review Summary resource.", - "description": "", - "operationId": "deleteProductReviewSummary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review_summary", - "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": [ - "Product Review Summary" - ], - "summary": "Partially update information about a Product Review Summary resource.", - "description": "", - "operationId": "updateProductReviewSummary", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_review_summary", - "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 Product Review Summary resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductReviewSummary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-search-config": { - "post": { - "tags": [ - "Product Search Config" - ], - "summary": "Search for the Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchProductSearchConfig", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-search-config-field": { - "post": { - "tags": [ - "Product Search Config Field" - ], - "summary": "Search for the Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchProductSearchConfigField", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-search-keyword": { - "post": { - "tags": [ - "Product Search Keyword" - ], - "summary": "Search for the Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductSearchKeyword", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchKeyword", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-sorting": { - "post": { - "tags": [ - "Product Sorting" - ], - "summary": "Search for the Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "searchProductSorting", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-stream": { - "post": { - "tags": [ - "Product Stream" - ], - "summary": "Search for the Product Stream resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductStream", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductStream", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-stream-filter": { - "post": { - "tags": [ - "Product Stream Filter" - ], - "summary": "Search for the Product Stream Filter resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductStreamFilter", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-visibility": { - "post": { - "tags": [ - "Product Visibility" - ], - "summary": "Search for the Product Visibility resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductVisibility", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductVisibility", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-warehouse": { - "get": { - "tags": [ - "Product Warehouse" - ], - "summary": "List with basic information of Product Warehouse resources.", - "description": "", - "operationId": "getProductWarehouseList", - "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 Product Warehouse 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/ProductWarehouse" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/product-warehouse?limit=25" - }, - "last": { - "example": "/product-warehouse?limit=25&page=11" - }, - "next": { - "example": "/product-warehouse?limit=25&page=4" - }, - "prev": { - "example": "/product-warehouse?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Product Warehouse" - ], - "summary": "Create a new Product Warehouse resources.", - "description": "", - "operationId": "createProductWarehouse", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } - ], - "requestBody": { - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-warehouse": { - "post": { - "tags": [ - "Product Warehouse" - ], - "summary": "Search for the Product Warehouse resources.", - "description": "", - "operationId": "searchProductWarehouse", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-warehouse/{id}": { - "get": { - "tags": [ - "Product Warehouse" - ], - "summary": "Detailed information about a Product Warehouse resource.", - "description": "", - "operationId": "getProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_warehouse", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of ProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Product Warehouse" - ], - "summary": "Delete a Product Warehouse resource.", - "description": "", - "operationId": "deleteProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_warehouse", - "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": [ - "Product Warehouse" - ], - "summary": "Partially update information about a Product Warehouse resource.", - "description": "", - "operationId": "updateProductWarehouse", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_warehouse", - "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 Product Warehouse resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of ProductWarehouse", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/promotion": { - "post": { - "tags": [ - "Promotion" - ], - "summary": "Search for the Promotion resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPromotion", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Promotion", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - } - } + "204": { + "$ref": "#/components/responses/204" }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/promotion-discount": { - "post": { + }, + "patch": { "tags": [ - "Promotion Discount" + "Order Product Warehouse" + ], + "summary": "Partially update information about a Order Product Warehouse resource.", + "description": "", + "operationId": "updateOrderProductWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_product_warehouse", + "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" + } + } ], - "summary": "Search for the Promotion Discount resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionDiscount", "requestBody": { - "required": true, + "description": "Partially update information about a Order Product Warehouse resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderProductWarehouse" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "List of PromotionDiscount", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -21570,10 +11148,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -21583,15 +11158,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -21601,38 +11173,52 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/search/promotion-discount-prices": { - "post": { + "/order-return": { + "get": { "tags": [ - "Promotion Discount Prices" + "Order Return" ], - "summary": "Search for the Promotion Discount Prices resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionDiscountPrices", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of Order Return resources.", + "description": "", + "operationId": "getOrderReturnList", + "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 PromotionDiscountPrices", + "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21644,10 +11230,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/order-return?limit=25" + }, + "last": { + "example": "/order-return?limit=25&page=11" + }, + "next": { + "example": "/order-return?limit=25&page=4" + }, + "prev": { + "example": "/order-return?limit=25&page=2" + } + } + } + ] } } } @@ -21664,7 +11281,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -21672,41 +11289,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/promotion-individual-code": { + }, "post": { "tags": [ - "Promotion Individual Code" + "Order Return" + ], + "summary": "Create a new Order Return resources.", + "description": "", + "operationId": "createOrderReturn", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the Promotion Individual Code resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionIndividualCode", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "List of PromotionIndividualCode", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -21718,10 +11355,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } + "$ref": "#/components/schemas/OrderReturn" } } } @@ -21731,15 +11365,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } + "$ref": "#/components/schemas/OrderReturn" } } } @@ -21755,14 +11386,14 @@ } } }, - "/search/promotion-sales-channel": { + "/search/order-return": { "post": { "tags": [ - "Promotion Sales Channel" + "Order Return" ], - "summary": "Search for the Promotion Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionSalesChannel", + "summary": "Search for the Order Return resources.", + "description": "", + "operationId": "searchOrderReturn", "requestBody": { "required": true, "content": { @@ -21780,7 +11411,7 @@ }, "responses": { "200": { - "description": "List of PromotionSalesChannel", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -21794,7 +11425,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -21812,7 +11443,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -21829,32 +11460,29 @@ } } }, - "/search/promotion-setgroup": { - "post": { + "/order-return/{id}": { + "get": { "tags": [ - "Promotion Setgroup" + "Order Return" ], - "summary": "Search for the Promotion Setgroup resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionSetgroup", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a Order Return resource.", + "description": "", + "operationId": "getOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of PromotionSetgroup", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -21866,10 +11494,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" - } + "$ref": "#/components/schemas/OrderReturn" } } } @@ -21879,130 +11504,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" - } + "$ref": "#/components/schemas/OrderReturn" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/property-group": { - "post": { + }, + "delete": { "tags": [ - "Property Group" + "Order Return" ], - "summary": "Search for the Property Group resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPropertyGroup", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Delete a Order Return resource.", + "description": "", + "operationId": "deleteOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "200": { - "description": "List of PropertyGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - } - } - } + "204": { + "$ref": "#/components/responses/204" }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/property-group-option": { - "post": { + }, + "patch": { "tags": [ - "Property Group Option" + "Order Return" + ], + "summary": "Partially update information about a Order Return resource.", + "description": "", + "operationId": "updateOrderReturn", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_return", + "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" + } + } ], - "summary": "Search for the Property Group Option resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPropertyGroupOption", "requestBody": { - "required": true, + "description": "Partially update information about a Order Return resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderReturn" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "List of PropertyGroupOption", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -22014,10 +11633,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "$ref": "#/components/schemas/OrderReturn" } } } @@ -22027,15 +11643,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "$ref": "#/components/schemas/OrderReturn" } } } @@ -22045,20 +11658,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/quote": { + "/order-return-line-item": { "get": { "tags": [ - "Quote" + "Order Return Line Item" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", + "summary": "List with basic information of Order Return Line Item resources.", + "description": "", + "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", @@ -22087,7 +11703,7 @@ ], "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22106,7 +11722,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } ] @@ -22120,16 +11736,16 @@ "type": "object", "properties": { "first": { - "example": "/quote?limit=25" + "example": "/order-return-line-item?limit=25" }, "last": { - "example": "/quote?limit=25&page=11" + "example": "/order-return-line-item?limit=25&page=11" }, "next": { - "example": "/quote?limit=25&page=4" + "example": "/order-return-line-item?limit=25&page=4" }, "prev": { - "example": "/quote?limit=25&page=2" + "example": "/order-return-line-item?limit=25&page=2" } } } @@ -22150,7 +11766,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22165,11 +11781,11 @@ }, "post": { "tags": [ - "Quote" + "Order Return Line Item" ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", + "summary": "Create a new Order Return Line Item resources.", + "description": "", + "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", @@ -22191,7 +11807,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" }, "included": { "type": "array", @@ -22205,14 +11821,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22224,7 +11840,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22239,7 +11855,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22255,14 +11871,14 @@ } } }, - "/search/quote": { + "/search/order-return-line-item": { "post": { "tags": [ - "Quote" + "Order Return Line Item" ], - "summary": "Search for the Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuote", + "summary": "Search for the Order Return Line Item resources.", + "description": "", + "operationId": "searchOrderReturnLineItem", "requestBody": { "required": true, "content": { @@ -22280,7 +11896,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22294,7 +11910,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22312,7 +11928,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22329,19 +11945,19 @@ } } }, - "/quote/{id}": { + "/order-return-line-item/{id}": { "get": { "tags": [ - "Quote" + "Order Return Line Item" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", + "summary": "Detailed information about a Order Return Line Item resource.", + "description": "", + "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -22351,7 +11967,7 @@ ], "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22363,7 +11979,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22378,7 +11994,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22395,16 +12011,16 @@ }, "delete": { "tags": [ - "Quote" + "Order Return Line Item" ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", + "summary": "Delete a Order Return Line Item resource.", + "description": "", + "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -22435,16 +12051,16 @@ }, "patch": { "tags": [ - "Quote" + "Order Return Line Item" ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", + "summary": "Partially update information about a Order Return Line Item resource.", + "description": "", + "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -22462,14 +12078,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote resource.", + "description": "Partially update information about a Order Return Line Item resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" }, "included": { "type": "array", @@ -22483,14 +12099,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -22502,7 +12118,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22517,7 +12133,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -22536,14 +12152,14 @@ } } }, - "/quote-comment": { + "/order-return-line-item-reason": { "get": { "tags": [ - "Quote Comment" + "Order Return Line Item Reason" ], - "summary": "List with basic information of Quote Comment resources.", + "summary": "List with basic information of Order Return Line Item Reason resources.", "description": "", - "operationId": "getQuoteCommentList", + "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", @@ -22572,7 +12188,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22591,7 +12207,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] @@ -22605,16 +12221,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/order-return-line-item-reason?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/order-return-line-item-reason?limit=25&page=2" } } } @@ -22635,7 +12251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22650,11 +12266,11 @@ }, "post": { "tags": [ - "Quote Comment" + "Order Return Line Item Reason" ], - "summary": "Create a new Quote Comment resources.", + "summary": "Create a new Order Return Line Item Reason resources.", "description": "", - "operationId": "createQuoteComment", + "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", @@ -22676,7 +12292,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" }, "included": { "type": "array", @@ -22690,14 +12306,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -22709,7 +12325,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22724,7 +12340,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22740,14 +12356,14 @@ } } }, - "/search/quote-comment": { + "/search/order-return-line-item-reason": { "post": { "tags": [ - "Quote Comment" + "Order Return Line Item Reason" ], - "summary": "Search for the Quote Comment resources.", + "summary": "Search for the Order Return Line Item Reason resources.", "description": "", - "operationId": "searchQuoteComment", + "operationId": "searchOrderReturnLineItemReason", "requestBody": { "required": true, "content": { @@ -22765,7 +12381,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -22779,7 +12395,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22797,7 +12413,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22814,19 +12430,19 @@ } } }, - "/quote-comment/{id}": { + "/order-return-line-item-reason/{id}": { "get": { "tags": [ - "Quote Comment" + "Order Return Line Item Reason" ], - "summary": "Detailed information about a Quote Comment resource.", + "summary": "Detailed information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "getQuoteComment", + "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -22836,7 +12452,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -22848,7 +12464,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22863,7 +12479,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -22880,16 +12496,16 @@ }, "delete": { "tags": [ - "Quote Comment" + "Order Return Line Item Reason" ], - "summary": "Delete a Quote Comment resource.", + "summary": "Delete a Order Return Line Item Reason resource.", "description": "", - "operationId": "deleteQuoteComment", + "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -22920,16 +12536,16 @@ }, "patch": { "tags": [ - "Quote Comment" + "Order Return Line Item Reason" ], - "summary": "Partially update information about a Quote Comment resource.", + "summary": "Partially update information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "updateQuoteComment", + "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -22947,14 +12563,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" }, "included": { "type": "array", @@ -22968,14 +12584,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -22987,7 +12603,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -23002,7 +12618,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -23021,14 +12637,14 @@ } } }, - "/quote-delivery": { + "/order-warehouse-group": { "get": { "tags": [ - "Quote Delivery" + "Order Warehouse Group" ], - "summary": "List with basic information of Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", + "summary": "List with basic information of Order Warehouse Group resources.", + "description": "", + "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", @@ -23057,7 +12673,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23076,7 +12692,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] @@ -23090,16 +12706,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery?limit=25" + "example": "/order-warehouse-group?limit=25" }, "last": { - "example": "/quote-delivery?limit=25&page=11" + "example": "/order-warehouse-group?limit=25&page=11" }, "next": { - "example": "/quote-delivery?limit=25&page=4" + "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { - "example": "/quote-delivery?limit=25&page=2" + "example": "/order-warehouse-group?limit=25&page=2" } } } @@ -23120,7 +12736,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23135,11 +12751,11 @@ }, "post": { "tags": [ - "Quote Delivery" + "Order Warehouse Group" ], - "summary": "Create a new Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", + "summary": "Create a new Order Warehouse Group resources.", + "description": "", + "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", @@ -23161,7 +12777,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" }, "included": { "type": "array", @@ -23175,14 +12791,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -23194,7 +12810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23209,7 +12825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23225,14 +12841,14 @@ } } }, - "/search/quote-delivery": { + "/search/order-warehouse-group": { "post": { "tags": [ - "Quote Delivery" + "Order Warehouse Group" ], - "summary": "Search for the Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDelivery", + "summary": "Search for the Order Warehouse Group resources.", + "description": "", + "operationId": "searchOrderWarehouseGroup", "requestBody": { "required": true, "content": { @@ -23250,7 +12866,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -23264,7 +12880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23282,7 +12898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23299,19 +12915,19 @@ } } }, - "/quote-delivery/{id}": { + "/order-warehouse-group/{id}": { "get": { "tags": [ - "Quote Delivery" + "Order Warehouse Group" ], - "summary": "Detailed information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", + "summary": "Detailed information about a Order Warehouse Group resource.", + "description": "", + "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -23321,7 +12937,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -23333,7 +12949,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23348,7 +12964,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23365,16 +12981,16 @@ }, "delete": { "tags": [ - "Quote Delivery" + "Order Warehouse Group" ], - "summary": "Delete a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", + "summary": "Delete a Order Warehouse Group resource.", + "description": "", + "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -23405,16 +13021,16 @@ }, "patch": { "tags": [ - "Quote Delivery" + "Order Warehouse Group" ], - "summary": "Partially update information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", + "summary": "Partially update information about a Order Warehouse Group resource.", + "description": "", + "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -23432,14 +13048,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "description": "Partially update information about a Order Warehouse Group resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" }, "included": { "type": "array", @@ -23453,14 +13069,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -23472,7 +13088,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23487,7 +13103,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -23506,14 +13122,14 @@ } } }, - "/quote-delivery-position": { + "/product-review-summary": { "get": { "tags": [ - "Quote Delivery Position" + "Product Review Summary" ], - "summary": "List with basic information of Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPositionList", + "summary": "List with basic information of Product Review Summary resources.", + "description": "", + "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", @@ -23542,7 +13158,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23561,7 +13177,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } ] @@ -23575,16 +13191,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/product-review-summary?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/product-review-summary?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/product-review-summary?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/product-review-summary?limit=25&page=2" } } } @@ -23605,7 +13221,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23620,11 +13236,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Product Review Summary" ], - "summary": "Create a new Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "summary": "Create a new Product Review Summary resources.", + "description": "", + "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", @@ -23646,7 +13262,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" }, "included": { "type": "array", @@ -23660,14 +13276,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -23679,7 +13295,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23694,7 +13310,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23710,14 +13326,14 @@ } } }, - "/search/quote-delivery-position": { + "/search/product-review-summary": { "post": { "tags": [ - "Quote Delivery Position" + "Product Review Summary" ], - "summary": "Search for the Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDeliveryPosition", + "summary": "Search for the Product Review Summary resources.", + "description": "", + "operationId": "searchProductReviewSummary", "requestBody": { "required": true, "content": { @@ -23735,7 +13351,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -23749,7 +13365,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23767,7 +13383,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23784,19 +13400,19 @@ } } }, - "/quote-delivery-position/{id}": { + "/product-review-summary/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Product Review Summary" ], - "summary": "Detailed information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "summary": "Detailed information about a Product Review Summary resource.", + "description": "", + "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -23806,7 +13422,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -23818,7 +13434,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23833,7 +13449,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23850,16 +13466,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Product Review Summary" ], - "summary": "Delete a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", + "summary": "Delete a Product Review Summary resource.", + "description": "", + "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -23890,16 +13506,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Product Review Summary" ], - "summary": "Partially update information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDeliveryPosition", + "summary": "Partially update information about a Product Review Summary resource.", + "description": "", + "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -23917,14 +13533,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Product Review Summary resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" }, "included": { "type": "array", @@ -23938,14 +13554,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -23957,7 +13573,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23972,7 +13588,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -23991,14 +13607,14 @@ } } }, - "/quote-document": { + "/product-warehouse": { "get": { "tags": [ - "Quote Document" + "Product Warehouse" ], - "summary": "List with basic information of Quote Document resources.", + "summary": "List with basic information of Product Warehouse resources.", "description": "", - "operationId": "getQuoteDocumentList", + "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", @@ -24027,7 +13643,7 @@ ], "responses": { "200": { - "description": "List of Quote Document resources.", + "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24046,7 +13662,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } ] @@ -24060,16 +13676,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-document?limit=25" + "example": "/product-warehouse?limit=25" }, "last": { - "example": "/quote-document?limit=25&page=11" + "example": "/product-warehouse?limit=25&page=11" }, "next": { - "example": "/quote-document?limit=25&page=4" + "example": "/product-warehouse?limit=25&page=4" }, "prev": { - "example": "/quote-document?limit=25&page=2" + "example": "/product-warehouse?limit=25&page=2" } } } @@ -24090,7 +13706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24105,11 +13721,11 @@ }, "post": { "tags": [ - "Quote Document" + "Product Warehouse" ], - "summary": "Create a new Quote Document resources.", + "summary": "Create a new Product Warehouse resources.", "description": "", - "operationId": "createQuoteDocument", + "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", @@ -24131,7 +13747,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" }, "included": { "type": "array", @@ -24145,14 +13761,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -24164,7 +13780,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24179,7 +13795,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24195,14 +13811,14 @@ } } }, - "/search/quote-document": { + "/search/product-warehouse": { "post": { "tags": [ - "Quote Document" + "Product Warehouse" ], - "summary": "Search for the Quote Document resources.", + "summary": "Search for the Product Warehouse resources.", "description": "", - "operationId": "searchQuoteDocument", + "operationId": "searchProductWarehouse", "requestBody": { "required": true, "content": { @@ -24220,7 +13836,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -24234,7 +13850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24252,7 +13868,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24269,19 +13885,19 @@ } } }, - "/quote-document/{id}": { + "/product-warehouse/{id}": { "get": { "tags": [ - "Quote Document" + "Product Warehouse" ], - "summary": "Detailed information about a Quote Document resource.", + "summary": "Detailed information about a Product Warehouse resource.", "description": "", - "operationId": "getQuoteDocument", + "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -24291,7 +13907,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -24303,7 +13919,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24318,7 +13934,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24335,16 +13951,16 @@ }, "delete": { "tags": [ - "Quote Document" + "Product Warehouse" ], - "summary": "Delete a Quote Document resource.", + "summary": "Delete a Product Warehouse resource.", "description": "", - "operationId": "deleteQuoteDocument", + "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -24375,16 +13991,16 @@ }, "patch": { "tags": [ - "Quote Document" + "Product Warehouse" ], - "summary": "Partially update information about a Quote Document resource.", + "summary": "Partially update information about a Product Warehouse resource.", "description": "", - "operationId": "updateQuoteDocument", + "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -24402,14 +14018,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Document resource.", + "description": "Partially update information about a Product Warehouse resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" }, "included": { "type": "array", @@ -24423,14 +14039,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -24442,7 +14058,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24457,7 +14073,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -24476,14 +14092,14 @@ } } }, - "/quote-employee": { + "/quote": { "get": { "tags": [ - "Quote Employee" + "Quote" ], - "summary": "List with basic information of Quote Employee resources.", - "description": "", - "operationId": "getQuoteEmployeeList", + "summary": "List with basic information of Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteList", "parameters": [ { "name": "limit", @@ -24512,7 +14128,7 @@ ], "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24531,7 +14147,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } ] @@ -24545,16 +14161,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-employee?limit=25" + "example": "/quote?limit=25" }, "last": { - "example": "/quote-employee?limit=25&page=11" + "example": "/quote?limit=25&page=11" }, "next": { - "example": "/quote-employee?limit=25&page=4" + "example": "/quote?limit=25&page=4" }, "prev": { - "example": "/quote-employee?limit=25&page=2" + "example": "/quote?limit=25&page=2" } } } @@ -24575,7 +14191,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24590,11 +14206,11 @@ }, "post": { "tags": [ - "Quote Employee" + "Quote" ], - "summary": "Create a new Quote Employee resources.", - "description": "", - "operationId": "createQuoteEmployee", + "summary": "Create a new Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuote", "parameters": [ { "name": "_response", @@ -24616,7 +14232,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" }, "included": { "type": "array", @@ -24630,14 +14246,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -24649,7 +14265,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24664,7 +14280,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24680,14 +14296,14 @@ } } }, - "/search/quote-employee": { + "/search/quote": { "post": { "tags": [ - "Quote Employee" + "Quote" ], - "summary": "Search for the Quote Employee resources.", - "description": "", - "operationId": "searchQuoteEmployee", + "summary": "Search for the Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuote", "requestBody": { "required": true, "content": { @@ -24705,7 +14321,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -24719,7 +14335,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24737,7 +14353,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24754,19 +14370,19 @@ } } }, - "/quote-employee/{id}": { + "/quote/{id}": { "get": { "tags": [ - "Quote Employee" + "Quote" ], - "summary": "Detailed information about a Quote Employee resource.", - "description": "", - "operationId": "getQuoteEmployee", + "summary": "Detailed information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -24776,7 +14392,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -24788,7 +14404,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24803,7 +14419,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24820,16 +14436,16 @@ }, "delete": { "tags": [ - "Quote Employee" + "Quote" ], - "summary": "Delete a Quote Employee resource.", - "description": "", - "operationId": "deleteQuoteEmployee", + "summary": "Delete a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -24860,16 +14476,16 @@ }, "patch": { "tags": [ - "Quote Employee" + "Quote" ], - "summary": "Partially update information about a Quote Employee resource.", - "description": "", - "operationId": "updateQuoteEmployee", + "summary": "Partially update information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -24887,14 +14503,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "description": "Partially update information about a Quote resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" }, "included": { "type": "array", @@ -24908,14 +14524,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -24927,7 +14543,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24942,7 +14558,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/Quote" } } } @@ -24961,14 +14577,14 @@ } } }, - "/quote-line-item": { + "/quote-comment": { "get": { "tags": [ - "Quote Line Item" + "Quote Comment" ], - "summary": "List with basic information of Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItemList", + "summary": "List with basic information of Quote Comment resources.", + "description": "", + "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", @@ -24997,7 +14613,7 @@ ], "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25016,7 +14632,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } ] @@ -25030,16 +14646,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-line-item?limit=25" + "example": "/quote-comment?limit=25" }, "last": { - "example": "/quote-line-item?limit=25&page=11" + "example": "/quote-comment?limit=25&page=11" }, "next": { - "example": "/quote-line-item?limit=25&page=4" + "example": "/quote-comment?limit=25&page=4" }, "prev": { - "example": "/quote-line-item?limit=25&page=2" + "example": "/quote-comment?limit=25&page=2" } } } @@ -25060,7 +14676,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25075,11 +14691,11 @@ }, "post": { "tags": [ - "Quote Line Item" + "Quote Comment" ], - "summary": "Create a new Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", + "summary": "Create a new Quote Comment resources.", + "description": "", + "operationId": "createQuoteComment", "parameters": [ { "name": "_response", @@ -25101,7 +14717,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" }, "included": { "type": "array", @@ -25115,14 +14731,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -25134,7 +14750,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25149,7 +14765,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25165,14 +14781,14 @@ } } }, - "/search/quote-line-item": { + "/search/quote-comment": { "post": { "tags": [ - "Quote Line Item" + "Quote Comment" ], - "summary": "Search for the Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteLineItem", + "summary": "Search for the Quote Comment resources.", + "description": "", + "operationId": "searchQuoteComment", "requestBody": { "required": true, "content": { @@ -25190,7 +14806,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -25204,7 +14820,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25222,7 +14838,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25239,19 +14855,19 @@ } } }, - "/quote-line-item/{id}": { + "/quote-comment/{id}": { "get": { "tags": [ - "Quote Line Item" + "Quote Comment" ], - "summary": "Detailed information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", + "summary": "Detailed information about a Quote Comment resource.", + "description": "", + "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -25261,7 +14877,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -25273,7 +14889,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25288,7 +14904,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25305,16 +14921,16 @@ }, "delete": { "tags": [ - "Quote Line Item" + "Quote Comment" ], - "summary": "Delete a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", + "summary": "Delete a Quote Comment resource.", + "description": "", + "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -25345,16 +14961,16 @@ }, "patch": { "tags": [ - "Quote Line Item" + "Quote Comment" ], - "summary": "Partially update information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteLineItem", + "summary": "Partially update information about a Quote Comment resource.", + "description": "", + "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -25372,14 +14988,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "description": "Partially update information about a Quote Comment resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" }, "included": { "type": "array", @@ -25393,14 +15009,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -25412,7 +15028,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25427,7 +15043,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -25446,14 +15062,14 @@ } } }, - "/quote-transaction": { + "/quote-delivery": { "get": { "tags": [ - "Quote Transaction" + "Quote Delivery" ], - "summary": "List with basic information of Quote Transaction resources.", + "summary": "List with basic information of Quote Delivery resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransactionList", + "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", @@ -25482,7 +15098,7 @@ ], "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25501,7 +15117,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } ] @@ -25515,16 +15131,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-transaction?limit=25" + "example": "/quote-delivery?limit=25" }, "last": { - "example": "/quote-transaction?limit=25&page=11" + "example": "/quote-delivery?limit=25&page=11" }, "next": { - "example": "/quote-transaction?limit=25&page=4" + "example": "/quote-delivery?limit=25&page=4" }, "prev": { - "example": "/quote-transaction?limit=25&page=2" + "example": "/quote-delivery?limit=25&page=2" } } } @@ -25545,7 +15161,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25560,11 +15176,11 @@ }, "post": { "tags": [ - "Quote Transaction" + "Quote Delivery" ], - "summary": "Create a new Quote Transaction resources.", + "summary": "Create a new Quote Delivery resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", + "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", @@ -25586,7 +15202,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" }, "included": { "type": "array", @@ -25600,14 +15216,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25619,7 +15235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25634,7 +15250,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25650,14 +15266,14 @@ } } }, - "/search/quote-transaction": { + "/search/quote-delivery": { "post": { "tags": [ - "Quote Transaction" + "Quote Delivery" ], - "summary": "Search for the Quote Transaction resources.", + "summary": "Search for the Quote Delivery resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteTransaction", + "operationId": "searchQuoteDelivery", "requestBody": { "required": true, "content": { @@ -25675,7 +15291,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25689,7 +15305,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25707,7 +15323,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25724,19 +15340,19 @@ } } }, - "/quote-transaction/{id}": { + "/quote-delivery/{id}": { "get": { "tags": [ - "Quote Transaction" + "Quote Delivery" ], - "summary": "Detailed information about a Quote Transaction resource.", + "summary": "Detailed information about a Quote Delivery resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", + "operationId": "getQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -25746,7 +15362,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25758,7 +15374,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25773,7 +15389,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25790,16 +15406,16 @@ }, "delete": { "tags": [ - "Quote Transaction" + "Quote Delivery" ], - "summary": "Delete a Quote Transaction resource.", + "summary": "Delete a Quote Delivery resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", + "operationId": "deleteQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -25830,16 +15446,16 @@ }, "patch": { "tags": [ - "Quote Transaction" + "Quote Delivery" ], - "summary": "Partially update information about a Quote Transaction resource.", + "summary": "Partially update information about a Quote Delivery resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteTransaction", + "operationId": "updateQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -25857,14 +15473,14 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "description": "Partially update information about a Quote Delivery resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" }, "included": { "type": "array", @@ -25878,14 +15494,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -25897,7 +15513,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25912,7 +15528,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -25931,32 +15547,43 @@ } } }, - "/search/rule": { - "post": { + "/quote-delivery-position": { + "get": { "tags": [ - "Rule" + "Quote Delivery Position" ], - "summary": "Search for the Rule resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchRule", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", + "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 Rule", + "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25968,10 +15595,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-delivery-position?limit=25" + }, + "last": { + "example": "/quote-delivery-position?limit=25&page=11" + }, + "next": { + "example": "/quote-delivery-position?limit=25&page=4" + }, + "prev": { + "example": "/quote-delivery-position?limit=25&page=2" + } + } + } + ] } } } @@ -25988,7 +15646,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25996,41 +15654,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/rule-condition": { + }, "post": { "tags": [ - "Rule Condition" + "Quote Delivery Position" + ], + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the Rule Condition resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchRuleCondition", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "List of RuleCondition", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -26042,10 +15720,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26055,15 +15730,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26079,14 +15751,14 @@ } } }, - "/search/sales-channel": { + "/search/quote-delivery-position": { "post": { "tags": [ - "Sales Channel" + "Quote Delivery Position" ], - "summary": "Search for the Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannel", + "summary": "Search for the Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDeliveryPosition", "requestBody": { "required": true, "content": { @@ -26104,7 +15776,7 @@ }, "responses": { "200": { - "description": "List of SalesChannel", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -26118,7 +15790,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26136,7 +15808,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26153,32 +15825,29 @@ } } }, - "/search/sales-channel-analytics": { - "post": { + "/quote-delivery-position/{id}": { + "get": { "tags": [ - "Sales Channel Analytics" + "Quote Delivery Position" ], - "summary": "Search for the Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "searchSalesChannelAnalytics", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of SalesChannelAnalytics", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -26190,10 +15859,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26203,56 +15869,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/sales-channel-domain": { - "post": { + }, + "delete": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Delete a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "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": [ - "Sales Channel Domain" + "Quote Delivery Position" + ], + "summary": "Partially update information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDeliveryPosition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_delivery_position", + "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" + } + } ], - "summary": "Search for the Sales Channel Domain resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelDomain", "requestBody": { - "required": true, + "description": "Partially update information about a Quote Delivery Position resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "List of SalesChannelDomain", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -26264,10 +15998,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26277,15 +16008,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -26295,38 +16023,52 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/search/sales-channel-type": { - "post": { + "/quote-document": { + "get": { "tags": [ - "Sales Channel Type" + "Quote Document" ], - "summary": "Search for the Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelType", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of Quote Document resources.", + "description": "", + "operationId": "getQuoteDocumentList", + "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 SalesChannelType", + "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26338,10 +16080,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelType" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-document?limit=25" + }, + "last": { + "example": "/quote-document?limit=25&page=11" + }, + "next": { + "example": "/quote-document?limit=25&page=4" + }, + "prev": { + "example": "/quote-document?limit=25&page=2" + } + } + } + ] } } } @@ -26358,7 +16131,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26366,41 +16139,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/salutation": { + }, "post": { "tags": [ - "Salutation" + "Quote Document" + ], + "summary": "Create a new Quote Document resources.", + "description": "", + "operationId": "createQuoteDocument", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the Salutation resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalutation", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "List of Salutation", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -26412,10 +16205,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" - } + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26425,15 +16215,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" - } + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26449,14 +16236,14 @@ } } }, - "/search/scheduled-task": { + "/search/quote-document": { "post": { "tags": [ - "Scheduled Task" + "Quote Document" ], - "summary": "Search for the Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchScheduledTask", + "summary": "Search for the Quote Document resources.", + "description": "", + "operationId": "searchQuoteDocument", "requestBody": { "required": true, "content": { @@ -26474,7 +16261,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -26488,7 +16275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26506,7 +16293,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26523,32 +16310,29 @@ } } }, - "/search/script": { - "post": { + "/quote-document/{id}": { + "get": { "tags": [ - "Script" + "Quote Document" ], - "summary": "Search for the Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "searchScript", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a Quote Document resource.", + "description": "", + "operationId": "getQuoteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_document", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of Script", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -26560,10 +16344,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" - } + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26573,56 +16354,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" - } + "$ref": "#/components/schemas/QuoteDocument" } } } } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Quote Document" + ], + "summary": "Delete a Quote Document resource.", + "description": "", + "operationId": "deleteQuoteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_document", + "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": [ + "Quote Document" + ], + "summary": "Partially update information about a Quote Document resource.", + "description": "", + "operationId": "updateQuoteDocument", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_document", + "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" + } } - } - } - }, - "/search/seo-url": { - "post": { - "tags": [ - "Seo Url" ], - "summary": "Search for the Seo Url resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrl", "requestBody": { - "required": true, + "description": "Partially update information about a Quote Document resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteDocument" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -26634,10 +16483,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26647,15 +16493,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -26665,38 +16508,52 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/search/seo-url-template": { - "post": { + "/quote-employee": { + "get": { "tags": [ - "Seo Url Template" + "Quote Employee" ], - "summary": "Search for the Seo Url Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrlTemplate", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of Quote Employee resources.", + "description": "", + "operationId": "getQuoteEmployeeList", + "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 SeoUrlTemplate", + "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26708,10 +16565,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/quote-employee?limit=25" + }, + "last": { + "example": "/quote-employee?limit=25&page=11" + }, + "next": { + "example": "/quote-employee?limit=25&page=4" + }, + "prev": { + "example": "/quote-employee?limit=25&page=2" + } + } + } + ] } } } @@ -26728,7 +16616,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26736,41 +16624,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/shipping-method": { + }, "post": { "tags": [ - "Shipping Method" + "Quote Employee" + ], + "summary": "Create a new Quote Employee resources.", + "description": "", + "operationId": "createQuoteEmployee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the Shipping Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethod", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26782,10 +16690,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26795,15 +16700,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26819,14 +16721,14 @@ } } }, - "/search/shipping-method-price": { + "/search/quote-employee": { "post": { "tags": [ - "Shipping Method Price" + "Quote Employee" ], - "summary": "Search for the Shipping Method Price resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethodPrice", + "summary": "Search for the Quote Employee resources.", + "description": "", + "operationId": "searchQuoteEmployee", "requestBody": { "required": true, "content": { @@ -26844,7 +16746,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26858,7 +16760,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26876,7 +16778,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26893,32 +16795,29 @@ } } }, - "/search/snippet": { - "post": { + "/quote-employee/{id}": { + "get": { "tags": [ - "Snippet" + "Quote Employee" ], - "summary": "Search for the Snippet resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSnippet", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a Quote Employee resource.", + "description": "", + "operationId": "getQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of Snippet", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26930,10 +16829,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26943,56 +16839,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } + "$ref": "#/components/schemas/QuoteEmployee" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/snippet-set": { - "post": { + }, + "delete": { + "tags": [ + "Quote Employee" + ], + "summary": "Delete a Quote Employee resource.", + "description": "", + "operationId": "deleteQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "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": [ - "Snippet Set" + "Quote Employee" + ], + "summary": "Partially update information about a Quote Employee resource.", + "description": "", + "operationId": "updateQuoteEmployee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the quote_employee", + "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" + } + } ], - "summary": "Search for the Snippet Set resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSnippetSet", "requestBody": { - "required": true, + "description": "Partially update information about a Quote Employee resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/QuoteEmployee" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -27004,10 +16968,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" - } + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -27017,15 +16978,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" - } + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -27035,21 +16993,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/spatial-render-config-size": { + "/quote-line-item": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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", + "summary": "List with basic information of Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItemList", "parameters": [ { "name": "limit", @@ -27078,7 +17038,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27097,7 +17057,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } ] @@ -27111,16 +17071,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-render-config-size?limit=25" + "example": "/quote-line-item?limit=25" }, "last": { - "example": "/spatial-render-config-size?limit=25&page=11" + "example": "/quote-line-item?limit=25&page=11" }, "next": { - "example": "/spatial-render-config-size?limit=25&page=4" + "example": "/quote-line-item?limit=25&page=4" }, "prev": { - "example": "/spatial-render-config-size?limit=25&page=2" + "example": "/quote-line-item?limit=25&page=2" } } } @@ -27141,7 +17101,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27156,12 +17116,11 @@ }, "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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", + "summary": "Create a new Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteLineItem", "parameters": [ { "name": "_response", @@ -27183,7 +17142,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" }, "included": { "type": "array", @@ -27197,14 +17156,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -27216,7 +17175,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27231,7 +17190,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27247,15 +17206,14 @@ } } }, - "/search/spatial-render-config-size": { + "/search/quote-line-item": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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", + "summary": "Search for the Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteLineItem", "requestBody": { "required": true, "content": { @@ -27273,7 +17231,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -27287,7 +17245,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27305,7 +17263,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27322,20 +17280,19 @@ } } }, - "/spatial-render-config-size/{id}": { + "/quote-line-item/{id}": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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", + "summary": "Detailed information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -27345,7 +17302,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -27357,7 +17314,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27372,7 +17329,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27389,17 +17346,16 @@ }, "delete": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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", + "summary": "Delete a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -27430,17 +17386,16 @@ }, "patch": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Quote Line Item" ], - "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", + "summary": "Partially update information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -27458,14 +17413,14 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Quote Line Item resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" }, "included": { "type": "array", @@ -27479,14 +17434,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -27498,7 +17453,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27513,7 +17468,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27532,15 +17487,14 @@ } } }, - "/spatial-scene": { + "/quote-transaction": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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", + "summary": "List with basic information of Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", "parameters": [ { "name": "limit", @@ -27569,7 +17523,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27588,7 +17542,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } ] @@ -27602,16 +17556,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene?limit=25" + "example": "/quote-transaction?limit=25" }, "last": { - "example": "/spatial-scene?limit=25&page=11" + "example": "/quote-transaction?limit=25&page=11" }, "next": { - "example": "/spatial-scene?limit=25&page=4" + "example": "/quote-transaction?limit=25&page=4" }, "prev": { - "example": "/spatial-scene?limit=25&page=2" + "example": "/quote-transaction?limit=25&page=2" } } } @@ -27632,7 +17586,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27647,12 +17601,11 @@ }, "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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", + "summary": "Create a new Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", "parameters": [ { "name": "_response", @@ -27674,7 +17627,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" }, "included": { "type": "array", @@ -27688,14 +17641,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27707,7 +17660,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27722,7 +17675,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27738,15 +17691,14 @@ } } }, - "/search/spatial-scene": { + "/search/quote-transaction": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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", + "summary": "Search for the Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteTransaction", "requestBody": { "required": true, "content": { @@ -27764,7 +17716,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27778,7 +17730,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27796,7 +17748,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27813,20 +17765,19 @@ } } }, - "/spatial-scene/{id}": { + "/quote-transaction/{id}": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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", + "summary": "Detailed information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -27836,7 +17787,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27848,7 +17799,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27863,7 +17814,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27880,17 +17831,16 @@ }, "delete": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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", + "summary": "Delete a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -27921,17 +17871,16 @@ }, "patch": { "tags": [ - "Spatial Scene", - "Experimental" + "Quote Transaction" ], - "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", + "summary": "Partially update information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -27949,14 +17898,14 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Quote Transaction resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" }, "included": { "type": "array", @@ -27970,14 +17919,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27989,7 +17938,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -28004,7 +17953,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -28023,15 +17972,15 @@ } } }, - "/spatial-scene-camera": { + "/spatial-render-config-size": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "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 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": "getSpatialSceneCameraList", + "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", @@ -28060,7 +18009,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28079,7 +18028,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -28093,16 +18042,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -28123,7 +18072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28138,12 +18087,12 @@ }, "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "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 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": "createSpatialSceneCamera", + "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", @@ -28165,7 +18114,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" }, "included": { "type": "array", @@ -28179,14 +18128,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28198,7 +18147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28213,7 +18162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28229,15 +18178,15 @@ } } }, - "/search/spatial-scene-camera": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "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 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": "searchSpatialSceneCamera", + "operationId": "searchSpatialRenderConfigSize", "requestBody": { "required": true, "content": { @@ -28255,7 +18204,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28269,7 +18218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28287,7 +18236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28304,20 +18253,20 @@ } } }, - "/spatial-scene-camera/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "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 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": "getSpatialSceneCamera", + "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28327,7 +18276,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28339,7 +18288,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28354,7 +18303,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28371,17 +18320,17 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "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 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": "deleteSpatialSceneCamera", + "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28412,17 +18361,17 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", + "Spatial Render Config Size", "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 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": "updateSpatialSceneCamera", + "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28440,14 +18389,14 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" }, "included": { "type": "array", @@ -28461,14 +18410,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28480,7 +18429,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28495,7 +18444,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28514,15 +18463,15 @@ } } }, - "/spatial-scene-light": { + "/spatial-scene": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLightList", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -28551,7 +18500,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28570,7 +18519,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -28584,16 +18533,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -28614,7 +18563,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28629,12 +18578,12 @@ }, "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneLight", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -28656,7 +18605,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" }, "included": { "type": "array", @@ -28670,14 +18619,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28689,7 +18638,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28704,7 +18653,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28720,15 +18669,15 @@ } } }, - "/search/spatial-scene-light": { + "/search/spatial-scene": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneLight", + "operationId": "searchSpatialScene", "requestBody": { "required": true, "content": { @@ -28746,7 +18695,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28760,7 +18709,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28778,7 +18727,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28795,20 +18744,20 @@ } } }, - "/spatial-scene-light/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLight", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28818,7 +18767,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28830,7 +18779,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28845,7 +18794,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28862,17 +18811,17 @@ }, "delete": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneLight", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28903,17 +18852,17 @@ }, "patch": { "tags": [ - "Spatial Scene Light", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneLight", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28931,14 +18880,14 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" }, "included": { "type": "array", @@ -28952,14 +18901,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28971,7 +18920,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28986,7 +18935,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -29005,15 +18954,15 @@ } } }, - "/spatial-scene-object": { + "/spatial-scene-camera": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "getSpatialSceneObjectList", + "operationId": "getSpatialSceneCameraList", "parameters": [ { "name": "limit", @@ -29042,7 +18991,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29061,7 +19010,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } ] @@ -29075,16 +19024,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-object?limit=25" + "example": "/spatial-scene-camera?limit=25" }, "last": { - "example": "/spatial-scene-object?limit=25&page=11" + "example": "/spatial-scene-camera?limit=25&page=11" }, "next": { - "example": "/spatial-scene-object?limit=25&page=4" + "example": "/spatial-scene-camera?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-object?limit=25&page=2" + "example": "/spatial-scene-camera?limit=25&page=2" } } } @@ -29105,7 +19054,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29120,12 +19069,12 @@ }, "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "createSpatialSceneObject", + "operationId": "createSpatialSceneCamera", "parameters": [ { "name": "_response", @@ -29147,7 +19096,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" }, "included": { "type": "array", @@ -29161,14 +19110,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29180,7 +19129,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29195,7 +19144,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29211,15 +19160,15 @@ } } }, - "/search/spatial-scene-object": { + "/search/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "searchSpatialSceneObject", + "operationId": "searchSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -29237,7 +19186,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29251,7 +19200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29269,7 +19218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29286,20 +19235,20 @@ } } }, - "/spatial-scene-object/{id}": { + "/spatial-scene-camera/{id}": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "getSpatialSceneObject", + "operationId": "getSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -29309,7 +19258,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29321,7 +19270,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29336,7 +19285,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29353,17 +19302,17 @@ }, "delete": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "deleteSpatialSceneObject", + "operationId": "deleteSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -29394,17 +19343,17 @@ }, "patch": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Camera", "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 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": "updateSpatialSceneObject", + "operationId": "updateSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -29422,14 +19371,14 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" }, "included": { "type": "array", @@ -29443,14 +19392,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29462,7 +19411,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29477,7 +19426,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29496,15 +19445,15 @@ } } }, - "/sso-provider": { + "/spatial-scene-light": { "get": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "Experimental" ], - "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 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": "getSsoProviderList", + "operationId": "getSpatialSceneLightList", "parameters": [ { "name": "limit", @@ -29533,7 +19482,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29552,7 +19501,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } ] @@ -29566,16 +19515,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider?limit=25" + "example": "/spatial-scene-light?limit=25" }, "last": { - "example": "/sso-provider?limit=25&page=11" + "example": "/spatial-scene-light?limit=25&page=11" }, "next": { - "example": "/sso-provider?limit=25&page=4" + "example": "/spatial-scene-light?limit=25&page=4" }, "prev": { - "example": "/sso-provider?limit=25&page=2" + "example": "/spatial-scene-light?limit=25&page=2" } } } @@ -29596,7 +19545,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29611,12 +19560,12 @@ }, "post": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "Experimental" ], - "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 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": "createSsoProvider", + "operationId": "createSpatialSceneLight", "parameters": [ { "name": "_response", @@ -29638,7 +19587,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" }, "included": { "type": "array", @@ -29652,14 +19601,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29671,7 +19620,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29686,7 +19635,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29702,15 +19651,15 @@ } } }, - "/search/sso-provider": { + "/search/spatial-scene-light": { "post": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "Experimental" ], - "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 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": "searchSsoProvider", + "operationId": "searchSpatialSceneLight", "requestBody": { "required": true, "content": { @@ -29728,7 +19677,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29742,7 +19691,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29760,7 +19709,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29777,20 +19726,20 @@ } } }, - "/sso-provider/{id}": { + "/spatial-scene-light/{id}": { "get": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "Experimental" ], - "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 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": "getSsoProvider", + "operationId": "getSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29800,7 +19749,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29812,7 +19761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29827,7 +19776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29844,17 +19793,17 @@ }, "delete": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "Experimental" ], - "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 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": "deleteSsoProvider", + "operationId": "deleteSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29885,17 +19834,17 @@ }, "patch": { "tags": [ - "Sso Provider", + "Spatial Scene Light", "Experimental" ], - "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 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": "updateSsoProvider", + "operationId": "updateSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -29913,14 +19862,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Spatial Scene Light resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" }, "included": { "type": "array", @@ -29934,14 +19883,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29953,7 +19902,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29968,7 +19917,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29987,15 +19936,15 @@ } } }, - "/sso-provider-customer": { + "/spatial-scene-object": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "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 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": "getSsoProviderCustomerList", + "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", @@ -30024,7 +19973,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30043,7 +19992,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } ] @@ -30057,16 +20006,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/spatial-scene-object?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/spatial-scene-object?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/spatial-scene-object?limit=25&page=2" } } } @@ -30087,7 +20036,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30102,12 +20051,12 @@ }, "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "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 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": "createSsoProviderCustomer", + "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", @@ -30129,7 +20078,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" }, "included": { "type": "array", @@ -30143,14 +20092,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30162,7 +20111,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30177,7 +20126,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30193,15 +20142,15 @@ } } }, - "/search/sso-provider-customer": { + "/search/spatial-scene-object": { "post": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "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 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": "searchSsoProviderCustomer", + "operationId": "searchSpatialSceneObject", "requestBody": { "required": true, "content": { @@ -30219,7 +20168,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30233,7 +20182,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30251,7 +20200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30268,20 +20217,20 @@ } } }, - "/sso-provider-customer/{id}": { + "/spatial-scene-object/{id}": { "get": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "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 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": "getSsoProviderCustomer", + "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30291,7 +20240,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30303,7 +20252,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30318,7 +20267,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30335,17 +20284,17 @@ }, "delete": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "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 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": "deleteSsoProviderCustomer", + "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30376,17 +20325,17 @@ }, "patch": { "tags": [ - "Sso Provider Customer", + "Spatial Scene Object", "Experimental" ], - "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 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": "updateSsoProviderCustomer", + "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -30404,14 +20353,14 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider Customer resource.", + "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" }, "included": { "type": "array", @@ -30425,14 +20374,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -30444,7 +20393,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30459,7 +20408,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -30478,310 +20427,15 @@ } } }, - "/search/state-machine": { - "post": { - "tags": [ - "State Machine" - ], - "summary": "Search for the State Machine resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachine", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachine", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/state-machine-history": { - "post": { - "tags": [ - "State Machine History" - ], - "summary": "Search for the State Machine History resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineHistory", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/state-machine-state": { - "post": { - "tags": [ - "State Machine State" - ], - "summary": "Search for the State Machine State resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineState", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/state-machine-transition": { - "post": { - "tags": [ - "State Machine Transition" - ], - "summary": "Search for the State Machine Transition resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineTransition", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineTransition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/subscription": { + "/sso-provider": { "get": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "List with basic information of Subscription resources.", + "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": "getSubscriptionList", + "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", @@ -30810,7 +20464,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30829,7 +20483,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } ] @@ -30843,16 +20497,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/sso-provider?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/sso-provider?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/sso-provider?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/sso-provider?limit=25&page=2" } } } @@ -30873,7 +20527,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -30888,11 +20542,12 @@ }, "post": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Create a new Subscription resources.", + "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": "createSubscription", + "operationId": "createSsoProvider", "parameters": [ { "name": "_response", @@ -30914,7 +20569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" }, "included": { "type": "array", @@ -30928,14 +20583,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -30947,7 +20602,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -30962,7 +20617,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -30978,14 +20633,15 @@ } } }, - "/search/subscription": { + "/search/sso-provider": { "post": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Search for the Subscription resources.", + "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": "searchSubscription", + "operationId": "searchSsoProvider", "requestBody": { "required": true, "content": { @@ -31003,7 +20659,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31017,7 +20673,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31035,7 +20691,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31052,19 +20708,20 @@ } } }, - "/subscription/{id}": { + "/sso-provider/{id}": { "get": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Detailed information about a Subscription resource.", + "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": "getSubscription", + "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31074,7 +20731,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31086,7 +20743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31101,7 +20758,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31118,16 +20775,17 @@ }, "delete": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Delete a Subscription resource.", + "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": "deleteSubscription", + "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31158,16 +20816,17 @@ }, "patch": { "tags": [ - "Subscription" + "Sso Provider", + "Experimental" ], - "summary": "Partially update information about a Subscription resource.", + "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": "updateSubscription", + "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -31185,14 +20844,14 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription resource.", + "description": "Partially update information about a Sso Provider resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" }, "included": { "type": "array", @@ -31206,14 +20865,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -31225,7 +20884,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31240,7 +20899,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -31259,14 +20918,15 @@ } } }, - "/subscription-address": { + "/sso-provider-customer": { "get": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "List with basic information of Subscription Address resources.", + "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": "getSubscriptionAddressList", + "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", @@ -31295,7 +20955,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31314,7 +20974,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } ] @@ -31328,16 +20988,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/sso-provider-customer?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/sso-provider-customer?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/sso-provider-customer?limit=25&page=2" } } } @@ -31358,7 +21018,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31373,11 +21033,12 @@ }, "post": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Create a new Subscription Address resources.", + "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": "createSubscriptionAddress", + "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", @@ -31399,7 +21060,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" }, "included": { "type": "array", @@ -31413,14 +21074,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -31432,7 +21093,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31447,7 +21108,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31463,14 +21124,15 @@ } } }, - "/search/subscription-address": { + "/search/sso-provider-customer": { "post": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Search for the Subscription Address resources.", + "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": "searchSubscriptionAddress", + "operationId": "searchSsoProviderCustomer", "requestBody": { "required": true, "content": { @@ -31488,7 +21150,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -31502,7 +21164,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31520,7 +21182,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31537,19 +21199,20 @@ } } }, - "/subscription-address/{id}": { + "/sso-provider-customer/{id}": { "get": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Detailed information about a Subscription Address resource.", + "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": "getSubscriptionAddress", + "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -31559,7 +21222,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -31571,7 +21234,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31586,7 +21249,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31603,16 +21266,17 @@ }, "delete": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Delete a Subscription Address resource.", + "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": "deleteSubscriptionAddress", + "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -31643,16 +21307,17 @@ }, "patch": { "tags": [ - "Subscription Address" + "Sso Provider Customer", + "Experimental" ], - "summary": "Partially update information about a Subscription Address resource.", + "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": "updateSubscriptionAddress", + "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -31670,14 +21335,14 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" }, "included": { "type": "array", @@ -31691,14 +21356,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -31710,7 +21375,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31725,7 +21390,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -31744,14 +21409,14 @@ } } }, - "/subscription-customer": { + "/subscription": { "get": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "List with basic information of Subscription Customer resources.", + "summary": "List with basic information of Subscription resources.", "description": "", - "operationId": "getSubscriptionCustomerList", + "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", @@ -31780,7 +21445,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31799,7 +21464,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } ] @@ -31813,16 +21478,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/subscription?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/subscription?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/subscription?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/subscription?limit=25&page=2" } } } @@ -31843,7 +21508,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -31858,11 +21523,11 @@ }, "post": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Create a new Subscription Customer resources.", + "summary": "Create a new Subscription resources.", "description": "", - "operationId": "createSubscriptionCustomer", + "operationId": "createSubscription", "parameters": [ { "name": "_response", @@ -31884,7 +21549,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" }, "included": { "type": "array", @@ -31898,14 +21563,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -31917,7 +21582,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -31932,7 +21597,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -31948,14 +21613,14 @@ } } }, - "/search/subscription-customer": { + "/search/subscription": { "post": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Search for the Subscription Customer resources.", + "summary": "Search for the Subscription resources.", "description": "", - "operationId": "searchSubscriptionCustomer", + "operationId": "searchSubscription", "requestBody": { "required": true, "content": { @@ -31973,7 +21638,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -31987,7 +21652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32005,7 +21670,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32022,19 +21687,19 @@ } } }, - "/subscription-customer/{id}": { + "/subscription/{id}": { "get": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Detailed information about a Subscription Customer resource.", + "summary": "Detailed information about a Subscription resource.", "description": "", - "operationId": "getSubscriptionCustomer", + "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32044,7 +21709,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32056,7 +21721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32071,7 +21736,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32088,16 +21753,16 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Delete a Subscription Customer resource.", + "summary": "Delete a Subscription resource.", "description": "", - "operationId": "deleteSubscriptionCustomer", + "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32128,16 +21793,16 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Subscription" ], - "summary": "Partially update information about a Subscription Customer resource.", + "summary": "Partially update information about a Subscription resource.", "description": "", - "operationId": "updateSubscriptionCustomer", + "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -32155,14 +21820,14 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "description": "Partially update information about a Subscription resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" }, "included": { "type": "array", @@ -32176,14 +21841,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -32195,7 +21860,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32210,7 +21875,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -32229,14 +21894,14 @@ } } }, - "/subscription-interval": { + "/subscription-address": { "get": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Subscription Address resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", @@ -32265,7 +21930,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32284,7 +21949,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } ] @@ -32298,16 +21963,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/subscription-address?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/subscription-address?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/subscription-address?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/subscription-address?limit=25&page=2" } } } @@ -32328,7 +21993,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32343,11 +22008,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Subscription Address resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", @@ -32369,7 +22034,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" }, "included": { "type": "array", @@ -32383,14 +22048,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -32402,7 +22067,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32417,7 +22082,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32433,14 +22098,14 @@ } } }, - "/search/subscription-interval": { + "/search/subscription-address": { "post": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Search for the Subscription Interval resources.", + "summary": "Search for the Subscription Address resources.", "description": "", - "operationId": "searchSubscriptionInterval", + "operationId": "searchSubscriptionAddress", "requestBody": { "required": true, "content": { @@ -32458,7 +22123,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -32472,7 +22137,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32490,7 +22155,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32507,19 +22172,19 @@ } } }, - "/subscription-interval/{id}": { + "/subscription-address/{id}": { "get": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Subscription Address resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -32529,7 +22194,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -32541,7 +22206,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32556,7 +22221,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32573,16 +22238,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Subscription Address resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -32613,16 +22278,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Subscription Address" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Subscription Address resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -32640,14 +22305,14 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Subscription Address resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" }, "included": { "type": "array", @@ -32661,14 +22326,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -32680,7 +22345,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32695,7 +22360,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -32714,14 +22379,14 @@ } } }, - "/subscription-plan": { + "/subscription-customer": { "get": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "List with basic information of Subscription Plan resources.", + "summary": "List with basic information of Subscription Customer resources.", "description": "", - "operationId": "getSubscriptionPlanList", + "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", @@ -32750,7 +22415,7 @@ ], "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32769,7 +22434,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } ] @@ -32783,16 +22448,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-plan?limit=25" + "example": "/subscription-customer?limit=25" }, "last": { - "example": "/subscription-plan?limit=25&page=11" + "example": "/subscription-customer?limit=25&page=11" }, "next": { - "example": "/subscription-plan?limit=25&page=4" + "example": "/subscription-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-plan?limit=25&page=2" + "example": "/subscription-customer?limit=25&page=2" } } } @@ -32813,7 +22478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -32828,11 +22493,11 @@ }, "post": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Create a new Subscription Plan resources.", + "summary": "Create a new Subscription Customer resources.", "description": "", - "operationId": "createSubscriptionPlan", + "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", @@ -32854,7 +22519,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" }, "included": { "type": "array", @@ -32868,14 +22533,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32887,7 +22552,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -32902,7 +22567,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -32918,14 +22583,14 @@ } } }, - "/search/subscription-plan": { + "/search/subscription-customer": { "post": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Search for the Subscription Plan resources.", + "summary": "Search for the Subscription Customer resources.", "description": "", - "operationId": "searchSubscriptionPlan", + "operationId": "searchSubscriptionCustomer", "requestBody": { "required": true, "content": { @@ -32943,7 +22608,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32957,7 +22622,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -32975,7 +22640,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -32992,19 +22657,19 @@ } } }, - "/subscription-plan/{id}": { + "/subscription-customer/{id}": { "get": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Detailed information about a Subscription Plan resource.", + "summary": "Detailed information about a Subscription Customer resource.", "description": "", - "operationId": "getSubscriptionPlan", + "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -33014,7 +22679,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33026,7 +22691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33041,7 +22706,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33058,16 +22723,16 @@ }, "delete": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Delete a Subscription Plan resource.", + "summary": "Delete a Subscription Customer resource.", "description": "", - "operationId": "deleteSubscriptionPlan", + "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -33098,16 +22763,16 @@ }, "patch": { "tags": [ - "Subscription Plan" + "Subscription Customer" ], - "summary": "Partially update information about a Subscription Plan resource.", + "summary": "Partially update information about a Subscription Customer resource.", "description": "", - "operationId": "updateSubscriptionPlan", + "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -33125,14 +22790,14 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "description": "Partially update information about a Subscription Customer resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" }, "included": { "type": "array", @@ -33146,14 +22811,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33165,7 +22830,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33180,7 +22845,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -33199,14 +22864,14 @@ } } }, - "/swag-delay-action": { + "/subscription-interval": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "List with basic information of Swag Delay Action resources.", + "summary": "List with basic information of Subscription Interval resources.", "description": "", - "operationId": "getSwagDelayActionList", + "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", @@ -33235,7 +22900,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33254,7 +22919,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } ] @@ -33268,16 +22933,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-delay-action?limit=25" + "example": "/subscription-interval?limit=25" }, "last": { - "example": "/swag-delay-action?limit=25&page=11" + "example": "/subscription-interval?limit=25&page=11" }, "next": { - "example": "/swag-delay-action?limit=25&page=4" + "example": "/subscription-interval?limit=25&page=4" }, "prev": { - "example": "/swag-delay-action?limit=25&page=2" + "example": "/subscription-interval?limit=25&page=2" } } } @@ -33298,7 +22963,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33313,11 +22978,11 @@ }, "post": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Create a new Swag Delay Action resources.", + "summary": "Create a new Subscription Interval resources.", "description": "", - "operationId": "createSwagDelayAction", + "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", @@ -33339,7 +23004,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" }, "included": { "type": "array", @@ -33353,14 +23018,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -33372,7 +23037,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33387,7 +23052,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33403,14 +23068,14 @@ } } }, - "/search/swag-delay-action": { + "/search/subscription-interval": { "post": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Search for the Swag Delay Action resources.", + "summary": "Search for the Subscription Interval resources.", "description": "", - "operationId": "searchSwagDelayAction", + "operationId": "searchSubscriptionInterval", "requestBody": { "required": true, "content": { @@ -33428,7 +23093,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -33442,7 +23107,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33460,7 +23125,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33477,19 +23142,19 @@ } } }, - "/swag-delay-action/{id}": { + "/subscription-interval/{id}": { "get": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Detailed information about a Swag Delay Action resource.", + "summary": "Detailed information about a Subscription Interval resource.", "description": "", - "operationId": "getSwagDelayAction", + "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -33499,7 +23164,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -33511,7 +23176,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33526,7 +23191,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33543,16 +23208,16 @@ }, "delete": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Delete a Swag Delay Action resource.", + "summary": "Delete a Subscription Interval resource.", "description": "", - "operationId": "deleteSwagDelayAction", + "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -33583,16 +23248,16 @@ }, "patch": { "tags": [ - "Swag Delay Action" + "Subscription Interval" ], - "summary": "Partially update information about a Swag Delay Action resource.", + "summary": "Partially update information about a Subscription Interval resource.", "description": "", - "operationId": "updateSwagDelayAction", + "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -33610,14 +23275,14 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "description": "Partially update information about a Subscription Interval resource.", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" }, "included": { "type": "array", @@ -33631,14 +23296,14 @@ }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -33650,7 +23315,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33665,7 +23330,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -33684,106 +23349,43 @@ } } }, - "/search/system-config": { - "post": { + "/subscription-plan": { + "get": { "tags": [ - "System Config" + "Subscription Plan" ], - "summary": "Search for the System Config resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSystemConfig", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - } + "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" } }, - "400": { - "$ref": "#/components/responses/400" + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/tag": { - "post": { - "tags": [ - "Tag" - ], - "summary": "Search for the Tag resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTag", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "List of Tag", + "description": "List of Subscription Plan resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33795,10 +23397,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "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" + } + } + } + ] } } } @@ -33815,7 +23448,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -33823,115 +23456,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/tax": { + }, "post": { "tags": [ - "Tax" + "Subscription Plan" ], - "summary": "Search for the Tax resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTax", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Tax", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tax" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tax" - } - } - } - } - } + "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" + ] } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/search/tax-provider": { - "post": { - "tags": [ - "Tax Provider" ], - "summary": "Search for the Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "searchTaxProvider", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -33943,10 +23522,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -33956,15 +23532,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -33980,14 +23553,14 @@ } } }, - "/search/tax-rule": { + "/search/subscription-plan": { "post": { "tags": [ - "Tax Rule" + "Subscription Plan" ], - "summary": "Search for the Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRule", + "summary": "Search for the Subscription Plan resources.", + "description": "", + "operationId": "searchSubscriptionPlan", "requestBody": { "required": true, "content": { @@ -34005,7 +23578,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34019,7 +23592,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34037,7 +23610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34054,32 +23627,29 @@ } } }, - "/search/tax-rule-type": { - "post": { + "/subscription-plan/{id}": { + "get": { "tags": [ - "Tax Rule Type" + "Subscription Plan" ], - "summary": "Search for the Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRuleType", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "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": "List of TaxRuleType", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34091,10 +23661,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" - } + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34104,56 +23671,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" - } + "$ref": "#/components/schemas/SubscriptionPlan" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/theme": { - "post": { + }, + "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": [ - "Theme" + "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" + } + } ], - "summary": "Search for the Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTheme", "requestBody": { - "required": true, + "description": "Partially update information about a Subscription Plan resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionPlan" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "List of Theme", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -34165,10 +23800,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34178,15 +23810,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -34196,38 +23825,52 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/search/unit": { - "post": { + "/swag-delay-action": { + "get": { "tags": [ - "Unit" + "Swag Delay Action" ], - "summary": "Search for the Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUnit", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "List with basic information of Swag Delay Action resources.", + "description": "", + "operationId": "getSwagDelayActionList", + "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 Unit", + "description": "List of Swag Delay Action resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34239,10 +23882,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Unit" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-delay-action?limit=25" + }, + "last": { + "example": "/swag-delay-action?limit=25&page=11" + }, + "next": { + "example": "/swag-delay-action?limit=25&page=4" + }, + "prev": { + "example": "/swag-delay-action?limit=25&page=2" + } + } + } + ] } } } @@ -34259,7 +23933,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34267,41 +23941,61 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/user": { + }, "post": { "tags": [ - "User" + "Swag Delay Action" + ], + "summary": "Create a new Swag Delay Action resources.", + "description": "", + "operationId": "createSwagDelayAction", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Search for the User resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUser", "requestBody": { - "required": true, "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "List of User", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -34313,10 +24007,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34326,15 +24017,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34350,14 +24038,14 @@ } } }, - "/search/user-access-key": { + "/search/swag-delay-action": { "post": { "tags": [ - "User Access Key" + "Swag Delay Action" ], - "summary": "Search for the User Access Key resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUserAccessKey", + "summary": "Search for the Swag Delay Action resources.", + "description": "", + "operationId": "searchSwagDelayAction", "requestBody": { "required": true, "content": { @@ -34375,7 +24063,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -34389,7 +24077,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34407,7 +24095,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34424,32 +24112,29 @@ } } }, - "/search/user-config": { - "post": { + "/swag-delay-action/{id}": { + "get": { "tags": [ - "User Config" + "Swag Delay Action" ], - "summary": "Search for the User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchUserConfig", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Detailed information about a Swag Delay Action resource.", + "description": "", + "operationId": "getSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of UserConfig", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -34461,10 +24146,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserConfig" - } + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34474,56 +24156,124 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserConfig" - } + "$ref": "#/components/schemas/SwagDelayAction" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/search/user-recovery": { - "post": { + }, + "delete": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Delete a Swag Delay Action resource.", + "description": "", + "operationId": "deleteSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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" + "Swag Delay Action" + ], + "summary": "Partially update information about a Swag Delay Action resource.", + "description": "", + "operationId": "updateSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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" + } + } ], - "summary": "Search for the User Recovery resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUserRecovery", "requestBody": { - "required": true, + "description": "Partially update information about a Swag Delay Action resource.", "content": { "application/vnd.api+json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + }, + "included": { + "type": "array", + "items": { + "$ref": "#/components/schemas/resource" + }, + "uniqueItems": true + } + } } }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -34535,10 +24285,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34548,15 +24295,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -34566,6 +24310,9 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } @@ -35261,295 +25008,14 @@ } } }, - "/search/warehouse-group": { - "post": { - "tags": [ - "Warehouse Group" - ], - "summary": "Search for the Warehouse Group resources.", - "description": "", - "operationId": "searchWarehouseGroup", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of WarehouseGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/warehouse-group/{id}": { - "get": { - "tags": [ - "Warehouse Group" - ], - "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}$" - } - } - ], - "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" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Warehouse Group" - ], - "summary": "Delete a Warehouse Group resource.", - "description": "", - "operationId": "deleteWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", - "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": [ - "Warehouse Group" - ], - "summary": "Partially update information about a Warehouse Group resource.", - "description": "", - "operationId": "updateWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", - "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 Warehouse Group resource.", - "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, - "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" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/webhook": { + "/search/warehouse-group": { "post": { "tags": [ - "Webhook" + "Warehouse Group" ], - "summary": "Search for the Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchWebhook", + "summary": "Search for the Warehouse Group resources.", + "description": "", + "operationId": "searchWarehouseGroup", "requestBody": { "required": true, "content": { @@ -35567,7 +25033,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -35581,7 +25047,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -35599,7 +25065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -35616,32 +25082,29 @@ } } }, - "/search/webhook-event-log": { - "post": { + "/warehouse-group/{id}": { + "get": { "tags": [ - "Webhook Event Log" + "Warehouse Group" ], - "summary": "Search for the Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "searchWebhookEventLog", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "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}$" } } - }, + ], "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -35653,10 +25116,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" - } + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -35666,252 +25126,165 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" - } + "$ref": "#/components/schemas/WarehouseGroup" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "endpoints" - ], - "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } - } - } - } - } + }, + "delete": { + "tags": [ + "Warehouse Group" + ], + "summary": "Delete a Warehouse Group resource.", + "description": "", + "operationId": "deleteWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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" + } } - } - }, - "/_action/order/{orderId}/order-address": { - "post": { + }, + "patch": { "tags": [ - "Order address" + "Warehouse Group" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "summary": "Partially update information about a Warehouse Group resource.", + "description": "", + "operationId": "updateWarehouseGroup", "parameters": [ { - "name": "orderId", + "name": "id", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier for the warehouse_group", "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 Warehouse Group resource.", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { "type": "object", "properties": { - "mapping": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + }, + "included": { "type": "array", "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "type": "string", - "description": "The ID of the delivery (optional)", - "nullable": true - } - }, - "required": [ - "customerAddressId", - "type" - ] + "$ref": "#/components/schemas/resource" }, - "description": "The mapping of order addresses" + "uniqueItems": true } } } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." - } - } - } - }, - "/_proxy/generate-imitate-customer-token": { - "post": { - "tags": [ - "Customer impersonation" - ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", - "requestBody": { - "required": true, - "content": { + }, "application/json": { "schema": { - "required": [ - "customerId", - "salesChannelId" - ], - "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" - }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/WarehouseGroup" } } } }, "responses": { "200": { - "description": "The generated customer impersonation token.", + "description": "Detail of WarehouseGroup", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } } - }, - "type": "object" + ] } - } - } - } - } - } - }, - "/_info/system-health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", - "parameters": [ - { - "name": "verbose", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" - } - ], - "responses": { - "200": { - "description": "Returns the system health check results", - "content": { + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } + "data": { + "$ref": "#/components/schemas/WarehouseGroup" } } } } } }, - "500": { - "description": "Application is not working properly" + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } @@ -36844,9 +26217,7 @@ { "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -36985,9 +26356,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "privileges", - "createdAt" + "name" ], "properties": { "id": { @@ -37043,8 +26412,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "userId", - "aclRoleId", - "createdAt" + "aclRoleId" ], "properties": { "id": { @@ -37088,8 +26456,7 @@ "id", "configId", "type", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -37205,8 +26572,7 @@ "id", "configId", "type", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -37269,8 +26635,7 @@ "id", "term", "salesChannelId", - "actionId", - "createdAt" + "actionId" ], "properties": { "id": { @@ -37371,8 +26736,7 @@ "id", "term", "salesChannelId", - "actionId", - "createdAt" + "actionId" ], "properties": { "id": { @@ -37419,8 +26783,7 @@ "id", "boost", "name", - "configId", - "createdAt" + "configId" ], "properties": { "id": { @@ -37569,8 +26932,7 @@ "id", "boost", "name", - "configId", - "createdAt" + "configId" ], "properties": { "id": { @@ -37637,11 +26999,7 @@ { "required": [ "id", - "salesChannelId", - "esEnabled", - "andLogic", - "minSearchLength", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -37820,11 +27178,7 @@ "AdvancedSearchConfig": { "required": [ "id", - "salesChannelId", - "esEnabled", - "andLogic", - "minSearchLength", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -37927,11 +27281,7 @@ "id", "configId", "entity", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -38045,11 +27395,7 @@ "id", "configId", "entity", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -38107,8 +27453,7 @@ { "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -38209,8 +27554,7 @@ "AdvancedSearchEntityStream": { "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -38259,8 +27603,7 @@ "required": [ "id", "entityStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -38407,8 +27750,7 @@ "required": [ "id", "entityStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -38475,8 +27817,7 @@ { "required": [ "id", - "left", - "createdAt" + "left" ], "properties": { "id": { @@ -38551,8 +27892,7 @@ "AdvancedSearchSynonym": { "required": [ "id", - "left", - "createdAt" + "left" ], "properties": { "id": { @@ -38602,13 +27942,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -38682,6 +28018,15 @@ "checkoutGatewayUrl": { "type": "string" }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, "label": { "type": "string" }, @@ -39099,13 +28444,9 @@ "id", "name", "path", - "active", - "configurable", "version", - "allowDisable", "integrationId", "aclRoleId", - "createdAt", "label" ], "properties": { @@ -39179,6 +28520,15 @@ "checkoutGatewayUrl": { "type": "string" }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, "label": { "type": "string" }, @@ -39295,7 +28645,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -39383,7 +28732,6 @@ "url", "action", "appId", - "createdAt", "label" ], "properties": { @@ -39440,8 +28788,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -39480,8 +28827,7 @@ "id", "value", "appId", - "localeId", - "createdAt" + "localeId" ], "properties": { "id": { @@ -39526,7 +28872,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -39614,7 +28959,6 @@ "template", "styles", "appId", - "createdAt", "label" ], "properties": { @@ -39672,7 +29016,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -39824,7 +29167,6 @@ "appId", "name", "url", - "createdAt", "label" ], "properties": { @@ -39922,8 +29264,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -40032,8 +29373,7 @@ "id", "appId", "name", - "aware", - "createdAt" + "aware" ], "properties": { "id": { @@ -40089,8 +29429,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -40246,8 +29585,7 @@ "id", "appName", "identifier", - "paymentMethodId", - "createdAt" + "paymentMethodId" ], "properties": { "id": { @@ -40324,7 +29662,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -40444,7 +29781,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -40510,8 +29846,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -40649,8 +29984,7 @@ "id", "appName", "identifier", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -40709,8 +30043,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -40786,8 +30119,7 @@ "template", "path", "active", - "appId", - "createdAt" + "appId" ], "properties": { "id": { @@ -40830,8 +30162,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -40929,8 +30260,7 @@ }, "B2bBusinessPartner": { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -40979,8 +30309,7 @@ "name", "priority", "active", - "conditions", - "createdAt" + "conditions" ], "properties": { "id": { @@ -41129,8 +30458,7 @@ "name", "priority", "active", - "conditions", - "createdAt" + "conditions" ], "properties": { "id": { @@ -41199,7 +30527,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -41288,7 +30615,6 @@ "identifier", "active", "appId", - "createdAt", "name" ], "properties": { @@ -41360,8 +30686,7 @@ "cartPayload", "itemRounding", "totalRounding", - "lineItemCount", - "createdAt" + "lineItemCount" ], "properties": { "id": { @@ -41994,8 +31319,7 @@ "cartPayload", "itemRounding", "totalRounding", - "lineItemCount", - "createdAt" + "lineItemCount" ], "properties": { "id": { @@ -42254,8 +31578,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -42462,8 +31785,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -42558,8 +31880,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -42666,8 +31987,7 @@ "B2bComponentsRole": { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -42723,8 +32043,7 @@ "required": [ "id", "salesChannelId", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -42761,7 +32080,10 @@ "type": "object" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -42964,8 +32286,7 @@ "required": [ "id", "salesChannelId", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -43002,7 +32323,10 @@ "type": "object" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -43047,8 +32371,7 @@ { "required": [ "id", - "quantity", - "createdAt" + "quantity" ], "properties": { "id": { @@ -43068,7 +32391,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantity": { "type": "integer", @@ -43159,8 +32485,7 @@ "description": "Added since version: 6.6.2.0", "required": [ "id", - "quantity", - "createdAt" + "quantity" ], "properties": { "id": { @@ -43180,7 +32505,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantity": { "type": "integer", @@ -43219,8 +32547,7 @@ "languageId", "firstName", "lastName", - "email", - "createdAt" + "email" ], "properties": { "id": { @@ -43407,8 +32734,7 @@ "languageId", "firstName", "lastName", - "email", - "createdAt" + "email" ], "properties": { "id": { @@ -43515,8 +32841,7 @@ "orderId", "firstName", "lastName", - "employeeId", - "createdAt" + "employeeId" ], "properties": { "id": { @@ -43629,8 +32954,7 @@ "orderId", "firstName", "lastName", - "employeeId", - "createdAt" + "employeeId" ], "properties": { "id": { @@ -43687,8 +33011,7 @@ "required": [ "id", "name", - "group", - "createdAt" + "group" ], "properties": { "id": { @@ -43726,8 +33049,7 @@ "required": [ "id", "name", - "group", - "createdAt" + "group" ], "properties": { "id": { @@ -43768,10 +33090,6 @@ { "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -44334,10 +33652,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayNestedProducts", - "type", - "productAssignmentType", - "createdAt", "name" ], "properties": { @@ -44603,8 +33917,7 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -44796,8 +34109,7 @@ "id", "position", "type", - "sectionId", - "createdAt" + "sectionId" ], "properties": { "id": { @@ -44908,8 +34220,7 @@ { "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -45161,8 +34472,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -45263,8 +34573,7 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -45447,8 +34756,7 @@ "id", "position", "type", - "pageId", - "createdAt" + "pageId" ], "properties": { "id": { @@ -45552,8 +34860,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -45652,8 +34959,7 @@ "id", "type", "slot", - "blockId", - "createdAt" + "blockId" ], "properties": { "id": { @@ -45722,8 +35028,6 @@ { "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -46110,8 +35414,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "isEu", - "createdAt", "name", "addressFormat" ], @@ -46323,7 +35625,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -46507,7 +35808,6 @@ "id", "countryId", "shortCode", - "createdAt", "name" ], "properties": { @@ -46616,7 +35916,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -47014,7 +36313,6 @@ "isoCode", "itemRounding", "totalRounding", - "createdAt", "shortName", "name" ], @@ -47233,8 +36531,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -47376,8 +36673,7 @@ "currencyId", "countryId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -47463,8 +36759,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -47526,8 +36821,7 @@ "required": [ "id", "name", - "fields", - "createdAt" + "fields" ], "properties": { "id": { @@ -47592,8 +36886,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -47707,8 +37000,7 @@ "required": [ "id", "name", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -47768,8 +37060,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -47942,8 +37233,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -48014,8 +37304,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -48083,8 +37372,7 @@ "required": [ "id", "customFieldSetId", - "entityName", - "createdAt" + "entityName" ], "properties": { "id": { @@ -48123,8 +37411,7 @@ "required": [ "id", "productId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -48261,8 +37548,7 @@ "required": [ "id", "productId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -48328,9 +37614,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -49395,9 +38679,7 @@ "firstName", "lastName", "email", - "accountType", - "defaultPaymentMethodId", - "createdAt" + "defaultPaymentMethodId" ], "properties": { "id": { @@ -49968,8 +39250,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -50173,8 +39454,7 @@ "firstName", "lastName", "city", - "street", - "createdAt" + "street" ], "properties": { "id": { @@ -50267,7 +39547,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -50455,7 +39734,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -50561,8 +39839,7 @@ "description": "Added since version: 6.3.1.0", "required": [ "customerGroupId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -50601,8 +39878,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -50670,8 +39946,7 @@ "required": [ "id", "hash", - "customerId", - "createdAt" + "customerId" ], "properties": { "id": { @@ -50710,8 +39985,7 @@ "required": [ "id", "customerId", - "features", - "createdAt" + "features" ], "properties": { "id": { @@ -50778,8 +40052,7 @@ "required": [ "id", "customerId", - "features", - "createdAt" + "features" ], "properties": { "id": { @@ -50847,8 +40120,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -50980,8 +40252,7 @@ "required": [ "id", "customerId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -51034,8 +40305,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -51137,8 +40407,7 @@ "required": [ "id", "productId", - "wishlistId", - "createdAt" + "wishlistId" ], "properties": { "id": { @@ -51188,8 +40457,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -51305,8 +40573,7 @@ "name", "min", "max", - "unit", - "createdAt" + "unit" ], "properties": { "id": { @@ -51371,8 +40638,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -51595,8 +40861,7 @@ "fileType", "orderId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -51685,9 +40950,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -51837,9 +41100,7 @@ "required": [ "id", "documentTypeId", - "name", - "global", - "createdAt" + "name" ], "properties": { "id": { @@ -51909,8 +41170,7 @@ { "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -52040,8 +41300,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId", - "createdAt" + "documentBaseConfigId" ], "properties": { "id": { @@ -52092,7 +41351,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -52266,7 +41524,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -52363,8 +41620,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -52519,8 +41775,7 @@ "required": [ "id", "name", - "eventName", - "createdAt" + "eventName" ], "properties": { "id": { @@ -52621,8 +41876,7 @@ { "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -52903,8 +42157,7 @@ "description": "Added since version: 6.4.6.0", "required": [ "id", - "flowId", - "createdAt" + "flowId" ], "properties": { "id": { @@ -53054,8 +42307,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -53087,8 +42339,7 @@ "description": "Added since version: 6.4.18.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -53125,8 +42376,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -53205,8 +42455,7 @@ "id", "originalName", "path", - "expireDate", - "createdAt" + "expireDate" ], "properties": { "id": { @@ -53258,8 +42507,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -53476,8 +42724,7 @@ "activity", "state", "records", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -53563,8 +42810,7 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { @@ -53669,8 +42915,7 @@ "sourceEntity", "fileType", "delimiter", - "enclosure", - "createdAt" + "enclosure" ], "properties": { "id": { @@ -53746,8 +42991,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -53899,8 +43143,7 @@ "id", "label", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -54025,7 +43268,6 @@ { "required": [ "id", - "createdAt", "name", "url" ], @@ -54219,7 +43461,6 @@ "description": "Added since version: 6.4.0.0", "required": [ "id", - "createdAt", "name", "url" ], @@ -54375,8 +43616,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -54950,8 +44190,7 @@ "required": [ "id", "localeId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -55169,7 +44408,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -55280,7 +44518,6 @@ "required": [ "id", "code", - "createdAt", "name", "territory" ], @@ -55337,8 +44574,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -55379,8 +44615,7 @@ "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -55425,7 +44660,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -55512,7 +44746,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -55573,7 +44806,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -55696,7 +44928,6 @@ "required": [ "id", "mailTemplateTypeId", - "createdAt", "subject", "contentHtml", "contentPlain" @@ -55804,7 +45035,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -55886,7 +45116,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -55942,8 +45171,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -56083,8 +45311,7 @@ "id", "productId", "categoryId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -56141,8 +45368,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -57137,8 +46363,7 @@ "Media": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -57554,8 +46779,7 @@ { "required": [ "id", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -57632,8 +46856,7 @@ "MediaAiTag": { "required": [ "id", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -57683,8 +46906,7 @@ { "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -57750,8 +46972,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "entity", - "createdAt" + "entity" ], "properties": { "id": { @@ -57790,8 +47011,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -58002,8 +47222,7 @@ "required": [ "id", "configurationId", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -58082,8 +47301,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -58194,8 +47412,7 @@ "MediaFolderConfiguration": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -58313,8 +47530,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -58400,8 +47616,7 @@ "id", "mediaId", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -58458,8 +47673,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -58533,8 +47747,7 @@ "required": [ "id", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -58584,8 +47797,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -58784,8 +47996,7 @@ "status", "hash", "languageId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -58904,8 +48115,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -59019,8 +48229,7 @@ "required": [ "id", "status", - "message", - "createdAt" + "message" ], "properties": { "id": { @@ -59083,7 +48292,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -59234,7 +48442,6 @@ "global", "pattern", "start", - "createdAt", "name" ], "properties": { @@ -59303,8 +48510,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -59435,8 +48641,7 @@ "required": [ "id", "numberRangeId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -59487,8 +48692,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -59557,8 +48761,7 @@ "required": [ "id", "numberRangeId", - "lastValue", - "createdAt" + "lastValue" ], "properties": { "id": { @@ -59599,7 +48802,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -59709,7 +48911,6 @@ "required": [ "id", "global", - "createdAt", "typeName" ], "properties": { @@ -59774,8 +48975,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -60692,8 +49892,7 @@ "currencyFactor", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -61247,8 +50446,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -61494,8 +50692,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -61608,8 +50805,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -61780,8 +50976,7 @@ "orderId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -61873,10 +51068,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -62160,10 +51353,8 @@ "shippingOrderAddressId", "shippingMethodId", "stateId", - "trackingCodes", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -62313,8 +51504,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -62496,8 +51686,7 @@ "required": [ "id", "orderDeliveryId", - "orderLineItemId", - "createdAt" + "orderLineItemId" ], "properties": { "id": { @@ -62628,11 +51817,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -63149,11 +52336,9 @@ "identifier", "quantity", "label", - "position", "states", "price", - "children", - "createdAt" + "children" ], "properties": { "id": { @@ -63437,8 +52622,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -63556,8 +52740,7 @@ "orderLineItemId", "mediaId", "position", - "accessGranted", - "createdAt" + "accessGranted" ], "properties": { "id": { @@ -63619,8 +52802,7 @@ "id", "orderId", "productId", - "warehouseId", - "createdAt" + "warehouseId" ], "properties": { "id": { @@ -63769,8 +52951,7 @@ "id", "orderId", "productId", - "warehouseId", - "createdAt" + "warehouseId" ], "properties": { "id": { @@ -63841,8 +53022,7 @@ "orderId", "stateId", "returnNumber", - "requestedAt", - "createdAt" + "requestedAt" ], "properties": { "id": { @@ -64158,8 +53338,7 @@ "orderId", "stateId", "returnNumber", - "requestedAt", - "createdAt" + "requestedAt" ], "properties": { "id": { @@ -64346,8 +53525,7 @@ "reasonId", "quantity", "price", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -64601,8 +53779,7 @@ "reasonId", "quantity", "price", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -64746,7 +53923,6 @@ "required": [ "id", "reasonKey", - "createdAt", "content" ], "properties": { @@ -64818,7 +53994,6 @@ "required": [ "id", "reasonKey", - "createdAt", "content" ], "properties": { @@ -64898,8 +54073,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -65134,8 +54308,7 @@ "orderId", "paymentMethodId", "amount", - "stateId", - "createdAt" + "stateId" ], "properties": { "id": { @@ -65264,8 +54437,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -65466,8 +54638,7 @@ "id", "orderTransactionId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -65589,8 +54760,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -65794,8 +54964,7 @@ "id", "captureId", "stateId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -65920,8 +55089,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -66102,8 +55270,7 @@ "id", "refundId", "orderLineItemId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -66228,8 +55395,7 @@ "required": [ "id", "orderId", - "warehouseGroupId", - "createdAt" + "warehouseGroupId" ], "properties": { "id": { @@ -66334,8 +55500,7 @@ "required": [ "id", "orderId", - "warehouseGroupId", - "createdAt" + "warehouseGroupId" ], "properties": { "id": { @@ -66386,7 +55551,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -66803,7 +55967,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -67018,7 +56181,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -67152,7 +56314,6 @@ "name", "autoload", "version", - "createdAt", "label" ], "properties": { @@ -67259,7 +56420,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -67328,7 +56488,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -67407,7 +56570,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -68738,7 +57904,6 @@ "price", "productNumber", "stock", - "createdAt", "name" ], "properties": { @@ -68807,7 +57972,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "productNumber": { "type": "string" @@ -68886,7 +58054,10 @@ "type": "boolean" }, "purchasePrices": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "markAsTopseller": { "type": "boolean" @@ -69525,8 +58696,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -69675,8 +58845,7 @@ "required": [ "id", "productId", - "optionId", - "createdAt" + "optionId" ], "properties": { "id": { @@ -69745,10 +58914,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -69907,10 +59073,7 @@ "required": [ "id", "name", - "position", - "type", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -69990,8 +59153,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -70097,8 +59259,7 @@ "required": [ "id", "crossSellingId", - "productId", - "createdAt" + "productId" ], "properties": { "id": { @@ -70182,8 +59343,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -70296,8 +59456,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -70365,8 +59524,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -70613,8 +59771,7 @@ "encoding", "fileFormat", "generateByCronjob", - "interval", - "createdAt" + "interval" ], "properties": { "id": { @@ -70719,7 +59876,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -70794,7 +59950,6 @@ "description": "Added since version: 6.3.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -70936,7 +60091,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -71059,7 +60213,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -71130,8 +60283,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -71275,8 +60427,7 @@ "required": [ "id", "productId", - "mediaId", - "createdAt" + "mediaId" ], "properties": { "id": { @@ -71375,8 +60526,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -71400,7 +60550,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -71498,8 +60651,7 @@ "productId", "ruleId", "price", - "quantityStart", - "createdAt" + "quantityStart" ], "properties": { "id": { @@ -71523,7 +60675,10 @@ "pattern": "^[0-9a-f]{32}$" }, "price": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "quantityStart": { "type": "integer", @@ -71600,8 +60755,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -71797,8 +60951,7 @@ "salesChannelId", "languageId", "title", - "content", - "createdAt" + "content" ], "properties": { "id": { @@ -71884,8 +61037,7 @@ "required": [ "id", "productId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -71995,8 +61147,7 @@ "required": [ "id", "productId", - "salesChannelId", - "createdAt" + "salesChannelId" ], "properties": { "id": { @@ -72052,10 +61203,7 @@ { "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -72163,10 +61311,7 @@ "description": "Added since version: 6.3.5.0", "required": [ "id", - "languageId", - "andLogic", - "minSearchLength", - "createdAt" + "languageId" ], "properties": { "id": { @@ -72222,11 +61367,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -72337,11 +61478,7 @@ "required": [ "id", "searchConfigId", - "field", - "tokenize", - "searchable", - "ranking", - "createdAt" + "field" ], "properties": { "id": { @@ -72400,8 +61537,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -72516,8 +61652,7 @@ "languageId", "productId", "keyword", - "ranking", - "createdAt" + "ranking" ], "properties": { "id": { @@ -72579,7 +61714,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -72632,7 +61766,6 @@ "priority", "active", "fields", - "createdAt", "label" ], "properties": { @@ -72684,7 +61817,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -72860,7 +61992,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -72935,8 +62066,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -73087,8 +62217,7 @@ "required": [ "id", "productStreamId", - "type", - "createdAt" + "type" ], "properties": { "id": { @@ -73225,8 +62354,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -73333,8 +62461,7 @@ "id", "productId", "salesChannelId", - "visibility", - "createdAt" + "visibility" ], "properties": { "id": { @@ -73386,8 +62513,7 @@ "id", "productId", "warehouseId", - "stock", - "createdAt" + "stock" ], "properties": { "id": { @@ -73493,8 +62619,7 @@ "id", "productId", "warehouseId", - "stock", - "createdAt" + "stock" ], "properties": { "id": { @@ -73576,14 +62701,6 @@ { "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -74002,14 +63119,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "active", - "priority", - "exclusive", - "useCodes", - "useIndividualCodes", - "useSetGroups", - "preventCombination", - "createdAt", "name" ], "properties": { @@ -74233,8 +63342,7 @@ "scope", "type", "value", - "considerAdvancedRules", - "createdAt" + "considerAdvancedRules" ], "properties": { "id": { @@ -74393,8 +63501,7 @@ "scope", "type", "value", - "considerAdvancedRules", - "createdAt" + "considerAdvancedRules" ], "properties": { "id": { @@ -74473,8 +63580,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -74577,8 +63683,7 @@ "id", "discountId", "currencyId", - "price", - "createdAt" + "price" ], "properties": { "id": { @@ -74654,8 +63759,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -74726,8 +63830,7 @@ "required": [ "id", "promotionId", - "code", - "createdAt" + "code" ], "properties": { "id": { @@ -74855,8 +63958,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -74959,8 +64061,7 @@ "id", "promotionId", "salesChannelId", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -75010,8 +64111,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -75119,8 +64219,7 @@ "promotionId", "packagerKey", "sorterKey", - "value", - "createdAt" + "value" ], "properties": { "id": { @@ -75200,9 +64299,6 @@ { "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -75293,9 +64389,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "displayType", - "sortingType", - "createdAt", "name" ], "properties": { @@ -75360,7 +64453,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -75568,7 +64660,6 @@ "required": [ "id", "groupId", - "createdAt", "name" ], "properties": { @@ -75652,8 +64743,7 @@ "salesChannelId", "customerId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -76370,8 +65460,7 @@ "salesChannelId", "customerId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -76696,8 +65785,7 @@ "required": [ "id", "comment", - "quoteId", - "createdAt" + "quoteId" ], "properties": { "id": { @@ -76875,8 +65963,7 @@ "required": [ "id", "comment", - "quoteId", - "createdAt" + "quoteId" ], "properties": { "id": { @@ -76951,8 +66038,7 @@ "quoteId", "shippingMethodId", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -77159,8 +66245,7 @@ "quoteId", "shippingMethodId", "shippingDateEarliest", - "shippingDateLatest", - "createdAt" + "shippingDateLatest" ], "properties": { "id": { @@ -77286,8 +66371,7 @@ "required": [ "id", "quoteDeliveryId", - "quoteLineItemId", - "createdAt" + "quoteLineItemId" ], "properties": { "id": { @@ -77469,8 +66553,7 @@ "required": [ "id", "quoteDeliveryId", - "quoteLineItemId", - "createdAt" + "quoteLineItemId" ], "properties": { "id": { @@ -77600,8 +66683,7 @@ "fileType", "quoteId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -77766,8 +66848,7 @@ "fileType", "quoteId", "config", - "deepLinkCode", - "createdAt" + "deepLinkCode" ], "properties": { "id": { @@ -77851,8 +66932,7 @@ "quoteId", "employeeId", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -77965,8 +67045,7 @@ "quoteId", "employeeId", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -78030,8 +67109,7 @@ "label", "quantity", "price", - "position", - "createdAt" + "position" ], "properties": { "id": { @@ -78165,10 +67243,16 @@ "type": "object" }, "productPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "purchasePrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "discount": { "properties": { @@ -78412,8 +67496,7 @@ "label", "quantity", "price", - "position", - "createdAt" + "position" ], "properties": { "id": { @@ -78547,10 +67630,16 @@ "type": "object" }, "productPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "purchasePrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "discount": { "properties": { @@ -78632,8 +67721,7 @@ "id", "quoteId", "paymentMethodId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -78800,8 +67888,7 @@ "id", "quoteId", "paymentMethodId", - "amount", - "createdAt" + "amount" ], "properties": { "id": { @@ -78913,8 +68000,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -79506,8 +68592,7 @@ "required": [ "id", "name", - "priority", - "createdAt" + "priority" ], "properties": { "id": { @@ -79747,8 +68832,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -79923,8 +69007,7 @@ "required": [ "id", "type", - "ruleId", - "createdAt" + "ruleId" ], "properties": { "id": { @@ -80030,7 +69113,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -81428,7 +70510,6 @@ "countryId", "navigationCategoryId", "accessKey", - "createdAt", "name", "homeEnabled" ], @@ -81875,8 +70956,7 @@ }, { "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -81947,8 +71027,7 @@ "SalesChannelAnalytics": { "description": "Added since version: 6.2.0.0", "required": [ - "id", - "createdAt" + "id" ], "properties": { "id": { @@ -82052,8 +71131,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -82289,8 +71367,7 @@ "salesChannelId", "languageId", "currencyId", - "snippetSetId", - "createdAt" + "snippetSetId" ], "properties": { "id": { @@ -82449,7 +71526,6 @@ { "required": [ "id", - "createdAt", "name" ], "properties": { @@ -82542,7 +71618,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "name" ], "properties": { @@ -82609,7 +71684,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -82880,7 +71954,6 @@ "required": [ "id", "salutationKey", - "createdAt", "displayName", "letterName" ], @@ -83027,9 +72100,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -83084,9 +72155,7 @@ "scheduledTaskClass", "runInterval", "defaultRunInterval", - "status", - "nextExecutionTime", - "createdAt" + "status" ], "properties": { "id": { @@ -83143,8 +72212,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -83223,8 +72291,7 @@ "script", "hook", "name", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -83276,8 +72343,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -83411,8 +72477,7 @@ "foreignKey", "routeName", "pathInfo", - "seoPathInfo", - "createdAt" + "seoPathInfo" ], "properties": { "id": { @@ -83489,8 +72554,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -83570,8 +72634,7 @@ "required": [ "id", "entityName", - "routeName", - "createdAt" + "routeName" ], "properties": { "id": { @@ -83623,8 +72686,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -84068,8 +73129,6 @@ "required": [ "id", "deliveryTimeId", - "taxType", - "createdAt", "name" ], "properties": { @@ -84255,8 +73314,7 @@ { "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -84288,7 +73346,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -84404,8 +73465,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "shippingMethodId", - "createdAt" + "shippingMethodId" ], "properties": { "id": { @@ -84437,7 +73497,10 @@ "format": "float" }, "currencyPrice": { - "type": "object" + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "customFields": { "type": "object" @@ -84504,8 +73567,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -84584,8 +73646,7 @@ "setId", "translationKey", "value", - "author", - "createdAt" + "author" ], "properties": { "id": { @@ -84635,8 +73696,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -84743,8 +73803,7 @@ "id", "name", "baseFile", - "iso", - "createdAt" + "iso" ], "properties": { "id": { @@ -84798,8 +73857,7 @@ "id", "name", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -84837,8 +73895,7 @@ "id", "name", "width", - "height", - "createdAt" + "height" ], "properties": { "id": { @@ -84877,8 +73934,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -85019,8 +74075,7 @@ "SpatialScene": { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -85086,8 +74141,7 @@ "id", "sceneId", "type", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -85164,8 +74218,7 @@ "id", "sceneId", "type", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -85214,8 +74267,7 @@ "id", "sceneId", "type", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -85302,8 +74354,7 @@ "id", "sceneId", "type", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -85362,9 +74413,7 @@ "id", "sceneId", "mediaId", - "name", - "visible", - "createdAt" + "name" ], "properties": { "id": { @@ -85477,9 +74526,7 @@ "id", "sceneId", "mediaId", - "name", - "visible", - "createdAt" + "name" ], "properties": { "id": { @@ -85539,8 +74586,7 @@ "name", "type", "active", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -85649,8 +74695,7 @@ "name", "type", "active", - "config", - "createdAt" + "config" ], "properties": { "id": { @@ -85705,8 +74750,7 @@ "id", "ssoProviderId", "customerId", - "subject", - "createdAt" + "subject" ], "properties": { "id": { @@ -85807,8 +74851,7 @@ "id", "ssoProviderId", "customerId", - "subject", - "createdAt" + "subject" ], "properties": { "id": { @@ -85855,7 +74898,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -85997,7 +75039,6 @@ "required": [ "id", "technicalName", - "createdAt", "name" ], "properties": { @@ -86066,8 +75107,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -86249,8 +75289,7 @@ "stateMachineId", "entityName", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -86323,7 +75362,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -86872,7 +75910,6 @@ "id", "technicalName", "stateMachineId", - "createdAt", "name" ], "properties": { @@ -87169,8 +76206,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -87309,8 +76345,7 @@ "actionName", "stateMachineId", "fromStateId", - "toStateId", - "createdAt" + "toStateId" ], "properties": { "id": { @@ -87373,8 +76408,6 @@ "subscriptionIntervalName", "dateInterval", "cronInterval", - "initialExecutionCount", - "remainingExecutionCount", "billingAddressId", "shippingAddressId", "shippingMethodId", @@ -87383,8 +76416,7 @@ "languageId", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -87954,8 +76986,6 @@ "subscriptionIntervalName", "dateInterval", "cronInterval", - "initialExecutionCount", - "remainingExecutionCount", "billingAddressId", "shippingAddressId", "shippingMethodId", @@ -87964,8 +76994,7 @@ "languageId", "stateId", "itemRounding", - "totalRounding", - "createdAt" + "totalRounding" ], "properties": { "id": { @@ -88169,8 +77198,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -88434,8 +77462,7 @@ "firstName", "lastName", "street", - "city", - "createdAt" + "city" ], "properties": { "id": { @@ -88540,8 +77567,7 @@ "salutationId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -88704,8 +77730,7 @@ "salutationId", "email", "firstName", - "lastName", - "createdAt" + "lastName" ], "properties": { "id": { @@ -88784,11 +77809,7 @@ { "required": [ "id", - "name", - "active", - "dateInterval", - "cronInterval", - "createdAt" + "name" ], "properties": { "id": { @@ -88928,11 +77949,7 @@ "SubscriptionInterval": { "required": [ "id", - "name", - "active", - "dateInterval", - "cronInterval", - "createdAt" + "name" ], "properties": { "id": { @@ -88994,10 +78011,7 @@ { "required": [ "id", - "name", - "active", - "activeStorefrontLabel", - "createdAt" + "name" ], "properties": { "id": { @@ -89179,10 +78193,7 @@ "SubscriptionPlan": { "required": [ "id", - "name", - "active", - "activeStorefrontLabel", - "createdAt" + "name" ], "properties": { "id": { @@ -89348,8 +78359,7 @@ "id", "flowId", "executionTime", - "stored", - "createdAt" + "stored" ], "properties": { "id": { @@ -89530,8 +78540,7 @@ "id", "flowId", "executionTime", - "stored", - "createdAt" + "stored" ], "properties": { "id": { @@ -89633,8 +78642,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -89710,8 +78718,7 @@ "required": [ "id", "configurationKey", - "configurationValue", - "createdAt" + "configurationValue" ], "properties": { "id": { @@ -89758,8 +78765,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -90108,8 +79114,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -90232,9 +79237,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -90374,9 +79377,7 @@ "required": [ "id", "taxRate", - "name", - "position", - "createdAt" + "name" ], "properties": { "id": { @@ -90440,7 +79441,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -90562,7 +79562,6 @@ "id", "identifier", "priority", - "createdAt", "name" ], "properties": { @@ -90631,8 +79630,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -90794,8 +79792,7 @@ "taxRuleTypeId", "countryId", "taxRate", - "taxId", - "createdAt" + "taxId" ], "properties": { "id": { @@ -90876,7 +79873,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -90955,7 +79951,6 @@ "id", "technicalName", "position", - "createdAt", "typeName" ], "properties": { @@ -91007,8 +80002,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -91207,8 +80201,7 @@ "id", "name", "author", - "active", - "createdAt" + "active" ], "properties": { "id": { @@ -91386,7 +80379,6 @@ { "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -91462,7 +80454,6 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", - "createdAt", "shortCode", "name" ], @@ -91515,9 +80506,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -92210,9 +81199,7 @@ "username", "firstName", "lastName", - "email", - "timeZone", - "createdAt" + "email" ], "properties": { "id": { @@ -92573,8 +81560,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -92653,8 +81639,7 @@ "id", "userId", "accessKey", - "secretAccessKey", - "createdAt" + "secretAccessKey" ], "properties": { "id": { @@ -92704,8 +81689,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -92776,8 +81760,7 @@ "required": [ "id", "userId", - "key", - "createdAt" + "key" ], "properties": { "id": { @@ -92820,8 +81803,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -92889,8 +81871,7 @@ "required": [ "id", "hash", - "userId", - "createdAt" + "userId" ], "properties": { "id": { @@ -92928,8 +81909,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -93058,8 +82038,7 @@ "Warehouse": { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -93111,8 +82090,7 @@ { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -93247,8 +82225,7 @@ "WarehouseGroup": { "required": [ "id", - "name", - "createdAt" + "name" ], "properties": { "id": { @@ -93339,9 +82316,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -93427,9 +82402,7 @@ "id", "name", "eventName", - "url", - "errorCount", - "createdAt" + "url" ], "properties": { "id": { @@ -93488,8 +82461,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -93599,8 +82571,7 @@ "webhookName", "eventName", "deliveryStatus", - "url", - "createdAt" + "url" ], "properties": { "id": { @@ -93763,6 +82734,145 @@ } } }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "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" + } + } + } + }, + "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" + } + } + } + } + }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", @@ -93887,40 +82997,6 @@ } ] }, - "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)", @@ -94058,28 +83134,83 @@ } } }, - "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" + "CustomPricingPrice": { + "type": "object", + "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", + "required": [ + "quantityStart", + "price" + ], + "properties": { + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "price": { + "type": "array", + "items": { + "type": "object", + "description": "This field should house all the normal facets of the `product_price`.`price` column", + "required": [ + "currencyId", + "gross", + "net", + "linked" + ], + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + }, + "listPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + }, + "regulationPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + } } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" } } } @@ -94193,87 +83324,6 @@ } } }, - "CustomPricingPrice": { - "type": "object", - "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", - "required": [ - "quantityStart", - "price" - ], - "properties": { - "quantityStart": { - "type": "integer", - "format": "int64" - }, - "quantityEnd": { - "type": "integer", - "format": "int64", - "minimum": 1 - }, - "price": { - "type": "array", - "items": { - "type": "object", - "description": "This field should house all the normal facets of the `product_price`.`price` column", - "required": [ - "currencyId", - "gross", - "net", - "linked" - ], - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - }, - "listPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - }, - "regulationPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - } - } - } - } - } - }, "CustomPricingResponse": { "type": "object", "required": [ From a6a64715d8d57f7e62093b261c408f0b20cbdd78 Mon Sep 17 00:00:00 2001 From: Micha Date: Mon, 14 Oct 2024 17:27:00 +0200 Subject: [PATCH 30/63] Try DSR fix --- .github/workflows/plugin_digitalsalesroom_schema.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/plugin_digitalsalesroom_schema.yml b/.github/workflows/plugin_digitalsalesroom_schema.yml index 2d9c682..c2c1c67 100644 --- a/.github/workflows/plugin_digitalsalesroom_schema.yml +++ b/.github/workflows/plugin_digitalsalesroom_schema.yml @@ -14,7 +14,7 @@ on: env: PLUGIN_NAME: SwagDigitalSalesRooms - PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagdigitalsalesrooms.git -b v3.3.1 + PLUGIN_URL: gitlab.shopware.com/shopware/6/services/swagdigitalsalesrooms.git COMPOSER_PACKAGES: shopware-pwa/shopware-pwa ^0.5 symfony/mercure ^0.6.4 spatie/icalendar-generator ^2.6 firebase/php-jwt ^6.0 # A workflow run is made up of one or more jobs that can run sequentially or in parallel From 2120fe8f5f1dfbe1dede53b144d5c596d92fa763 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 16 Oct 2024 11:51:39 +0200 Subject: [PATCH 31/63] [create-pull-request] automated change (#322) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 100 +++++++------------- SwagDigitalSalesRooms-adminapi.summary.json | 1 - 2 files changed, 36 insertions(+), 65 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 18c1962..b9badff 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -15817,9 +15817,6 @@ "url": { "type": "string" }, - "startAsBroadcast": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -15898,9 +15895,6 @@ "url": { "type": "string" }, - "startAsBroadcast": { - "type": "boolean" - }, "customFields": { "type": "object" }, @@ -46790,9 +46784,6 @@ }, "stateForClients": { "$ref": "#/components/schemas/StateForGuides" - }, - "stateForMe": { - "$ref": "#/components/schemas/StateForMe" } }, "example": { @@ -46881,13 +46872,6 @@ "videoGuideToken": null, "quickViewState": [], "extensions": [] - }, - "stateForMe": { - "attendeeId": "018e789e117c701b8d12a64eae0faac8", - "attendeeName": " admin", - "videoUserId": "e57c6922-903e-4b08-a612-20ad921d9b6f", - "guideCartPermissionsGranted": false, - "extensions": [] } } }, @@ -47597,6 +47581,32 @@ "isPreview": { "type": "boolean", "description": "To see if it's a preview appointment" + }, + "attendeeName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the attendee" + }, + "videoUserId": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The video user id that attendee could use" + }, + "b2bFeatures": { + "type": "object", + "description": "The b2b features that available for the appointment" } }, "example": { @@ -47609,6 +47619,12 @@ "JWTMercureSubscriberToken": "jwt token for subscribing to updates", "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", "JWTMercurePublisherToken": "jwt token for publishing updates", + "attendeeName": "attendee name", + "videoUserId": null, + "b2bFeatures": { + "feature1": false, + "feature2": true + }, "id": "2d2c358f1ca04098aacf12873c2eed82", "newContextToken": "new context token to call the other routes", "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", @@ -47648,49 +47664,6 @@ } } }, - "StateForMe": { - "type": "object", - "properties": { - "attendeeId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "attendeeName": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "videoUserId": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - }, - "guideCartPermissionGranted": { - "type": "boolean", - "default": false - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, "PresentationCmsPage": { "type": "object", "properties": { @@ -47964,10 +47937,6 @@ "ownerToken": { "type": "string", "description": "Token for the room owner (guide) to connect to the daily room" - }, - "startAsBroadcast": { - "type": "boolean", - "default": false } }, "example": { @@ -47975,7 +47944,6 @@ "userToken": "dummy user token", "ownerToken": "dummy owner token", "roomName": "rSq20mrgwsj4eIXo1u95", - "startAsBroadcast": false, "extensions": [] } }, @@ -48440,6 +48408,10 @@ ], "default": "presentation" }, + "allowScreenSharing": { + "type": "boolean", + "default": false + }, "extensions": { "type": "array", "default": [] diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index 923f014..d469189 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -352,7 +352,6 @@ "SnippetSetJsonApi", "StateForAll", "StateForGuides", - "StateForMe", "StateMachine", "StateMachineHistory", "StateMachineHistoryJsonApi", From 4eb45d2fc65adade93615f130282ae4cd27dcd57 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 25 Oct 2024 09:22:40 +0200 Subject: [PATCH 32/63] [create-pull-request] automated change (#328) Co-authored-by: shopwareBot --- adminapi.json | 2496 ++++++++++++++++++++++++------------------------- 1 file changed, 1248 insertions(+), 1248 deletions(-) diff --git a/adminapi.json b/adminapi.json index 34b507b..d351935 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.7.0" + "version": "6.6.7.1" }, "servers": [ { @@ -65490,146 +65490,263 @@ } } }, - "/_action/mail-template/send": { + "/_action/indexing": { "post": { "tags": [ - "Mail Operations" + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", + "parameters": [ + { + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" - }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns information about the iteration.", + "content": { + "application/json": { + "schema": { + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" } }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", + "type": "object" + } + } + } + } + } + } + }, + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", "type": "string" } }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, + "/_action/container_cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." + } + } + } + }, + "/_action/document/{documentId}/{deepLinkCode}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false + } + } + ], + "responses": { + "200": { + "description": "The document.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/document/{documentId}/upload": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" } }, "type": "object" @@ -65639,14 +65756,19 @@ }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "Document uploaded successful", "content": { "application/json": { "schema": { "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", + "type": "string" } }, "type": "object" @@ -65657,31 +65779,25 @@ } } }, - "/_action/mail-template/validate": { + "/_action/index": { "post": { "tags": [ - "Mail Operations" + "System Operations" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } } }, "type": "object" @@ -65691,57 +65807,36 @@ }, "responses": { "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "description": "Returns a no content response indicating that the indexing progress startet." } } } }, - "/_action/mail-template/build": { + "/_proxy/generate-imitate-customer-token": { "post": { "tags": [ - "Mail Operations" + "Customer impersonation" ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "mailTemplateType", - "mailTemplate" + "customerId", + "salesChannelId" ], "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" + "customerId": { + "description": "ID of the customer", + "type": "string" }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" } }, "type": "object" @@ -65751,11 +65846,17 @@ }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { - "type": "string" + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" } } } @@ -65763,76 +65864,215 @@ } } }, - "/_info/openapi3.json": { - "get": { + "/_action/order/document/download": { + "post": { "tags": [ - "System Info & Health Check" + "Document Management" ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", + "requestBody": { + "description": "documentIds", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "responses": { + "200": { + "description": "The documents.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/order/document/{documentTypeName}/create": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", "parameters": [ { - "name": "type", - "in": "query", - "description": "Type of the api", + "name": "documentTypeName", + "in": "path", + "description": "The type of document to create", + "required": true, "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] + "type": "string" } } ], + "requestBody": { + "description": "test", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "required": [ + "orderId", + "type" + ], + "properties": { + "orderId": { + "description": "Identifier of the order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Type of the document to be generated.", + "type": "string" + }, + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" + }, + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", + "type": "string", + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" + } + } + } + } + } + } + }, "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ - "Customer impersonation" + "Order Management" + ], + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { - "required": [ - "customerId", - "salesChannelId" - ], "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" + "sendMail": { + "description": "Controls if a mail should be sent to the customer." }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" } }, "type": "object" } } } - }, + }, + "responses": { + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "The generated customer impersonation token.", + "description": "Information about the cache state.", "content": { "application/json": { "schema": { "properties": { - "token": { - "description": "The generated customer impersonation token", + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", "type": "string" } }, @@ -65844,95 +66084,103 @@ } } }, - "/_action/indexing": { - "post": { + "/_info/health-check": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", + "summary": "Check that the Application is running", + "operationId": "healthCheck", "responses": { "200": { - "description": "Returns an empty response indicating that the indexing process started." + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/indexing/{indexer}": { - "post": { + "/_info/system-health-check": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", "parameters": [ { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, + "name": "verbose", + "in": "query", + "required": false, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "Returns information about the iteration.", + "description": "Returns the system health check results", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } } - }, - "type": "object" + } } } } + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_info/flow-actions.json": { + "/_info/events.json": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { "200": { - "description": "Returns a list of action for flow builder.", + "description": "Returns a list of about the business events.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" + "$ref": "#/components/schemas/businessEventsResponse" } } } @@ -65940,112 +66188,89 @@ } } }, - "/_action/index": { - "post": { + "/_info/config": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "type": "object" - } - } - } - }, + "summary": "Get API information", + "description": "Get information about the API", + "operationId": "config", "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." - } - } - } - }, - "/_action/order_transaction_capture_refund/{refundId}": { - "post": { - "tags": [ - "Order Management" - ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", - "parameters": [ - { - "name": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "200": { + "description": "Returns information about the API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/infoConfigResponse" + } + } } } - ], - "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" - } } } }, - "/_action/cleanup": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } + } + } + } } } } }, - "/_action/cache_info": { - "get": { + "/_action/scheduled-task/run": { + "post": { "tags": [ "System Operations" ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", "responses": { "200": { - "description": "Information about the cache state.", + "description": "Returns a success message indicating a successful run.", "content": { "application/json": { "schema": { "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" - }, - "cacheAdapter": { - "description": "The active cache adapter.", + "message": { + "description": "Success message", "type": "string" } }, @@ -66057,21 +66282,27 @@ } } }, - "/_info/config": { + "/_action/scheduled-task/min-run-interval": { "get": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get API information", - "description": "Get information about the API", - "operationId": "config", + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", "responses": { "200": { - "description": "Returns information about the API.", + "description": "Returns the minimum interval.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/infoConfigResponse" + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" } } } @@ -66079,138 +66310,86 @@ } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "/_action/order/{orderId}/order-address": { "post": { "tags": [ - "Order Management" + "Order address" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", "parameters": [ { - "name": "orderDeliveryId", + "name": "orderId", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Identifier of the order.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { - "required": false, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be send to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", + "mapping": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "type": "string", + "description": "The ID of the delivery (optional)", + "nullable": true + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" } - }, - "type": "object" + } } } - } + }, + "required": true }, - "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", "responses": { "204": { - "description": "Returns an empty response indicating that the message dispatched." + "description": "Returns a no content response indicating that the update has been made." } } } }, - "/_action/order/document/download": { - "post": { + "/_info/flow-actions.json": { + "get": { "tags": [ - "Document Management" + "System Info & Health Check" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", - "requestBody": { - "description": "documentIds", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - } - } - }, + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", "responses": { "200": { - "description": "The documents.", + "description": "Returns a list of action for flow builder.", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } @@ -66218,94 +66397,95 @@ } } }, - "/_action/order/document/{documentTypeName}/create": { + "/_action/media/{mediaId}/upload": { "post": { "tags": [ - "Document Management" + "Asset Management" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", "parameters": [ { - "name": "documentTypeName", + "name": "mediaId", "in": "path", - "description": "The type of document to create", + "description": "Identifier of the media entity.", "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - } - ], - "requestBody": { - "description": "test", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "required": [ - "orderId", - "type" - ], - "properties": { - "orderId": { - "description": "Identifier of the order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "description": "Type of the document to be generated.", - "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", - "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", - "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" - } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `png`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the media file that will be downloaded.", + "type": "string" } - } + }, + "type": "object" } } } }, "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + "204": { + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", + "schema": { + "type": "string" + } + } + } } } } }, - "/_action/order/{orderId}/state/{transition}": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", "parameters": [ { - "name": "orderId", + "name": "orderDeliveryId", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier of the order delivery.", "required": true, "schema": { "type": "string", @@ -66315,7 +66495,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", "required": true, "schema": { "type": "string" @@ -66329,7 +66509,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be sent to the customer." + "description": "Controls if a mail should be send to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -66348,7 +66528,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" } @@ -66365,145 +66545,6 @@ } } }, - "/_action/container_cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." - } - } - } - }, - "/_action/scheduled-task/run": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", - "responses": { - "200": { - "description": "Returns a success message indicating a successful run.", - "content": { - "application/json": { - "schema": { - "properties": { - "message": { - "description": "Success message", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/scheduled-task/min-run-interval": { - "get": { - "tags": [ - "System Operations" - ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", - "responses": { - "200": { - "description": "Returns the minimum interval.", - "content": { - "application/json": { - "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/oauth/token": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "Authorized successfully.", - "content": { - "application/json": { - "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], - "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - } - } - } - }, "/_action/sync": { "post": { "tags": [ @@ -66603,71 +66644,166 @@ } } }, - "/_info/version": { - "get": { + "/_action/mail-template/send": { + "post": { "tags": [ - "System Info & Health Check" + "Mail Operations" ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], + "properties": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", "type": "string" } }, - "type": "object" - } + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + } + }, + "type": "object" } } } - } - } - }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", + }, "responses": { "200": { - "description": "Successful operation", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "endpoints" - ], "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } + "size": { + "description": "Length of the email message", + "type": "integer" } - } + }, + "type": "object" } } } @@ -66675,59 +66811,30 @@ } } }, - "/_action/media/{mediaId}/upload": { + "/_action/mail-template/validate": { "post": { "tags": [ - "Asset Management" - ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "description": "Identifier of the media entity.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `png`", - "required": true, - "schema": { - "type": "string" - } - } + "Mail Operations" ], + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", "requestBody": { + "required": true, "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { "required": [ - "url" + "contentHtml", + "contentPlain" ], "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", "type": "string" } }, @@ -66738,87 +66845,71 @@ }, "responses": { "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", - "schema": { - "type": "string" - } + "description": "Returns a no content response indicating the mail content was rendered successfully." + } + } + } + }, + "/_action/mail-template/build": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" } } } - } - } - }, - "/_info/events.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + }, "responses": { "200": { - "description": "Returns a list of about the business events.", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/businessEventsResponse" - } - } - } - } - } - } - }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { - "tags": [ - "Document Management" - ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document to be downloaded.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "200": { - "description": "The document.", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" + "type": "string" } } } @@ -66826,19 +66917,19 @@ } } }, - "/_action/document/{documentId}/upload": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ - "Document Management" + "Order Management" ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "documentId", + "name": "orderTransactionId", "in": "path", - "description": "Identifier of the document the new file should be added to.", + "description": "Identifier of the order transaction.", "required": true, "schema": { "type": "string", @@ -66846,18 +66937,9 @@ } }, { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -66865,22 +66947,34 @@ } ], "requestBody": { + "required": false, "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "required": [ - "url" - ], "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" } }, "type": "object" @@ -66890,85 +66984,55 @@ }, "responses": { "200": { - "description": "Document uploaded successful", - "content": { - "application/json": { - "schema": { - "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" - } - }, - "type": "object" - } - } - } + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { "tags": [ - "Document Management" + "Order Management" ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", "parameters": [ { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", + "name": "refundId", "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "description": "Identifier of the order transaction capture refund.", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Refund was successful" }, "400": { - "description": "Number range not found" + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_action/index-products": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." } } } @@ -67020,221 +67084,157 @@ } } }, - "/_info/health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", - "responses": { - "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" - } - } - } - }, - "/_info/system-health-check": { + "/_info/openapi3.json": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", "parameters": [ { - "name": "verbose", + "name": "type", "in": "query", - "required": false, + "description": "Type of the api", "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } } ], "responses": { "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Application is not working properly" + "$ref": "#/components/responses/OpenApi3" } } } }, - "/_action/order/{orderId}/order-address": { - "post": { + "/_action/cache": { + "delete": { "tags": [ - "Order address" + "System Operations" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } + } + } + }, + "/_action/cleanup": { + "delete": { + "tags": [ + "System Operations" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "type": "string", - "description": "The ID of the delivery (optional)", - "nullable": true - } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" - } - } - } - } - }, - "required": true - }, + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", "responses": { "204": { - "description": "Returns a no content response indicating that the update has been made." + "description": "Returns a no content response indicating that the cleanup finished." } } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/oauth/token": { "post": { "tags": [ - "Order Management" - ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", - "parameters": [ - { - "name": "orderTransactionId", - "in": "path", - "description": "Identifier of the order transaction.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", - "required": true, - "schema": { - "type": "string" - } - } + "Authorization & Authentication" ], + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" }, - "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" } - }, - "type": "object" + ] } } } }, "responses": { "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" + "description": "Authorized successfully.", + "content": { + "application/json": { + "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], + "properties": { + "token_type": { + "description": "Type of the token.", + "type": "string" + }, + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + } + } + } + }, + "/_info/version": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", + "responses": { + "200": { + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } @@ -107693,67 +107693,129 @@ }, "type": "object" }, - "infoConfigResponse": { + "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": { - "version": { - "type": "string", - "description": "The Shopware version." - }, - "versionRevision": { - "type": "string", - "description": "The Shopware version revision." + "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" }, - "adminWorker": { + { "type": "object", - "description": "Information about the admin worker.", "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "State of the admin worker." + "client_id": { + "description": "OAuth client id.", + "type": "string" }, - "transports": { - "type": "array", - "description": "Configured transports.", - "items": { - "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" }, - "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." - } - } + "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" }, - "settings": { + { "type": "object", "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." + "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" + ] } - } + ] }, "Price": { "type": "object", @@ -107911,129 +107973,67 @@ } } }, - "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": { + "infoConfigResponse": { "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" + "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": { - "client_id": { - "description": "OAuth client id.", - "type": "string" + "enableAdminWorker": { + "type": "boolean", + "description": "State of the admin worker." }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" + "transports": { + "type": "array", + "description": "Configured transports.", + "items": { + "type": "string" + } } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + } }, - { + "bundles": { "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" + "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." + } + } } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + } }, - { + "settings": { "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" + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] + } } - ] + } }, "Criteria": { "type": "object", From 18e4d8e2d7189d9526d96ba79bfb5da90082c842 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 25 Oct 2024 14:04:37 +0200 Subject: [PATCH 33/63] [create-pull-request] automated change (#326) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 310 +++++++++++++-------------- 1 file changed, 155 insertions(+), 155 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 9256faa..62b0294 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.6.7.0" + "version": "6.6.7.1" }, "servers": [ { @@ -46254,67 +46254,129 @@ }, "type": "object" }, - "infoConfigResponse": { + "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": { - "version": { - "type": "string", - "description": "The Shopware version." - }, - "versionRevision": { - "type": "string", - "description": "The Shopware version revision." + "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" }, - "adminWorker": { + { "type": "object", - "description": "Information about the admin worker.", "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "State of the admin worker." + "client_id": { + "description": "OAuth client id.", + "type": "string" }, - "transports": { - "type": "array", - "description": "Configured transports.", - "items": { - "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" }, - "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." - } - } + "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" }, - "settings": { + { "type": "object", "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." + "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" + ] } - } + ] }, "Price": { "type": "object", @@ -46455,129 +46517,67 @@ } } }, - "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": { + "infoConfigResponse": { "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" + "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": { - "client_id": { - "description": "OAuth client id.", - "type": "string" + "enableAdminWorker": { + "type": "boolean", + "description": "State of the admin worker." }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" + "transports": { + "type": "array", + "description": "Configured transports.", + "items": { + "type": "string" + } } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + } }, - { + "bundles": { "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" + "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." + } + } } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" + } }, - { + "settings": { "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" + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] + } } - ] + } }, "Criteria": { "type": "object", From 3972fae328317270a6ab6fee6c729fd77ce107d0 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 14 Nov 2024 08:22:21 +0100 Subject: [PATCH 34/63] [create-pull-request] automated change (#333) Co-authored-by: shopwareBot --- adminapi.json | 7782 ++++++++--------------------------------- adminapi.summary.json | 17 + 2 files changed, 1570 insertions(+), 6229 deletions(-) diff --git a/adminapi.json b/adminapi.json index d351935..db8b7c7 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.7.1" + "version": "6.6.8.2" }, "servers": [ { @@ -150,23 +150,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AclRole" @@ -230,11 +213,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -428,23 +406,6 @@ "requestBody": { "description": "Partially update information about a Acl Role resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AclRole" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AclRole" @@ -635,23 +596,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/App" @@ -715,11 +659,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -913,23 +852,6 @@ "requestBody": { "description": "Partially update information about a App resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/App" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/App" @@ -1120,23 +1042,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppActionButton" @@ -1200,11 +1105,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1398,23 +1298,6 @@ "requestBody": { "description": "Partially update information about a App Action Button resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppActionButton" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppActionButton" @@ -1605,23 +1488,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppAdministrationSnippet" @@ -1685,11 +1551,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1883,23 +1744,6 @@ "requestBody": { "description": "Partially update information about a App Administration Snippet resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppAdministrationSnippet" @@ -2090,23 +1934,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppCmsBlock" @@ -2170,11 +1997,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2368,23 +2190,6 @@ "requestBody": { "description": "Partially update information about a App Cms Block resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppCmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppCmsBlock" @@ -2575,23 +2380,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowAction" @@ -2655,11 +2443,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2853,23 +2636,6 @@ "requestBody": { "description": "Partially update information about a App Flow Action resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowAction" @@ -3060,23 +2826,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowEvent" @@ -3140,11 +2889,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3338,23 +3082,6 @@ "requestBody": { "description": "Partially update information about a App Flow Event resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppFlowEvent" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppFlowEvent" @@ -3545,23 +3272,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppPaymentMethod" @@ -3625,11 +3335,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3823,23 +3528,6 @@ "requestBody": { "description": "Partially update information about a App Payment Method resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppPaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppPaymentMethod" @@ -4030,23 +3718,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppScriptCondition" @@ -4110,11 +3781,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4308,23 +3974,6 @@ "requestBody": { "description": "Partially update information about a App Script Condition resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppScriptCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppScriptCondition" @@ -4515,23 +4164,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppShippingMethod" @@ -4595,11 +4227,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4793,23 +4420,6 @@ "requestBody": { "description": "Partially update information about a App Shipping Method resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppShippingMethod" @@ -5000,23 +4610,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplate" @@ -5080,11 +4673,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -5278,23 +4866,6 @@ "requestBody": { "description": "Partially update information about a App Template resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AppTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AppTemplate" @@ -5485,23 +5056,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Category" @@ -5565,11 +5119,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -5763,23 +5312,6 @@ "requestBody": { "description": "Partially update information about a Category resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Category" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Category" @@ -5970,23 +5502,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsBlock" @@ -6050,11 +5565,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -6248,23 +5758,6 @@ "requestBody": { "description": "Partially update information about a Cms Block resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsBlock" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsBlock" @@ -6455,23 +5948,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage" @@ -6535,11 +6011,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -6733,23 +6204,6 @@ "requestBody": { "description": "Partially update information about a Cms Page resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsPage" @@ -6940,169 +6394,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/CmsSection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/CmsSection" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/cms-section": { + "post": { + "tags": [ + "Cms Section" + ], + "summary": "Search for the Cms Section resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchCmsSection", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of CmsSection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/cms-section": { - "post": { - "tags": [ - "Cms Section" - ], - "summary": "Search for the Cms Section resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchCmsSection", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of CmsSection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/cms-section/{id}": { - "get": { - "tags": [ - "Cms Section" - ], - "summary": "Detailed information about a Cms Section resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getCmsSection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the cms_section", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/cms-section/{id}": { + "get": { + "tags": [ + "Cms Section" + ], + "summary": "Detailed information about a Cms Section resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getCmsSection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the cms_section", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of CmsSection", @@ -7218,23 +6650,6 @@ "requestBody": { "description": "Partially update information about a Cms Section resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSection" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsSection" @@ -7425,23 +6840,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsSlot" @@ -7505,11 +6903,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -7703,23 +7096,6 @@ "requestBody": { "description": "Partially update information about a Cms Slot resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CmsSlot" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CmsSlot" @@ -7910,23 +7286,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Country" @@ -7990,11 +7349,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -8188,23 +7542,6 @@ "requestBody": { "description": "Partially update information about a Country resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Country" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Country" @@ -8395,23 +7732,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CountryState" @@ -8475,11 +7795,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -8673,23 +7988,6 @@ "requestBody": { "description": "Partially update information about a Country State resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CountryState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CountryState" @@ -8880,23 +8178,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Currency" @@ -8960,11 +8241,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -9158,23 +8434,6 @@ "requestBody": { "description": "Partially update information about a Currency resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Currency" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Currency" @@ -9365,23 +8624,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyCountryRounding" @@ -9445,11 +8687,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -9643,23 +8880,6 @@ "requestBody": { "description": "Partially update information about a Currency Country Rounding resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyCountryRounding" @@ -9850,23 +9070,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomEntity" @@ -9930,11 +9133,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -10128,23 +9326,6 @@ "requestBody": { "description": "Partially update information about a Custom Entity resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomEntity" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomEntity" @@ -10335,23 +9516,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" @@ -10415,11 +9579,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -10613,23 +9772,6 @@ "requestBody": { "description": "Partially update information about a Custom Field resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomField" @@ -10820,23 +9962,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSet" @@ -10900,11 +10025,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -11098,23 +10218,6 @@ "requestBody": { "description": "Partially update information about a Custom Field Set resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSet" @@ -11305,23 +10408,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSetRelation" @@ -11385,11 +10471,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -11583,23 +10664,6 @@ "requestBody": { "description": "Partially update information about a Custom Field Set Relation resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldSetRelation" @@ -11790,23 +10854,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Customer" @@ -11870,11 +10917,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -12068,23 +11110,6 @@ "requestBody": { "description": "Partially update information about a Customer resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Customer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Customer" @@ -12275,23 +11300,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddress" @@ -12355,11 +11363,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -12553,23 +11556,6 @@ "requestBody": { "description": "Partially update information about a Customer Address resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddress" @@ -12760,23 +11746,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroup" @@ -12840,11 +11809,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -13038,23 +12002,6 @@ "requestBody": { "description": "Partially update information about a Customer Group resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroup" @@ -13245,23 +12192,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRecovery" @@ -13325,11 +12255,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -13523,23 +12448,6 @@ "requestBody": { "description": "Partially update information about a Customer Recovery resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerRecovery" @@ -13730,23 +12638,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlist" @@ -13810,11 +12701,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -14008,23 +12894,6 @@ "requestBody": { "description": "Partially update information about a Customer Wishlist resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlist" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlist" @@ -14215,23 +13084,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlistProduct" @@ -14295,11 +13147,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -14493,23 +13340,6 @@ "requestBody": { "description": "Partially update information about a Customer Wishlist Product resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomerWishlistProduct" @@ -14700,23 +13530,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryTime" @@ -14780,11 +13593,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -14978,23 +13786,6 @@ "requestBody": { "description": "Partially update information about a Delivery Time resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DeliveryTime" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryTime" @@ -15185,23 +13976,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Document" @@ -15265,11 +14039,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -15463,23 +14232,6 @@ "requestBody": { "description": "Partially update information about a Document resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Document" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Document" @@ -15670,23 +14422,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfig" @@ -15750,11 +14485,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -15948,23 +14678,6 @@ "requestBody": { "description": "Partially update information about a Document Base Config resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfig" @@ -16155,169 +14868,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/document-base-config-sales-channel": { + "post": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Search for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDocumentBaseConfigSalesChannel", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/document-base-config-sales-channel": { - "post": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Search for the Document Base Config Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDocumentBaseConfigSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/document-base-config-sales-channel/{id}": { - "get": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Detailed information about a Document Base Config Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDocumentBaseConfigSalesChannel", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the document_base_config_sales_channel", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/document-base-config-sales-channel/{id}": { + "get": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Detailed information about a Document Base Config Sales Channel resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDocumentBaseConfigSalesChannel", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the document_base_config_sales_channel", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of DocumentBaseConfigSalesChannel", @@ -16433,23 +15124,6 @@ "requestBody": { "description": "Partially update information about a Document Base Config Sales Channel resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" @@ -16640,23 +15314,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" @@ -16720,11 +15377,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -16918,23 +15570,6 @@ "requestBody": { "description": "Partially update information about a Document Type resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DocumentType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/DocumentType" @@ -17125,23 +15760,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Flow" @@ -17205,11 +15823,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -17403,23 +16016,6 @@ "requestBody": { "description": "Partially update information about a Flow resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Flow" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Flow" @@ -17610,23 +16206,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowSequence" @@ -17690,11 +16269,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -17888,23 +16462,6 @@ "requestBody": { "description": "Partially update information about a Flow Sequence resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowSequence" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowSequence" @@ -18095,23 +16652,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowTemplate" @@ -18175,11 +16715,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -18373,23 +16908,6 @@ "requestBody": { "description": "Partially update information about a Flow Template resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/FlowTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/FlowTemplate" @@ -18580,23 +17098,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportFile" @@ -18660,11 +17161,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -18858,23 +17354,6 @@ "requestBody": { "description": "Partially update information about a Import Export File resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportFile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportFile" @@ -19065,23 +17544,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportLog" @@ -19145,11 +17607,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -19343,23 +17800,6 @@ "requestBody": { "description": "Partially update information about a Import Export Log resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportLog" @@ -19550,23 +17990,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportProfile" @@ -19630,11 +18053,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -19828,23 +18246,6 @@ "requestBody": { "description": "Partially update information about a Import Export Profile resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ImportExportProfile" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ImportExportProfile" @@ -20035,23 +18436,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Integration" @@ -20115,11 +18499,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -20313,23 +18692,6 @@ "requestBody": { "description": "Partially update information about a Integration resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Integration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Integration" @@ -20520,23 +18882,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/LandingPage" @@ -20600,11 +18945,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -20798,23 +19138,6 @@ "requestBody": { "description": "Partially update information about a Landing Page resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LandingPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/LandingPage" @@ -21005,23 +19328,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Language" @@ -21085,11 +19391,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -21283,23 +19584,6 @@ "requestBody": { "description": "Partially update information about a Language resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Language" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Language" @@ -21490,23 +19774,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Locale" @@ -21570,11 +19837,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -21768,23 +20030,6 @@ "requestBody": { "description": "Partially update information about a Locale resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Locale" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Locale" @@ -21975,23 +20220,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/LogEntry" @@ -22055,11 +20283,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -22253,23 +20476,6 @@ "requestBody": { "description": "Partially update information about a Log Entry resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/LogEntry" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/LogEntry" @@ -22460,23 +20666,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MailHeaderFooter" @@ -22540,11 +20729,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -22738,23 +20922,6 @@ "requestBody": { "description": "Partially update information about a Mail Header Footer resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailHeaderFooter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MailHeaderFooter" @@ -22945,23 +21112,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplate" @@ -23025,11 +21175,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -23223,23 +21368,6 @@ "requestBody": { "description": "Partially update information about a Mail Template resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplate" @@ -23430,23 +21558,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplateType" @@ -23510,11 +21621,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -23708,23 +21814,6 @@ "requestBody": { "description": "Partially update information about a Mail Template Type resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MailTemplateType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MailTemplateType" @@ -23915,23 +22004,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MainCategory" @@ -23995,11 +22067,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -24193,23 +22260,6 @@ "requestBody": { "description": "Partially update information about a Main Category resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MainCategory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MainCategory" @@ -24400,23 +22450,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Media" @@ -24480,11 +22513,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -24678,23 +22706,6 @@ "requestBody": { "description": "Partially update information about a Media resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Media" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Media" @@ -24885,23 +22896,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaDefaultFolder" @@ -24965,11 +22959,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -25163,23 +23152,6 @@ "requestBody": { "description": "Partially update information about a Media Default Folder resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaDefaultFolder" @@ -25370,169 +23342,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/MediaFolder" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/MediaFolder" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/media-folder": { + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Search for the Media Folder resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaFolder", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/media-folder": { - "post": { - "tags": [ - "Media Folder" - ], - "summary": "Search for the Media Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaFolder", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/media-folder/{id}": { - "get": { - "tags": [ - "Media Folder" - ], - "summary": "Detailed information about a Media Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the media_folder", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-folder/{id}": { + "get": { + "tags": [ + "Media Folder" + ], + "summary": "Detailed information about a Media Folder resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the media_folder", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of MediaFolder", @@ -25648,23 +23598,6 @@ "requestBody": { "description": "Partially update information about a Media Folder resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolder" @@ -25855,23 +23788,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderConfiguration" @@ -25935,11 +23851,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -26133,23 +24044,6 @@ "requestBody": { "description": "Partially update information about a Media Folder Configuration resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderConfiguration" @@ -26340,23 +24234,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnail" @@ -26420,11 +24297,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -26618,23 +24490,6 @@ "requestBody": { "description": "Partially update information about a Media Thumbnail resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnail" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnail" @@ -26825,23 +24680,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnailSize" @@ -26905,11 +24743,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -27103,23 +24936,6 @@ "requestBody": { "description": "Partially update information about a Media Thumbnail Size resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/MediaThumbnailSize" @@ -27310,23 +25126,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NewsletterRecipient" @@ -27390,11 +25189,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -27588,23 +25382,6 @@ "requestBody": { "description": "Partially update information about a Newsletter Recipient resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NewsletterRecipient" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NewsletterRecipient" @@ -27795,23 +25572,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Notification" @@ -27875,11 +25635,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -28073,23 +25828,6 @@ "requestBody": { "description": "Partially update information about a Notification resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Notification" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Notification" @@ -28280,23 +26018,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRange" @@ -28360,11 +26081,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -28558,23 +26274,6 @@ "requestBody": { "description": "Partially update information about a Number Range resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRange" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRange" @@ -28765,23 +26464,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeSalesChannel" @@ -28845,11 +26527,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -29043,23 +26720,6 @@ "requestBody": { "description": "Partially update information about a Number Range Sales Channel resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeSalesChannel" @@ -29250,23 +26910,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeState" @@ -29330,11 +26973,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -29528,23 +27166,6 @@ "requestBody": { "description": "Partially update information about a Number Range State resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeState" @@ -29735,23 +27356,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeType" @@ -29815,11 +27419,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -30013,23 +27612,6 @@ "requestBody": { "description": "Partially update information about a Number Range Type resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/NumberRangeType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/NumberRangeType" @@ -30220,23 +27802,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Order" @@ -30300,11 +27865,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -30498,23 +28058,6 @@ "requestBody": { "description": "Partially update information about a Order resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Order" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Order" @@ -30705,23 +28248,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderAddress" @@ -30785,11 +28311,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -30983,23 +28504,6 @@ "requestBody": { "description": "Partially update information about a Order Address resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderAddress" @@ -31190,23 +28694,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderCustomer" @@ -31270,11 +28757,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -31468,23 +28950,6 @@ "requestBody": { "description": "Partially update information about a Order Customer resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderCustomer" @@ -31675,23 +29140,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDelivery" @@ -31755,11 +29203,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -31953,23 +29396,6 @@ "requestBody": { "description": "Partially update information about a Order Delivery resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDelivery" @@ -32160,23 +29586,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -32240,11 +29649,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -32438,23 +29842,6 @@ "requestBody": { "description": "Partially update information about a Order Delivery Position resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -32645,23 +30032,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItem" @@ -32725,11 +30095,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -32923,23 +30288,6 @@ "requestBody": { "description": "Partially update information about a Order Line Item resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItem" @@ -33130,23 +30478,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -33210,11 +30541,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -33408,23 +30734,6 @@ "requestBody": { "description": "Partially update information about a Order Line Item Download resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -33615,23 +30924,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransaction" @@ -33695,11 +30987,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -33893,23 +31180,6 @@ "requestBody": { "description": "Partially update information about a Order Transaction resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransaction" @@ -34100,23 +31370,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCapture" @@ -34180,11 +31433,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -34378,23 +31626,6 @@ "requestBody": { "description": "Partially update information about a Order Transaction Capture resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCapture" @@ -34585,169 +31816,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Search for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/order-transaction-capture-refund": { - "post": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Search for the Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCaptureRefund", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/order-transaction-capture-refund/{id}": { - "get": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Detailed information about a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefund", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the order_transaction_capture_refund", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-transaction-capture-refund/{id}": { + "get": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Detailed information about a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefund", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the order_transaction_capture_refund", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of OrderTransactionCaptureRefund", @@ -34863,23 +32072,6 @@ "requestBody": { "description": "Partially update information about a Order Transaction Capture Refund resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefund" @@ -35070,23 +32262,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" @@ -35150,11 +32325,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -35348,23 +32518,6 @@ "requestBody": { "description": "Partially update information about a Order Transaction Capture Refund Position resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" @@ -35555,23 +32708,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" @@ -35635,11 +32771,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -35833,23 +32964,6 @@ "requestBody": { "description": "Partially update information about a Payment Method resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethod" @@ -36040,23 +33154,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Plugin" @@ -36120,11 +33217,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -36318,23 +33410,6 @@ "requestBody": { "description": "Partially update information about a Plugin resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Plugin" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Plugin" @@ -36525,23 +33600,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Product" @@ -36605,11 +33663,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -36803,23 +33856,6 @@ "requestBody": { "description": "Partially update information about a Product resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Product" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Product" @@ -37010,23 +34046,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -37090,11 +34109,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -37288,23 +34302,6 @@ "requestBody": { "description": "Partially update information about a Product Configurator Setting resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -37495,23 +34492,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSelling" @@ -37575,11 +34555,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -37773,23 +34748,6 @@ "requestBody": { "description": "Partially update information about a Product Cross Selling resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSelling" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSelling" @@ -37980,23 +34938,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" @@ -38060,11 +35001,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -38258,23 +35194,6 @@ "requestBody": { "description": "Partially update information about a Product Cross Selling Assigned Products resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" @@ -38465,23 +35384,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDownload" @@ -38545,11 +35447,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -38743,23 +35640,6 @@ "requestBody": { "description": "Partially update information about a Product Download resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductDownload" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductDownload" @@ -38950,23 +35830,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductExport" @@ -39030,11 +35893,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -39228,23 +36086,6 @@ "requestBody": { "description": "Partially update information about a Product Export resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductExport" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductExport" @@ -39435,23 +36276,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeatureSet" @@ -39515,11 +36339,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -39713,23 +36532,6 @@ "requestBody": { "description": "Partially update information about a Product Feature Set resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductFeatureSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductFeatureSet" @@ -39920,23 +36722,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductKeywordDictionary" @@ -40000,11 +36785,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -40198,23 +36978,6 @@ "requestBody": { "description": "Partially update information about a Product Keyword Dictionary resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductKeywordDictionary" @@ -40405,23 +37168,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductManufacturer" @@ -40485,11 +37231,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -40683,23 +37424,6 @@ "requestBody": { "description": "Partially update information about a Product Manufacturer resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductManufacturer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductManufacturer" @@ -40890,23 +37614,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" @@ -40970,11 +37677,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -41168,23 +37870,6 @@ "requestBody": { "description": "Partially update information about a Product Media resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductMedia" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductMedia" @@ -41375,23 +38060,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice" @@ -41455,11 +38123,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -41653,23 +38316,6 @@ "requestBody": { "description": "Partially update information about a Product Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPrice" @@ -41860,23 +38506,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductReview" @@ -41940,11 +38569,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -42138,23 +38762,6 @@ "requestBody": { "description": "Partially update information about a Product Review resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReview" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductReview" @@ -42345,23 +38952,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfig" @@ -42425,11 +39015,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -42623,23 +39208,6 @@ "requestBody": { "description": "Partially update information about a Product Search Config resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfig" @@ -42830,23 +39398,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfigField" @@ -42910,11 +39461,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -43108,23 +39654,6 @@ "requestBody": { "description": "Partially update information about a Product Search Config Field resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchConfigField" @@ -43315,23 +39844,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchKeyword" @@ -43395,11 +39907,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -43593,23 +40100,6 @@ "requestBody": { "description": "Partially update information about a Product Search Keyword resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSearchKeyword" @@ -43800,169 +40290,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/ProductSorting" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ProductSorting" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Search for the Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "searchProductSorting", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/product-sorting": { - "post": { - "tags": [ - "Product Sorting" - ], - "summary": "Search for the Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "searchProductSorting", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/product-sorting/{id}": { - "get": { - "tags": [ - "Product Sorting" - ], - "summary": "Detailed information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSorting", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the product_sorting", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-sorting/{id}": { + "get": { + "tags": [ + "Product Sorting" + ], + "summary": "Detailed information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSorting", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the product_sorting", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of ProductSorting", @@ -44078,23 +40546,6 @@ "requestBody": { "description": "Partially update information about a Product Sorting resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductSorting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductSorting" @@ -44285,23 +40736,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductStream" @@ -44365,11 +40799,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -44563,23 +40992,6 @@ "requestBody": { "description": "Partially update information about a Product Stream resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStream" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductStream" @@ -44770,23 +41182,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductStreamFilter" @@ -44850,11 +41245,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -45048,23 +41438,6 @@ "requestBody": { "description": "Partially update information about a Product Stream Filter resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductStreamFilter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductStreamFilter" @@ -45255,23 +41628,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductVisibility" @@ -45335,11 +41691,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -45533,23 +41884,6 @@ "requestBody": { "description": "Partially update information about a Product Visibility resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductVisibility" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductVisibility" @@ -45740,23 +42074,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Promotion" @@ -45820,11 +42137,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -46018,23 +42330,6 @@ "requestBody": { "description": "Partially update information about a Promotion resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Promotion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Promotion" @@ -46225,23 +42520,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscount" @@ -46305,11 +42583,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -46503,23 +42776,6 @@ "requestBody": { "description": "Partially update information about a Promotion Discount resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscount" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscount" @@ -46710,23 +42966,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscountPrices" @@ -46790,11 +43029,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -46988,23 +43222,6 @@ "requestBody": { "description": "Partially update information about a Promotion Discount Prices resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDiscountPrices" @@ -47195,23 +43412,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionIndividualCode" @@ -47275,11 +43475,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -47473,23 +43668,6 @@ "requestBody": { "description": "Partially update information about a Promotion Individual Code resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionIndividualCode" @@ -47680,23 +43858,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSalesChannel" @@ -47760,11 +43921,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -47958,23 +44114,6 @@ "requestBody": { "description": "Partially update information about a Promotion Sales Channel resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSalesChannel" @@ -48165,23 +44304,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSetgroup" @@ -48245,11 +44367,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -48443,23 +44560,6 @@ "requestBody": { "description": "Partially update information about a Promotion Setgroup resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PromotionSetgroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSetgroup" @@ -48650,23 +44750,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" @@ -48730,11 +44813,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -48928,23 +45006,6 @@ "requestBody": { "description": "Partially update information about a Property Group resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroup" @@ -49135,23 +45196,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroupOption" @@ -49215,11 +45259,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -49413,23 +45452,6 @@ "requestBody": { "description": "Partially update information about a Property Group Option resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/PropertyGroupOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/PropertyGroupOption" @@ -49620,23 +45642,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Rule" @@ -49700,11 +45705,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -49898,23 +45898,6 @@ "requestBody": { "description": "Partially update information about a Rule resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Rule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Rule" @@ -50105,23 +46088,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/RuleCondition" @@ -50185,11 +46151,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -50383,23 +46344,6 @@ "requestBody": { "description": "Partially update information about a Rule Condition resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/RuleCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/RuleCondition" @@ -50590,23 +46534,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannel" @@ -50670,11 +46597,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -50868,23 +46790,6 @@ "requestBody": { "description": "Partially update information about a Sales Channel resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannel" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannel" @@ -51075,23 +46980,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelAnalytics" @@ -51155,11 +47043,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -51353,23 +47236,6 @@ "requestBody": { "description": "Partially update information about a Sales Channel Analytics resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelAnalytics" @@ -51560,23 +47426,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -51640,11 +47489,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -51838,23 +47682,6 @@ "requestBody": { "description": "Partially update information about a Sales Channel Domain resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelDomain" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -52045,23 +47872,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelType" @@ -52125,11 +47935,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -52323,23 +48128,6 @@ "requestBody": { "description": "Partially update information about a Sales Channel Type resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SalesChannelType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SalesChannelType" @@ -52530,23 +48318,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Salutation" @@ -52610,11 +48381,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -52808,23 +48574,6 @@ "requestBody": { "description": "Partially update information about a Salutation resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Salutation" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Salutation" @@ -53015,169 +48764,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/ScheduledTask" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Search for the Scheduled Task resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchScheduledTask", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/scheduled-task": { - "post": { - "tags": [ - "Scheduled Task" - ], - "summary": "Search for the Scheduled Task resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchScheduledTask", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/scheduled-task/{id}": { - "get": { - "tags": [ - "Scheduled Task" - ], - "summary": "Detailed information about a Scheduled Task resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the scheduled_task", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/scheduled-task/{id}": { + "get": { + "tags": [ + "Scheduled Task" + ], + "summary": "Detailed information about a Scheduled Task resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getScheduledTask", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the scheduled_task", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of ScheduledTask", @@ -53293,23 +49020,6 @@ "requestBody": { "description": "Partially update information about a Scheduled Task resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ScheduledTask" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledTask" @@ -53500,23 +49210,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Script" @@ -53580,11 +49273,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -53778,23 +49466,6 @@ "requestBody": { "description": "Partially update information about a Script resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Script" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Script" @@ -53985,23 +49656,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrl" @@ -54065,11 +49719,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -54263,23 +49912,6 @@ "requestBody": { "description": "Partially update information about a Seo Url resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrl" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrl" @@ -54470,23 +50102,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrlTemplate" @@ -54550,11 +50165,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -54748,23 +50358,6 @@ "requestBody": { "description": "Partially update information about a Seo Url Template resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SeoUrlTemplate" @@ -54955,23 +50548,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethod" @@ -55035,11 +50611,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -55233,23 +50804,6 @@ "requestBody": { "description": "Partially update information about a Shipping Method resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethod" @@ -55440,23 +50994,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodPrice" @@ -55520,11 +51057,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -55718,23 +51250,6 @@ "requestBody": { "description": "Partially update information about a Shipping Method Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodPrice" @@ -55925,23 +51440,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Snippet" @@ -56005,11 +51503,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -56203,23 +51696,6 @@ "requestBody": { "description": "Partially update information about a Snippet resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Snippet" @@ -56410,23 +51886,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SnippetSet" @@ -56490,11 +51949,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -56688,23 +52142,6 @@ "requestBody": { "description": "Partially update information about a Snippet Set resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SnippetSet" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SnippetSet" @@ -56895,23 +52332,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachine" @@ -56975,11 +52395,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -57173,23 +52588,6 @@ "requestBody": { "description": "Partially update information about a State Machine resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachine" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachine" @@ -57380,23 +52778,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineHistory" @@ -57460,11 +52841,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -57658,23 +53034,6 @@ "requestBody": { "description": "Partially update information about a State Machine History resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineHistory" @@ -57865,23 +53224,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineState" @@ -57945,11 +53287,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -58143,23 +53480,6 @@ "requestBody": { "description": "Partially update information about a State Machine State resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineState" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineState" @@ -58350,23 +53670,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineTransition" @@ -58430,11 +53733,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -58628,23 +53926,6 @@ "requestBody": { "description": "Partially update information about a State Machine Transition resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineTransition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/StateMachineTransition" @@ -58835,23 +54116,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfig" @@ -58915,11 +54179,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -59113,23 +54372,6 @@ "requestBody": { "description": "Partially update information about a System Config resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemConfig" @@ -59320,23 +54562,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Tag" @@ -59400,11 +54625,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -59598,23 +54818,6 @@ "requestBody": { "description": "Partially update information about a Tag resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Tag" @@ -59805,23 +55008,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Tax" @@ -59885,11 +55071,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -60083,23 +55264,6 @@ "requestBody": { "description": "Partially update information about a Tax resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Tax" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Tax" @@ -60290,23 +55454,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxProvider" @@ -60370,11 +55517,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -60568,23 +55710,6 @@ "requestBody": { "description": "Partially update information about a Tax Provider resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxProvider" @@ -60775,23 +55900,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxRule" @@ -60855,11 +55963,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -61053,23 +56156,6 @@ "requestBody": { "description": "Partially update information about a Tax Rule resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxRule" @@ -61260,23 +56346,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxRuleType" @@ -61340,11 +56409,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -61538,23 +56602,6 @@ "requestBody": { "description": "Partially update information about a Tax Rule Type resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxRuleType" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/TaxRuleType" @@ -61745,23 +56792,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Theme" @@ -61825,11 +56855,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -62023,23 +57048,6 @@ "requestBody": { "description": "Partially update information about a Theme resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Theme" @@ -62230,169 +57238,147 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/Unit" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "uniqueItems": true + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Unit" + } } } } - }, + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/unit": { + "post": { + "tags": [ + "Unit" + ], + "summary": "Search for the Unit resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUnit", + "requestBody": { + "required": true, + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Criteria" } } } }, - "responses": { - "200": { - "description": "Detail of Unit", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/unit": { - "post": { - "tags": [ - "Unit" - ], - "summary": "Search for the Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUnit", - "requestBody": { - "required": true, - "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Unit", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Unit" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Unit" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/unit/{id}": { - "get": { - "tags": [ - "Unit" - ], - "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 unit", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "responses": { + "200": { + "description": "List of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/unit/{id}": { + "get": { + "tags": [ + "Unit" + ], + "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 unit", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { "description": "Detail of Unit", @@ -62508,23 +57494,6 @@ "requestBody": { "description": "Partially update information about a Unit resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Unit" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Unit" @@ -62715,23 +57684,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/User" @@ -62795,11 +57747,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -62993,23 +57940,6 @@ "requestBody": { "description": "Partially update information about a User resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/User" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/User" @@ -63200,23 +58130,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/UserAccessKey" @@ -63280,11 +58193,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -63478,23 +58386,6 @@ "requestBody": { "description": "Partially update information about a User Access Key resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/UserAccessKey" @@ -63685,23 +58576,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" @@ -63765,11 +58639,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -63963,23 +58832,6 @@ "requestBody": { "description": "Partially update information about a User Config resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/UserConfig" @@ -64170,23 +59022,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRecovery" @@ -64250,11 +59085,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -64448,23 +59278,6 @@ "requestBody": { "description": "Partially update information about a User Recovery resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserRecovery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/UserRecovery" @@ -64655,23 +59468,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" @@ -64735,11 +59531,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -64933,23 +59724,6 @@ "requestBody": { "description": "Partially update information about a Webhook resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Webhook" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" @@ -65140,23 +59914,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventLog" @@ -65220,11 +59977,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -65418,23 +60170,6 @@ "requestBody": { "description": "Partially update information about a Webhook Event Log resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WebhookEventLog" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventLog" @@ -66608,6 +61343,26 @@ "items": { "type": "object" } + }, + "filter": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } } }, "type": "object" @@ -67128,6 +61883,21 @@ } } }, + "/_action/cache-delayed": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } + }, "/_action/cleanup": { "delete": { "tags": [ @@ -96426,8 +91196,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -96585,8 +91354,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -108051,22 +102819,19 @@ "type": "array", "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] }, "properties": { @@ -108117,22 +102882,19 @@ "type": "array", "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] }, "properties": { @@ -108148,33 +102910,12 @@ } }, "associations": { - "type": "object", - "description": "Used to fetch associations which are not fetched by default." + "$ref": "#/components/schemas/Associations" }, "aggregations": { "type": "array", - "description": "Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)", "items": { - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string" - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] + "$ref": "#/components/schemas/Aggregation" } }, "grouping": { @@ -108202,9 +102943,592 @@ "exact", "next-pages" ] + }, + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "includes": { + "$ref": "#/components/schemas/Includes" } } }, + "Includes": { + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "anyOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] + }, + "field": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equalsAny", + "equalsAll" + ] + }, + "field": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type", + "field", + "value" + ] + } + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multi", + "not" + ] + }, + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] + }, + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "type": "string" + }, + "parameters": { + "type": "object", + "properties": { + "gte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "gt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + } + } + }, + "required": [ + "type", + "field", + "parameters" + ] + }, + "Sort": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + "naturalSorting": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "required": [ + "field", + "order" + ] + }, + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" + } + ] + } + } + }, + "AggregationEntity": { + "title": "AggregationEntity", + "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", + "enum": [ + "entity" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] + }, + "AggregationFilter": { + "title": "AggregationFilter", + "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", + "enum": [ + "filter" + ] + }, + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } + } + }, + "required": [ + "name", + "type", + "filter" + ] + }, + "AggregationTerms": { + "title": "AggregationTerms", + "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", + "enum": [ + "terms" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "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", + "enum": [ + "histogram" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "interval": { + "description": "The interval of the histogram", + "type": "number" + }, + "format": { + "description": "The format of the histogram", + "type": "string" + }, + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { + "type": "object", + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] + } + ] + } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, "Cart": { "properties": { "id": { diff --git a/adminapi.summary.json b/adminapi.summary.json index 1981cae..ad55780 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -1,6 +1,7 @@ { "paths": [ "/_action/cache", + "/_action/cache-delayed", "/_action/cache_info", "/_action/cleanup", "/_action/container_cache", @@ -449,6 +450,13 @@ "AclUserRole", "AdvancedSearchConfig", "AdvancedSearchConfigField", + "Aggregation", + "AggregationEntity", + "AggregationFilter", + "AggregationHistogram", + "AggregationMetrics", + "AggregationRange", + "AggregationTerms", "App", "AppActionButton", "AppActionButtonJsonApi", @@ -469,6 +477,7 @@ "AppShippingMethodJsonApi", "AppTemplate", "AppTemplateJsonApi", + "Associations", "Cart", "CartItems", "Category", @@ -526,6 +535,8 @@ "DocumentJsonApi", "DocumentType", "DocumentTypeJsonApi", + "EqualsFilter", + "Filters", "FindProductVariantRouteResponse", "Flow", "FlowJsonApi", @@ -539,6 +550,7 @@ "ImportExportLogJsonApi", "ImportExportProfile", "ImportExportProfileJsonApi", + "Includes", "Integration", "IntegrationJsonApi", "IntegrationRole", @@ -577,6 +589,7 @@ "MediaThumbnailJsonApi", "MediaThumbnailSize", "MediaThumbnailSizeJsonApi", + "MultiNotFilter", "NavigationRouteResponse", "NewsletterRecipient", "NewsletterRecipientJsonApi", @@ -702,6 +715,7 @@ "PropertyGroupJsonApi", "PropertyGroupOption", "PropertyGroupOptionJsonApi", + "RangeFilter", "Rule", "RuleCondition", "RuleConditionJsonApi", @@ -736,11 +750,13 @@ "ShippingMethodPrice", "ShippingMethodPriceJsonApi", "ShippingMethodTag", + "SimpleFilter", "Sitemap", "Snippet", "SnippetJsonApi", "SnippetSet", "SnippetSetJsonApi", + "Sort", "StateMachine", "StateMachineHistory", "StateMachineHistoryJsonApi", @@ -749,6 +765,7 @@ "StateMachineStateJsonApi", "StateMachineTransition", "StateMachineTransitionJsonApi", + "SubAggregations", "Subscription", "SubscriptionAddress", "SubscriptionCustomer", From 77b607a8f82910559303b135da56a9852d366715 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 14 Nov 2024 08:22:38 +0100 Subject: [PATCH 35/63] [create-pull-request] automated change (#331) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 1067 ++++++++++-------- SwagCustomizedProducts-adminapi.summary.json | 17 + 2 files changed, 640 insertions(+), 444 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 62b0294..1cd7a0c 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.6.7.1" + "version": "6.6.8.2" }, "servers": [ { @@ -150,23 +150,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" @@ -230,11 +213,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -428,23 +406,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" @@ -635,23 +596,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" @@ -715,11 +659,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -913,23 +852,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" @@ -1120,23 +1042,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" @@ -1200,11 +1105,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1398,23 +1298,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" @@ -1605,23 +1488,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" @@ -1685,11 +1551,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1883,23 +1744,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" @@ -2090,23 +1934,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" @@ -2170,11 +1997,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2368,23 +2190,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" @@ -2575,23 +2380,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" @@ -2655,11 +2443,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2853,23 +2636,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" @@ -3060,23 +2826,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" @@ -3140,11 +2889,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3338,23 +3082,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" @@ -3545,23 +3272,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" @@ -3625,11 +3335,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3823,23 +3528,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" @@ -4030,23 +3718,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" @@ -4110,11 +3781,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4308,23 +3974,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Value resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" @@ -4515,23 +4164,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" @@ -4595,11 +4227,6 @@ "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4793,23 +4420,6 @@ "requestBody": { "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" @@ -4864,6 +4474,21 @@ } } } + }, + "/_action/cache-delayed": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } } }, "components": { @@ -32886,8 +32511,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -33045,8 +32669,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -46595,22 +46218,19 @@ "type": "array", "description": "List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] } }, @@ -46639,53 +46259,29 @@ "type": "array", "description": "Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)", "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" }, - "field": { - "type": "string" + { + "$ref": "#/components/schemas/EqualsFilter" }, - "value": { - "type": "string" + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" } - }, - "required": [ - "type", - "field", - "value" ] } }, "associations": { - "type": "object", - "description": "Used to fetch associations which are not fetched by default." + "$ref": "#/components/schemas/Associations" }, "aggregations": { "type": "array", - "description": "Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)", "items": { - "type": "object", - "properties": { - "name": { - "description": "Give your aggregation an identifier, so you can find it easier", - "type": "string" - }, - "type": { - "description": "The type of aggregation", - "type": "string" - }, - "field": { - "description": "The field you want to aggregate over.", - "type": "string" - } - }, - "required": [ - "name", - "type", - "field" - ] + "$ref": "#/components/schemas/Aggregation" } }, "grouping": { @@ -46713,8 +46309,591 @@ "exact", "next-pages" ] + }, + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } + }, + "includes": { + "$ref": "#/components/schemas/Includes" } } + }, + "Includes": { + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "anyOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] + }, + "field": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equalsAny", + "equalsAll" + ] + }, + "field": { + "type": "string" + }, + "value": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type", + "field", + "value" + ] + } + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multi", + "not" + ] + }, + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] + }, + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "type": "string" + }, + "parameters": { + "type": "object", + "properties": { + "gte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "gt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + } + } + }, + "required": [ + "type", + "field", + "parameters" + ] + }, + "Sort": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, + "naturalSorting": { + "type": "boolean" + }, + "type": { + "type": "string" + } + }, + "required": [ + "field", + "order" + ] + }, + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" + }, + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" + }, + { + "$ref": "#/components/schemas/AggregationEntity" + }, + { + "$ref": "#/components/schemas/AggregationFilter" + }, + { + "$ref": "#/components/schemas/AggregationTerms" + }, + { + "$ref": "#/components/schemas/AggregationHistogram" + }, + { + "$ref": "#/components/schemas/AggregationRange" + } + ] + } + } + }, + "AggregationEntity": { + "title": "AggregationEntity", + "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", + "enum": [ + "entity" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] + }, + "AggregationFilter": { + "title": "AggregationFilter", + "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", + "enum": [ + "filter" + ] + }, + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } + } + }, + "required": [ + "name", + "type", + "filter" + ] + }, + "AggregationTerms": { + "title": "AggregationTerms", + "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", + "enum": [ + "terms" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "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", + "enum": [ + "histogram" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "interval": { + "description": "The interval of the histogram", + "type": "number" + }, + "format": { + "description": "The format of the histogram", + "type": "string" + }, + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" + }, + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { + "type": "object", + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] + }, + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] + } + ] + } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" + } + }, + "required": [ + "name", + "type", + "field" + ] } }, "responses": { diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index ffc21ce..ab4907d 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,5 +1,6 @@ { "paths": [ + "/_action/cache-delayed", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", @@ -35,6 +36,13 @@ "AclRole", "AclRoleJsonApi", "AclUserRole", + "Aggregation", + "AggregationEntity", + "AggregationFilter", + "AggregationHistogram", + "AggregationMetrics", + "AggregationRange", + "AggregationTerms", "App", "AppActionButton", "AppActionButtonJsonApi", @@ -55,6 +63,7 @@ "AppShippingMethodJsonApi", "AppTemplate", "AppTemplateJsonApi", + "Associations", "Category", "CategoryJsonApi", "CategoryTag", @@ -107,6 +116,8 @@ "DocumentJsonApi", "DocumentType", "DocumentTypeJsonApi", + "EqualsFilter", + "Filters", "Flow", "FlowJsonApi", "FlowSequence", @@ -119,6 +130,7 @@ "ImportExportLogJsonApi", "ImportExportProfile", "ImportExportProfileJsonApi", + "Includes", "Integration", "IntegrationJsonApi", "IntegrationRole", @@ -155,6 +167,7 @@ "MediaThumbnailJsonApi", "MediaThumbnailSize", "MediaThumbnailSizeJsonApi", + "MultiNotFilter", "NewsletterRecipient", "NewsletterRecipientJsonApi", "NewsletterRecipientTag", @@ -268,6 +281,7 @@ "PropertyGroupJsonApi", "PropertyGroupOption", "PropertyGroupOptionJsonApi", + "RangeFilter", "Rule", "RuleCondition", "RuleConditionJsonApi", @@ -301,10 +315,12 @@ "ShippingMethodPrice", "ShippingMethodPriceJsonApi", "ShippingMethodTag", + "SimpleFilter", "Snippet", "SnippetJsonApi", "SnippetSet", "SnippetSetJsonApi", + "Sort", "StateMachine", "StateMachineHistory", "StateMachineHistoryJsonApi", @@ -313,6 +329,7 @@ "StateMachineStateJsonApi", "StateMachineTransition", "StateMachineTransitionJsonApi", + "SubAggregations", "SwagCustomizedProductsTemplate", "SwagCustomizedProductsTemplateConfiguration", "SwagCustomizedProductsTemplateConfigurationJsonApi", From 9864faa93241d3fd2c370e8fda16140e35575692 Mon Sep 17 00:00:00 2001 From: Micha Date: Fri, 22 Nov 2024 11:40:43 +0100 Subject: [PATCH 36/63] Fix visibility --- descriptions.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/descriptions.yml b/descriptions.yml index 4ea56e8..b351753 100644 --- a/descriptions.yml +++ b/descriptions.yml @@ -2183,7 +2183,7 @@ Unique identity of the sales channel. ".components.schemas.ProductVisibility.properties.visibility": > - An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listing`, `20` indicates `Hide in listings and search` and `30` indicates `Visible` everywhere. + 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. ".components.schemas.ProductWarehouse.properties.id": > Unique identity of product warehouse. From a81e5a96996142b925ed62f2159ee17fd044e9ba Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 15:22:56 +0100 Subject: [PATCH 37/63] [create-pull-request] automated change (#340) Co-authored-by: shopwareBot --- adminapi.json | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/adminapi.json b/adminapi.json index db8b7c7..53a8b59 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.8.2" + "version": "6.6.9.0" }, "servers": [ { @@ -62695,6 +62695,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, "sourceType": { "type": "string" }, @@ -63214,6 +63217,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, "sourceType": { "type": "string" }, @@ -90574,7 +90580,7 @@ "visibility": { "type": "integer", "format": "int64", - "description": "An integer value to signify the product's visibility in any sales channel. `10` indicates `Hide in listing`, `20` indicates `Hide in listings and search` and `30` indicates `Visible` everywhere." + "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." }, "createdAt": { "type": "string", From e0a51a36a116ee0fd04e9ea3738cf51a717387f4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 5 Dec 2024 15:23:19 +0100 Subject: [PATCH 38/63] [create-pull-request] automated change (#338) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 23 ++++++-------------- SwagCustomizedProducts-adminapi.summary.json | 1 - 2 files changed, 7 insertions(+), 17 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 1cd7a0c..a44c1ce 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.6.8.2" + "version": "6.6.9.0" }, "servers": [ { @@ -4474,21 +4474,6 @@ } } } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } } }, "components": { @@ -5168,6 +5153,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, "sourceType": { "type": "string" }, @@ -5670,6 +5658,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, "sourceType": { "type": "string" }, diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index ab4907d..2b4343f 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,6 +1,5 @@ { "paths": [ - "/_action/cache-delayed", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", From 8ad7d659618abc2b8d24fc0779685ca9efce13cf Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 7 May 2025 10:02:32 +0200 Subject: [PATCH 39/63] [create-pull-request] automated change (#357) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 21136 ++++++++++++++---- SwagDigitalSalesRooms-adminapi.summary.json | 180 +- 2 files changed, 17415 insertions(+), 3901 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index b9badff..f723eb3 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.6.7.0" + "version": "6.6.10.4" }, "servers": [ { @@ -15,43 +15,38 @@ } ], "paths": { - "/dsr-appointment": { - "get": { + "/aggregate/acl-role": { + "post": { "tags": [ - "Dsr Appointment" + "Acl Role" ], - "summary": "List with basic information of Dsr Appointment resources.", - "description": "", - "operationId": "getDsrAppointmentList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Acl Role resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAclRole", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Appointment resources.", + "description": "List of AclRole", "content": { "application/vnd.api+json": { "schema": { @@ -63,41 +58,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointment" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-appointment?limit=25" - }, - "last": { - "example": "/dsr-appointment?limit=25&page=11" - }, - "next": { - "example": "/dsr-appointment?limit=25&page=4" - }, - "prev": { - "example": "/dsr-appointment?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } } } } @@ -114,7 +78,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/AclRole" } } } @@ -122,61 +86,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/app": { "post": { "tags": [ - "Dsr Appointment" - ], - "summary": "Create a new Dsr Appointment resources.", - "description": "", - "operationId": "createDsrAppointment", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App" ], + "summary": "Aggregate for the App resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateApp", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointment" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointment" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "List of App", "content": { "application/vnd.api+json": { "schema": { @@ -188,7 +138,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -198,12 +151,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -219,32 +175,38 @@ } } }, - "/search/dsr-appointment": { + "/aggregate/app-action-button": { "post": { "tags": [ - "Dsr Appointment" + "App Action Button" ], - "summary": "Search for the Dsr Appointment resources.", - "description": "", - "operationId": "searchDsrAppointment", + "summary": "Aggregate for the App Action Button resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppActionButton", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of AppActionButton", "content": { "application/vnd.api+json": { "schema": { @@ -258,7 +220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/AppActionButton" } } } @@ -276,7 +238,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/AppActionButton" } } } @@ -293,29 +255,38 @@ } } }, - "/dsr-appointment/{id}": { - "get": { + "/aggregate/app-administration-snippet": { + "post": { "tags": [ - "Dsr Appointment" + "App Administration Snippet" ], - "summary": "Detailed information about a Dsr Appointment resource.", - "description": "", - "operationId": "getDsrAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the App Administration Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppAdministrationSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "List of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { @@ -327,7 +298,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } @@ -337,124 +311,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Appointment" - ], - "summary": "Delete a Dsr Appointment resource.", - "description": "", - "operationId": "deleteDsrAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/app-cms-block": { + "post": { "tags": [ - "Dsr Appointment" - ], - "summary": "Partially update information about a Dsr Appointment resource.", - "description": "", - "operationId": "updateDsrAppointment", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Cms Block" ], + "summary": "Aggregate for the App Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppCmsBlock", "requestBody": { - "description": "Partially update information about a Dsr Appointment resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointment" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointment" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "List of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -466,7 +378,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -476,12 +391,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointment" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -491,52 +409,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-appointment-attendee": { - "get": { + "/aggregate/app-flow-action": { + "post": { "tags": [ - "Dsr Appointment Attendee" + "App Flow Action" ], - "summary": "List with basic information of Dsr Appointment Attendee resources.", - "description": "", - "operationId": "getDsrAppointmentAttendeeList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the App Flow Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowAction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Appointment Attendee resources.", + "description": "List of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { @@ -548,41 +458,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-appointment-attendee?limit=25" - }, - "last": { - "example": "/dsr-appointment-attendee?limit=25&page=11" - }, - "next": { - "example": "/dsr-appointment-attendee?limit=25&page=4" - }, - "prev": { - "example": "/dsr-appointment-attendee?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } } } } @@ -599,7 +478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/AppFlowAction" } } } @@ -607,61 +486,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/app-flow-event": { "post": { "tags": [ - "Dsr Appointment Attendee" - ], - "summary": "Create a new Dsr Appointment Attendee resources.", - "description": "", - "operationId": "createDsrAppointmentAttendee", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App Flow Event" ], + "summary": "Aggregate for the App Flow Event resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowEvent", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { @@ -673,7 +538,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -683,12 +551,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -704,32 +575,38 @@ } } }, - "/search/dsr-appointment-attendee": { + "/aggregate/app-payment-method": { "post": { "tags": [ - "Dsr Appointment Attendee" + "App Payment Method" ], - "summary": "Search for the Dsr Appointment Attendee resources.", - "description": "", - "operationId": "searchDsrAppointmentAttendee", + "summary": "Aggregate for the App Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppPaymentMethod", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -743,7 +620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/AppPaymentMethod" } } } @@ -761,7 +638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/AppPaymentMethod" } } } @@ -778,41 +655,53 @@ } } }, - "/dsr-appointment-attendee/{id}": { - "get": { + "/aggregate/app-script-condition": { + "post": { "tags": [ - "Dsr Appointment Attendee" - ], - "summary": "Detailed information about a Dsr Appointment Attendee resource.", - "description": "", - "operationId": "getDsrAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "App Script Condition" ], - "responses": { - "200": { - "description": "Detail of DsrAppointmentAttendee", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { + "summary": "Aggregate for the App Script Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppScriptCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } @@ -822,124 +711,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Appointment Attendee" - ], - "summary": "Delete a Dsr Appointment Attendee resource.", - "description": "", - "operationId": "deleteDsrAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/app-shipping-method": { + "post": { "tags": [ - "Dsr Appointment Attendee" - ], - "summary": "Partially update information about a Dsr Appointment Attendee resource.", - "description": "", - "operationId": "updateDsrAppointmentAttendee", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_attendee", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Shipping Method" ], + "summary": "Aggregate for the App Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppShippingMethod", "requestBody": { - "description": "Partially update information about a Dsr Appointment Attendee resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "List of AppShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -951,7 +778,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } } } @@ -961,12 +791,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } } } } @@ -976,52 +809,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-appointment-request": { - "get": { + "/aggregate/app-template": { + "post": { "tags": [ - "Dsr Appointment Request" + "App Template" ], - "summary": "List with basic information of Dsr Appointment Request resources.", - "description": "", - "operationId": "getDsrAppointmentRequestList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the App Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Appointment Request resources.", + "description": "List of AppTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -1033,41 +858,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-appointment-request?limit=25" - }, - "last": { - "example": "/dsr-appointment-request?limit=25&page=11" - }, - "next": { - "example": "/dsr-appointment-request?limit=25&page=4" - }, - "prev": { - "example": "/dsr-appointment-request?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } } } } @@ -1084,7 +878,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/AppTemplate" } } } @@ -1092,61 +886,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/category": { "post": { "tags": [ - "Dsr Appointment Request" - ], - "summary": "Create a new Dsr Appointment Request resources.", - "description": "", - "operationId": "createDsrAppointmentRequest", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Category" ], + "summary": "Aggregate for the Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCategory", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "List of Category", "content": { "application/vnd.api+json": { "schema": { @@ -1158,7 +938,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } } } } @@ -1168,12 +951,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } } } } @@ -1189,32 +975,38 @@ } } }, - "/search/dsr-appointment-request": { + "/aggregate/cms-block": { "post": { "tags": [ - "Dsr Appointment Request" + "Cms Block" ], - "summary": "Search for the Dsr Appointment Request resources.", - "description": "", - "operationId": "searchDsrAppointmentRequest", + "summary": "Aggregate for the Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsBlock", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of CmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -1228,7 +1020,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -1246,7 +1038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/CmsBlock" } } } @@ -1263,29 +1055,38 @@ } } }, - "/dsr-appointment-request/{id}": { - "get": { + "/aggregate/cms-page": { + "post": { "tags": [ - "Dsr Appointment Request" + "Cms Page" ], - "summary": "Detailed information about a Dsr Appointment Request resource.", - "description": "", - "operationId": "getDsrAppointmentRequest", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_request", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Cms Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "List of CmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -1297,7 +1098,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } } } } @@ -1307,124 +1111,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Appointment Request" - ], - "summary": "Delete a Dsr Appointment Request resource.", - "description": "", - "operationId": "deleteDsrAppointmentRequest", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_request", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/cms-section": { + "post": { "tags": [ - "Dsr Appointment Request" - ], - "summary": "Partially update information about a Dsr Appointment Request resource.", - "description": "", - "operationId": "updateDsrAppointmentRequest", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_request", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Cms Section" ], + "summary": "Aggregate for the Cms Section resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSection", "requestBody": { - "description": "Partially update information about a Dsr Appointment Request resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "List of CmsSection", "content": { "application/vnd.api+json": { "schema": { @@ -1436,7 +1178,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } } } } @@ -1446,12 +1191,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } } } } @@ -1461,52 +1209,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-appointment-video-chat": { - "get": { + "/aggregate/cms-slot": { + "post": { "tags": [ - "Dsr Appointment Video Chat" + "Cms Slot" ], - "summary": "List with basic information of Dsr Appointment Video Chat resources.", - "description": "", - "operationId": "getDsrAppointmentVideoChatList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Cms Slot resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSlot", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Appointment Video Chat resources.", + "description": "List of CmsSlot", "content": { "application/vnd.api+json": { "schema": { @@ -1518,41 +1258,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-appointment-video-chat?limit=25" - }, - "last": { - "example": "/dsr-appointment-video-chat?limit=25&page=11" - }, - "next": { - "example": "/dsr-appointment-video-chat?limit=25&page=4" - }, - "prev": { - "example": "/dsr-appointment-video-chat?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } } } } @@ -1569,7 +1278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/CmsSlot" } } } @@ -1577,61 +1286,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/country": { "post": { "tags": [ - "Dsr Appointment Video Chat" - ], - "summary": "Create a new Dsr Appointment Video Chat resources.", - "description": "", - "operationId": "createDsrAppointmentVideoChat", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Country" ], + "summary": "Aggregate for the Country resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountry", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "List of Country", "content": { "application/vnd.api+json": { "schema": { @@ -1643,7 +1338,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } } } } @@ -1653,12 +1351,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } } } } @@ -1674,32 +1375,38 @@ } } }, - "/search/dsr-appointment-video-chat": { + "/aggregate/country-state": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Country State" ], - "summary": "Search for the Dsr Appointment Video Chat resources.", - "description": "", - "operationId": "searchDsrAppointmentVideoChat", + "summary": "Aggregate for the Country State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountryState", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "List of CountryState", "content": { "application/vnd.api+json": { "schema": { @@ -1713,7 +1420,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/CountryState" } } } @@ -1731,7 +1438,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "$ref": "#/components/schemas/CountryState" } } } @@ -1748,29 +1455,38 @@ } } }, - "/dsr-appointment-video-chat/{id}": { - "get": { + "/aggregate/currency": { + "post": { "tags": [ - "Dsr Appointment Video Chat" + "Currency" ], - "summary": "Detailed information about a Dsr Appointment Video Chat resource.", - "description": "", - "operationId": "getDsrAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Currency resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrency", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "List of Currency", "content": { "application/vnd.api+json": { "schema": { @@ -1782,7 +1498,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } } @@ -1792,124 +1511,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Appointment Video Chat" - ], - "summary": "Delete a Dsr Appointment Video Chat resource.", - "description": "", - "operationId": "deleteDsrAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/currency-country-rounding": { + "post": { "tags": [ - "Dsr Appointment Video Chat" - ], - "summary": "Partially update information about a Dsr Appointment Video Chat resource.", - "description": "", - "operationId": "updateDsrAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Currency Country Rounding" ], + "summary": "Aggregate for the Currency Country Rounding resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrencyCountryRounding", "requestBody": { - "description": "Partially update information about a Dsr Appointment Video Chat resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "List of CurrencyCountryRounding", "content": { "application/vnd.api+json": { "schema": { @@ -1921,7 +1578,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } } } @@ -1931,12 +1591,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } } } @@ -1946,52 +1609,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-attendee-product-collection": { - "get": { + "/aggregate/custom-entity": { + "post": { "tags": [ - "Dsr Attendee Product Collection" + "Custom Entity" ], - "summary": "List with basic information of Dsr Attendee Product Collection resources.", - "description": "", - "operationId": "getDsrAttendeeProductCollectionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Custom Entity resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomEntity", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Attendee Product Collection resources.", + "description": "List of CustomEntity", "content": { "application/vnd.api+json": { "schema": { @@ -2003,41 +1658,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-attendee-product-collection?limit=25" - }, - "last": { - "example": "/dsr-attendee-product-collection?limit=25&page=11" - }, - "next": { - "example": "/dsr-attendee-product-collection?limit=25&page=4" - }, - "prev": { - "example": "/dsr-attendee-product-collection?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } } } } @@ -2054,7 +1678,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/CustomEntity" } } } @@ -2062,61 +1686,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/custom-field": { "post": { "tags": [ - "Dsr Attendee Product Collection" - ], - "summary": "Create a new Dsr Attendee Product Collection resources.", - "description": "", - "operationId": "createDsrAttendeeProductCollection", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Custom Field" ], + "summary": "Aggregate for the Custom Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomField", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "List of CustomField", "content": { "application/vnd.api+json": { "schema": { @@ -2128,7 +1738,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } } } } @@ -2138,12 +1751,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } } } } @@ -2159,32 +1775,38 @@ } } }, - "/search/dsr-attendee-product-collection": { + "/aggregate/custom-field-set": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Custom Field Set" ], - "summary": "Search for the Dsr Attendee Product Collection resources.", - "description": "", - "operationId": "searchDsrAttendeeProductCollection", + "summary": "Aggregate for the Custom Field Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSet", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "List of CustomFieldSet", "content": { "application/vnd.api+json": { "schema": { @@ -2198,7 +1820,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -2216,7 +1838,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "$ref": "#/components/schemas/CustomFieldSet" } } } @@ -2233,29 +1855,38 @@ } } }, - "/dsr-attendee-product-collection/{id}": { - "get": { + "/aggregate/custom-field-set-relation": { + "post": { "tags": [ - "Dsr Attendee Product Collection" + "Custom Field Set Relation" ], - "summary": "Detailed information about a Dsr Attendee Product Collection resource.", - "description": "", - "operationId": "getDsrAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Custom Field Set Relation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSetRelation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "List of CustomFieldSetRelation", "content": { "application/vnd.api+json": { "schema": { @@ -2267,7 +1898,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } } } } @@ -2277,124 +1911,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/aggregate/customer": { + "post": { "tags": [ - "Dsr Attendee Product Collection" - ], - "summary": "Delete a Dsr Attendee Product Collection resource.", - "description": "", - "operationId": "deleteDsrAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Dsr Attendee Product Collection" - ], - "summary": "Partially update information about a Dsr Attendee Product Collection resource.", - "description": "", - "operationId": "updateDsrAttendeeProductCollection", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Customer" ], + "summary": "Aggregate for the Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomer", "requestBody": { - "description": "Partially update information about a Dsr Attendee Product Collection resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "List of Customer", "content": { "application/vnd.api+json": { "schema": { @@ -2406,7 +1978,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } } } } @@ -2416,12 +1991,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } } } } @@ -2431,52 +2009,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-interaction": { - "get": { + "/aggregate/customer-address": { + "post": { "tags": [ - "Dsr Interaction" + "Customer Address" ], - "summary": "List with basic information of Dsr Interaction resources.", - "description": "", - "operationId": "getDsrInteractionList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Customer Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Interaction resources.", + "description": "List of CustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -2488,41 +2058,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-interaction?limit=25" - }, - "last": { - "example": "/dsr-interaction?limit=25&page=11" - }, - "next": { - "example": "/dsr-interaction?limit=25&page=4" - }, - "prev": { - "example": "/dsr-interaction?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } } } } @@ -2539,7 +2078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/CustomerAddress" } } } @@ -2547,61 +2086,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/customer-group": { "post": { "tags": [ - "Dsr Interaction" - ], - "summary": "Create a new Dsr Interaction resources.", - "description": "", - "operationId": "createDsrInteraction", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Customer Group" ], + "summary": "Aggregate for the Customer Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerGroup", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrInteraction" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "List of CustomerGroup", "content": { "application/vnd.api+json": { "schema": { @@ -2613,7 +2138,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } } } } @@ -2623,12 +2151,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } } } } @@ -2644,32 +2175,38 @@ } } }, - "/search/dsr-interaction": { + "/aggregate/customer-recovery": { "post": { "tags": [ - "Dsr Interaction" + "Customer Recovery" ], - "summary": "Search for the Dsr Interaction resources.", - "description": "", - "operationId": "searchDsrInteraction", + "summary": "Aggregate for the Customer Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerRecovery", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrInteraction", + "description": "List of CustomerRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -2683,7 +2220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -2701,7 +2238,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrInteraction" + "$ref": "#/components/schemas/CustomerRecovery" } } } @@ -2718,29 +2255,38 @@ } } }, - "/dsr-interaction/{id}": { - "get": { + "/aggregate/customer-wishlist": { + "post": { "tags": [ - "Dsr Interaction" + "Customer Wishlist" ], - "summary": "Detailed information about a Dsr Interaction resource.", - "description": "", - "operationId": "getDsrInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Customer Wishlist resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlist", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "List of CustomerWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -2752,7 +2298,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } } } } @@ -2762,124 +2311,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Interaction" - ], - "summary": "Delete a Dsr Interaction resource.", - "description": "", - "operationId": "deleteDsrInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/customer-wishlist-product": { + "post": { "tags": [ - "Dsr Interaction" - ], - "summary": "Partially update information about a Dsr Interaction resource.", - "description": "", - "operationId": "updateDsrInteraction", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Customer Wishlist Product" ], + "summary": "Aggregate for the Customer Wishlist Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlistProduct", "requestBody": { - "description": "Partially update information about a Dsr Interaction resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrInteraction" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrInteraction", + "description": "List of CustomerWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -2891,7 +2378,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } } } } @@ -2901,12 +2391,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } } } } @@ -2916,52 +2409,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation": { - "get": { + "/aggregate/delivery-time": { + "post": { "tags": [ - "Dsr Presentation" + "Delivery Time" ], - "summary": "List with basic information of Dsr Presentation resources.", - "description": "", - "operationId": "getDsrPresentationList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Delivery Time resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDeliveryTime", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Dsr Presentation resources.", + "description": "List of DeliveryTime", "content": { "application/vnd.api+json": { "schema": { @@ -2973,41 +2458,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-presentation?limit=25" - }, - "last": { - "example": "/dsr-presentation?limit=25&page=11" - }, - "next": { - "example": "/dsr-presentation?limit=25&page=4" - }, - "prev": { - "example": "/dsr-presentation?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } } } } @@ -3024,7 +2478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DeliveryTime" } } } @@ -3032,61 +2486,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/document": { "post": { "tags": [ - "Dsr Presentation" - ], - "summary": "Create a new Dsr Presentation resources.", - "description": "", - "operationId": "createDsrPresentation", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Document" ], + "summary": "Aggregate for the Document resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocument", "requestBody": { + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "List of Document", "content": { "application/vnd.api+json": { "schema": { @@ -3098,7 +2538,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } } } } @@ -3108,12 +2551,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } } } } @@ -3129,32 +2575,38 @@ } } }, - "/search/dsr-presentation": { + "/aggregate/document-base-config": { "post": { "tags": [ - "Dsr Presentation" + "Document Base Config" ], - "summary": "Search for the Dsr Presentation resources.", - "description": "", - "operationId": "searchDsrPresentation", + "summary": "Aggregate for the Document Base Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfig", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of DsrPresentation", + "description": "List of DocumentBaseConfig", "content": { "application/vnd.api+json": { "schema": { @@ -3168,7 +2620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -3186,7 +2638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentation" + "$ref": "#/components/schemas/DocumentBaseConfig" } } } @@ -3203,29 +2655,38 @@ } } }, - "/dsr-presentation/{id}": { - "get": { + "/aggregate/document-base-config-sales-channel": { + "post": { "tags": [ - "Dsr Presentation" + "Document Base Config Sales Channel" ], - "summary": "Detailed information about a Dsr Presentation resource.", - "description": "", - "operationId": "getDsrPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfigSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "List of DocumentBaseConfigSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -3237,7 +2698,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } } } @@ -3247,124 +2711,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Delete a Dsr Presentation resource.", - "description": "", - "operationId": "deleteDsrPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/document-type": { + "post": { "tags": [ - "Dsr Presentation" - ], - "summary": "Partially update information about a Dsr Presentation resource.", - "description": "", - "operationId": "updateDsrPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Document Type" ], + "summary": "Aggregate for the Document Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentType", "requestBody": { - "description": "Partially update information about a Dsr Presentation resource.", + "required": true, "content": { - "application/vnd.api+json": { + "application/json": { "schema": { "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - }, - "included": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "$ref": "#/components/schemas/Aggregation" + } } - } - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of DsrPresentation", + "description": "List of DocumentType", "content": { "application/vnd.api+json": { "schema": { @@ -3376,7 +2778,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } } } } @@ -3386,12 +2791,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/DsrPresentation" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } } } } @@ -3401,23 +2809,20 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-presentation-cms-page": { + "/dsr-appointment": { "get": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Appointment" ], - "summary": "List with basic information of Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPageList", + "summary": "List with basic information of Dsr Appointment resources.", + "description": "", + "operationId": "getDsrAppointmentList", "parameters": [ { "name": "limit", @@ -3446,7 +2851,7 @@ ], "responses": { "200": { - "description": "List of Dsr Presentation Cms Page resources.", + "description": "List of Dsr Appointment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3465,7 +2870,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } ] @@ -3479,16 +2884,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-presentation-cms-page?limit=25" + "example": "/dsr-appointment?limit=25" }, "last": { - "example": "/dsr-presentation-cms-page?limit=25&page=11" + "example": "/dsr-appointment?limit=25&page=11" }, "next": { - "example": "/dsr-presentation-cms-page?limit=25&page=4" + "example": "/dsr-appointment?limit=25&page=4" }, "prev": { - "example": "/dsr-presentation-cms-page?limit=25&page=2" + "example": "/dsr-appointment?limit=25&page=2" } } } @@ -3509,7 +2914,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3524,11 +2929,11 @@ }, "post": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Appointment" ], - "summary": "Create a new Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDsrPresentationCmsPage", + "summary": "Create a new Dsr Appointment resources.", + "description": "", + "operationId": "createDsrAppointment", "parameters": [ { "name": "_response", @@ -3545,33 +2950,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -3583,7 +2971,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3598,7 +2986,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3614,22 +3002,17 @@ } } }, - "/search/dsr-presentation-cms-page": { + "/search/dsr-appointment": { "post": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Appointment" ], - "summary": "Search for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDsrPresentationCmsPage", + "summary": "Search for the Dsr Appointment resources.", + "description": "", + "operationId": "searchDsrAppointment", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3639,7 +3022,7 @@ }, "responses": { "200": { - "description": "List of DsrPresentationCmsPage", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -3653,7 +3036,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3671,7 +3054,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3688,19 +3071,19 @@ } } }, - "/dsr-presentation-cms-page/{id}": { + "/dsr-appointment/{id}": { "get": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Appointment" ], - "summary": "Detailed information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPage", + "summary": "Detailed information about a Dsr Appointment resource.", + "description": "", + "operationId": "getDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -3710,7 +3093,7 @@ ], "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -3722,7 +3105,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3737,7 +3120,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3754,16 +3137,16 @@ }, "delete": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Appointment" ], - "summary": "Delete a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDsrPresentationCmsPage", + "summary": "Delete a Dsr Appointment resource.", + "description": "", + "operationId": "deleteDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -3794,16 +3177,16 @@ }, "patch": { "tags": [ - "Dsr Presentation Cms Page" + "Dsr Appointment" ], - "summary": "Partially update information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDsrPresentationCmsPage", + "summary": "Partially update information about a Dsr Appointment resource.", + "description": "", + "operationId": "updateDsrAppointment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", + "description": "Identifier for the dsr_appointment", "required": true, "schema": { "type": "string", @@ -3821,35 +3204,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Partially update information about a Dsr Appointment resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "Detail of DsrPresentationCmsPage", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -3861,7 +3227,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3876,7 +3242,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -3895,339 +3261,355 @@ } } }, - "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "/aggregate/dsr-appointment": { "post": { "tags": [ - "Appointment" + "Dsr Appointment" ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Dsr Appointment resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointment", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "", + "description": "List of DsrAppointment", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/start": { - "post": { + "/dsr-appointment-attendee": { + "get": { "tags": [ - "Appointment" + "Dsr Appointment Attendee" ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", + "summary": "List with basic information of Dsr Appointment Attendee resources.", + "description": "", + "operationId": "getDsrAppointmentAttendeeList", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "integer" } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ + }, { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "page", + "in": "query", + "description": "The page to be returned", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "integer" } - } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ + }, { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], "responses": { "200": { - "description": "The sw-context-token from the attendee", + "description": "List of Dsr Appointment Attendee 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/DsrAppointmentAttendee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-attendee?limit=25" + }, + "last": { + "example": "/dsr-appointment-attendee?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-attendee?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-attendee?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { - "attendee-sw-context-token": { - "type": "string" + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { + }, "post": { "tags": [ - "Appointment" + "Dsr Appointment Attendee" ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", + "summary": "Create a new Dsr Appointment Attendee resources.", + "description": "", + "operationId": "createDsrAppointmentAttendee", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "productIds" - ], - "properties": { - "productIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - }, - "pageName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { - "201": { - "description": "Created a new instant listing", + "200": { + "description": "Detail of DsrAppointmentAttendee", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" } - }, - "example": { - "index": 1 } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/search/dsr-appointment-attendee": { + "post": { "tags": [ - "Appointment" - ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Dsr Appointment Attendee" ], + "summary": "Search for the Dsr Appointment Attendee resources.", + "description": "", + "operationId": "searchDsrAppointmentAttendee", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], - "properties": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "removeProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be removed to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" - }, - "pageName": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "Updated the instant listing", + "description": "List of DsrAppointmentAttendee", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" + "total": { + "type": "integer" }, - "pickedProductIds": { + "data": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which are picked for the instant listing" - }, - "title": { - "type": "string", - "description": "The title of the instant listing" + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } } - }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "/dsr-appointment-attendee/{id}": { "get": { "tags": [ - "Appointment" + "Dsr Appointment Attendee" ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", + "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "getDsrAppointmentAttendee", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", @@ -4237,289 +3619,523 @@ ], "responses": { "200": { - "description": "", + "description": "Detail of DsrAppointmentAttendee", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/video-room": { - "post": { + }, + "delete": { "tags": [ - "Appointment" + "Dsr Appointment Attendee" ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", + "summary": "Delete a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "deleteDsrAppointmentAttendee", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } - } - } + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } }, - "delete": { + "patch": { "tags": [ - "Appointment" + "Dsr Appointment Attendee" ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", + "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "updateDsrAppointmentAttendee", "parameters": [ { - "name": "appointmentId", + "name": "id", "in": "path", - "description": "Appointment id", + "description": "Identifier for the dsr_appointment_attendee", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": [] - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ + }, { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], + "requestBody": { + "description": "Partially update information about a Dsr Appointment Attendee resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + }, "responses": { "200": { - "description": "", + "description": "Detail of DsrAppointmentAttendee", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { - "get": { + "/aggregate/dsr-appointment-attendee": { + "post": { "tags": [ - "Appointment" + "Dsr Appointment Attendee" ], - "summary": "Get cart insights", - "description": "Get cart insights for the given appointment", - "operationId": "getCartInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentAttendee", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "", + "description": "List of DsrAppointmentAttendee", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/GetCartInsightsResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { + "/dsr-appointment-request": { "get": { "tags": [ - "Appointment" + "Dsr Appointment Request" ], - "summary": "Get cart statistics", - "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", - "operationId": "getCartStatistics", + "summary": "List with basic information of Dsr Appointment Request resources.", + "description": "", + "operationId": "getDsrAppointmentRequestList", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "", + "description": "List of Dsr Appointment Request 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/DsrAppointmentRequest" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-request?limit=25" + }, + "last": { + "example": "/dsr-appointment-request?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-request?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-request?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/Cart" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen": { - "get": { + }, + "post": { "tags": [ - "Appointment" + "Dsr Appointment Request" ], - "summary": "Get last seen products insights", - "description": "Get last seen products of all attendees for the given appointment", - "operationId": "getLastSeenProductsInsights", + "summary": "Create a new Dsr Appointment Request resources.", + "description": "", + "operationId": "createDsrAppointmentRequest", "parameters": [ { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], "requestBody": { - "required": false, "content": { "application/json": { "schema": { - "properties": { - "limit": { - "type": "integer", - "description": "The limit of the products which should be returned", - "default": 10 - }, - "page": { - "type": "integer", - "description": "The page of the products which should be returned", - "default": 1 - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The attendee id for which the last seen products should be returned" - } - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "", + "description": "Detail of DsrAppointmentRequest", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist": { - "get": { + "/search/dsr-appointment-request": { + "post": { "tags": [ - "Appointment" + "Dsr Appointment Request" ], - "summary": "Get wishlist insights", - "description": "Get wishlist of all the attendees for the given appointment", - "operationId": "getWishlistInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Search for the Dsr Appointment Request resources.", + "description": "", + "operationId": "searchDsrAppointmentRequest", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } } } - ], + }, "responses": { "200": { - "description": "", + "description": "List of DsrAppointmentRequest", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/WidgetProductListing" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove": { - "post": { + "/dsr-appointment-request/{id}": { + "get": { "tags": [ - "Appointment" + "Dsr Appointment Request" ], - "summary": "Remove an attendee from the appointment", - "description": "Remove an attendee from the appointment", - "operationId": "removeAttendee", + "summary": "Detailed information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "getDsrAppointmentRequest", "parameters": [ { - "name": "attendeeId", + "name": "id", "in": "path", - "description": "Attendee id", + "description": "Identifier for the dsr_appointment_request", "required": true, "schema": { "type": "string", @@ -4529,19 +4145,12133 @@ ], "responses": { "200": { - "description": "", + "description": "Detail of DsrAppointmentRequest", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "message": { - "type": "string" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the removed attendee" + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "Delete a Dsr Appointment Request resource.", + "description": "", + "operationId": "deleteDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "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": [ + "Dsr Appointment Request" + ], + "summary": "Partially update information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "updateDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "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 Dsr Appointment Request resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentRequest", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-appointment-request": { + "post": { + "tags": [ + "Dsr Appointment Request" + ], + "summary": "Aggregate for the Dsr Appointment Request resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentRequest", + "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 DsrAppointmentRequest", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-video-chat": { + "get": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "List with basic information of Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "getDsrAppointmentVideoChatList", + "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 Dsr Appointment Video Chat 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/DsrAppointmentVideoChat" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-video-chat?limit=25" + }, + "last": { + "example": "/dsr-appointment-video-chat?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-video-chat?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-video-chat?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Create a new Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "createDsrAppointmentVideoChat", + "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/DsrAppointmentVideoChat" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-appointment-video-chat": { + "post": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Search for the Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "searchDsrAppointmentVideoChat", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-appointment-video-chat/{id}": { + "get": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Detailed information about a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "getDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Delete a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "deleteDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Partially update information about a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "updateDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Appointment Video Chat resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-appointment-video-chat": { + "post": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Aggregate for the Dsr Appointment Video Chat resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAppointmentVideoChat", + "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 DsrAppointmentVideoChat", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-attendee-product-collection": { + "get": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "List with basic information of Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "getDsrAttendeeProductCollectionList", + "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 Dsr Attendee Product Collection 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/DsrAttendeeProductCollection" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-attendee-product-collection?limit=25" + }, + "last": { + "example": "/dsr-attendee-product-collection?limit=25&page=11" + }, + "next": { + "example": "/dsr-attendee-product-collection?limit=25&page=4" + }, + "prev": { + "example": "/dsr-attendee-product-collection?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Create a new Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "createDsrAttendeeProductCollection", + "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/DsrAttendeeProductCollection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-attendee-product-collection": { + "post": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Search for the Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "searchDsrAttendeeProductCollection", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-attendee-product-collection/{id}": { + "get": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Detailed information about a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "getDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Delete a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "deleteDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Partially update information about a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "updateDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Attendee Product Collection resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-attendee-product-collection": { + "post": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Aggregate for the Dsr Attendee Product Collection resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrAttendeeProductCollection", + "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 DsrAttendeeProductCollection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-cms-slide": { + "get": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "List with basic information of Dsr Cms Slide resources.", + "description": "", + "operationId": "getDsrCmsSlideList", + "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 Dsr Cms Slide 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/DsrCmsSlide" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-cms-slide?limit=25" + }, + "last": { + "example": "/dsr-cms-slide?limit=25&page=11" + }, + "next": { + "example": "/dsr-cms-slide?limit=25&page=4" + }, + "prev": { + "example": "/dsr-cms-slide?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "Create a new Dsr Cms Slide resources.", + "description": "", + "operationId": "createDsrCmsSlide", + "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/DsrCmsSlide" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrCmsSlide", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-cms-slide": { + "post": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "Search for the Dsr Cms Slide resources.", + "description": "", + "operationId": "searchDsrCmsSlide", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrCmsSlide", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-cms-slide/{id}": { + "get": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "Detailed information about a Dsr Cms Slide resource.", + "description": "", + "operationId": "getDsrCmsSlide", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_cms_slide", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrCmsSlide", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "Delete a Dsr Cms Slide resource.", + "description": "", + "operationId": "deleteDsrCmsSlide", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_cms_slide", + "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": [ + "Dsr Cms Slide" + ], + "summary": "Partially update information about a Dsr Cms Slide resource.", + "description": "", + "operationId": "updateDsrCmsSlide", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_cms_slide", + "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 Dsr Cms Slide resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrCmsSlide", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-cms-slide": { + "post": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "Aggregate for the Dsr Cms Slide resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrCmsSlide", + "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 DsrCmsSlide", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-interaction": { + "get": { + "tags": [ + "Dsr Interaction" + ], + "summary": "List with basic information of Dsr Interaction resources.", + "description": "", + "operationId": "getDsrInteractionList", + "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 Dsr Interaction 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/DsrInteraction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-interaction?limit=25" + }, + "last": { + "example": "/dsr-interaction?limit=25&page=11" + }, + "next": { + "example": "/dsr-interaction?limit=25&page=4" + }, + "prev": { + "example": "/dsr-interaction?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Create a new Dsr Interaction resources.", + "description": "", + "operationId": "createDsrInteraction", + "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/DsrInteraction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-interaction": { + "post": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Search for the Dsr Interaction resources.", + "description": "", + "operationId": "searchDsrInteraction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-interaction/{id}": { + "get": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Detailed information about a Dsr Interaction resource.", + "description": "", + "operationId": "getDsrInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Delete a Dsr Interaction resource.", + "description": "", + "operationId": "deleteDsrInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Partially update information about a Dsr Interaction resource.", + "description": "", + "operationId": "updateDsrInteraction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_interaction", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Interaction resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-interaction": { + "post": { + "tags": [ + "Dsr Interaction" + ], + "summary": "Aggregate for the Dsr Interaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrInteraction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrInteraction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrInteraction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation": { + "get": { + "tags": [ + "Dsr Presentation" + ], + "summary": "List with basic information of Dsr Presentation resources.", + "description": "", + "operationId": "getDsrPresentationList", + "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 Dsr Presentation 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/DsrPresentation" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-presentation?limit=25" + }, + "last": { + "example": "/dsr-presentation?limit=25&page=11" + }, + "next": { + "example": "/dsr-presentation?limit=25&page=4" + }, + "prev": { + "example": "/dsr-presentation?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Create a new Dsr Presentation resources.", + "description": "", + "operationId": "createDsrPresentation", + "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/DsrPresentation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-presentation": { + "post": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Search for the Dsr Presentation resources.", + "description": "", + "operationId": "searchDsrPresentation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation/{id}": { + "get": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Detailed information about a Dsr Presentation resource.", + "description": "", + "operationId": "getDsrPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Delete a Dsr Presentation resource.", + "description": "", + "operationId": "deleteDsrPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Partially update information about a Dsr Presentation resource.", + "description": "", + "operationId": "updateDsrPresentation", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Presentation resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-presentation": { + "post": { + "tags": [ + "Dsr Presentation" + ], + "summary": "Aggregate for the Dsr Presentation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrPresentation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation-cms-page": { + "get": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "List with basic information of Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPageList", + "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 Dsr Presentation Cms Page 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/DsrPresentationCmsPage" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-presentation-cms-page?limit=25" + }, + "last": { + "example": "/dsr-presentation-cms-page?limit=25&page=11" + }, + "next": { + "example": "/dsr-presentation-cms-page?limit=25&page=4" + }, + "prev": { + "example": "/dsr-presentation-cms-page?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Create a new Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDsrPresentationCmsPage", + "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/DsrPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/dsr-presentation-cms-page": { + "post": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Search for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDsrPresentationCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-presentation-cms-page/{id}": { + "get": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Detailed information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Delete a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "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": [ + "Dsr Presentation Cms Page" + ], + "summary": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDsrPresentationCmsPage", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_presentation_cms_page", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Dsr Presentation Cms Page resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/dsr-presentation-cms-page": { + "post": { + "tags": [ + "Dsr Presentation Cms Page" + ], + "summary": "Aggregate for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrPresentationCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DsrPresentationCmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/flow": { + "post": { + "tags": [ + "Flow" + ], + "summary": "Aggregate for the Flow resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlow", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/flow-sequence": { + "post": { + "tags": [ + "Flow Sequence" + ], + "summary": "Aggregate for the Flow Sequence resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowSequence", + "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 FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/flow-template": { + "post": { + "tags": [ + "Flow Template" + ], + "summary": "Aggregate for the Flow Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowTemplate", + "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 FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/import-export-file": { + "post": { + "tags": [ + "Import Export File" + ], + "summary": "Aggregate for the Import Export File resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportFile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/import-export-log": { + "post": { + "tags": [ + "Import Export Log" + ], + "summary": "Aggregate for the Import Export Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/import-export-profile": { + "post": { + "tags": [ + "Import Export Profile" + ], + "summary": "Aggregate for the Import Export Profile resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportProfile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/integration": { + "post": { + "tags": [ + "Integration" + ], + "summary": "Aggregate for the Integration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateIntegration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/landing-page": { + "post": { + "tags": [ + "Landing Page" + ], + "summary": "Aggregate for the Landing Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLandingPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/language": { + "post": { + "tags": [ + "Language" + ], + "summary": "Aggregate for the Language resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLanguage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/locale": { + "post": { + "tags": [ + "Locale" + ], + "summary": "Aggregate for the Locale resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLocale", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/log-entry": { + "post": { + "tags": [ + "Log Entry" + ], + "summary": "Aggregate for the Log Entry resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLogEntry", + "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 LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/mail-header-footer": { + "post": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Aggregate for the Mail Header Footer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailHeaderFooter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/mail-template": { + "post": { + "tags": [ + "Mail Template" + ], + "summary": "Aggregate for the Mail Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/mail-template-type": { + "post": { + "tags": [ + "Mail Template Type" + ], + "summary": "Aggregate for the Mail Template Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplateType", + "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 MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/main-category": { + "post": { + "tags": [ + "Main Category" + ], + "summary": "Aggregate for the Main Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMainCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media": { + "post": { + "tags": [ + "Media" + ], + "summary": "Aggregate for the Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-default-folder": { + "post": { + "tags": [ + "Media Default Folder" + ], + "summary": "Aggregate for the Media Default Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaDefaultFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-folder": { + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Aggregate for the Media Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-folder-configuration": { + "post": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Aggregate for the Media Folder Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolderConfiguration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-thumbnail": { + "post": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Aggregate for the Media Thumbnail resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-thumbnail-size": { + "post": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Aggregate for the Media Thumbnail Size resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnailSize", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/newsletter-recipient": { + "post": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Aggregate for the Newsletter Recipient resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNewsletterRecipient", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/notification": { + "post": { + "tags": [ + "Notification" + ], + "summary": "Aggregate for the Notification resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNotification", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range": { + "post": { + "tags": [ + "Number Range" + ], + "summary": "Aggregate for the Number Range resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRange", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range-sales-channel": { + "post": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Aggregate for the Number Range Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range-state": { + "post": { + "tags": [ + "Number Range State" + ], + "summary": "Aggregate for the Number Range State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range-type": { + "post": { + "tags": [ + "Number Range Type" + ], + "summary": "Aggregate for the Number Range Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order": { + "post": { + "tags": [ + "Order" + ], + "summary": "Aggregate for the Order resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-address": { + "post": { + "tags": [ + "Order Address" + ], + "summary": "Aggregate for the Order Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-customer": { + "post": { + "tags": [ + "Order Customer" + ], + "summary": "Aggregate for the Order Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderCustomer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-delivery": { + "post": { + "tags": [ + "Order Delivery" + ], + "summary": "Aggregate for the Order Delivery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDelivery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-delivery-position": { + "post": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Aggregate for the Order Delivery Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDeliveryPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-line-item": { + "post": { + "tags": [ + "Order Line Item" + ], + "summary": "Aggregate for the Order Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItem", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-line-item-download": { + "post": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Aggregate for the Order Line Item Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItemDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction": { + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Aggregate for the Order Transaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransaction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction-capture": { + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Aggregate for the Order Transaction Capture resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCapture", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Aggregate for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction-capture-refund-position": { + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefundPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/payment-method": { + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Aggregate for the Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/plugin": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Aggregate for the Plugin resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePlugin", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product": { + "post": { + "tags": [ + "Product" + ], + "summary": "Aggregate for the Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProduct", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-configurator-setting": { + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Aggregate for the Product Configurator Setting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductConfiguratorSetting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-cross-selling": { + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Aggregate for the Product Cross Selling resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSelling", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-cross-selling-assigned-products": { + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSellingAssignedProducts", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-download": { + "post": { + "tags": [ + "Product Download" + ], + "summary": "Aggregate for the Product Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-export": { + "post": { + "tags": [ + "Product Export" + ], + "summary": "Aggregate for the Product Export resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductExport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-feature-set": { + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Aggregate for the Product Feature Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductFeatureSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-keyword-dictionary": { + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Aggregate for the Product Keyword Dictionary resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductKeywordDictionary", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-manufacturer": { + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Aggregate for the Product Manufacturer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductManufacturer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-media": { + "post": { + "tags": [ + "Product Media" + ], + "summary": "Aggregate for the Product Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-price": { + "post": { + "tags": [ + "Product Price" + ], + "summary": "Aggregate for the Product Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-review": { + "post": { + "tags": [ + "Product Review" + ], + "summary": "Aggregate for the Product Review resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductReview", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-search-config": { + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Aggregate for the Product Search Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-search-config-field": { + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Aggregate for the Product Search Config Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-search-keyword": { + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Aggregate for the Product Search Keyword resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchKeyword", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Aggregate for the Product Sorting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSorting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-stream": { + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Aggregate for the Product Stream resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStream", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-stream-filter": { + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Aggregate for the Product Stream Filter resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-visibility": { + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Aggregate for the Product Visibility resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductVisibility", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion": { + "post": { + "tags": [ + "Promotion" + ], + "summary": "Aggregate for the Promotion resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-discount": { + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Aggregate for the Promotion Discount resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscount", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-discount-prices": { + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Aggregate for the Promotion Discount Prices resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscountPrices", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-individual-code": { + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Aggregate for the Promotion Individual Code resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionIndividualCode", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-sales-channel": { + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Aggregate for the Promotion Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-setgroup": { + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Aggregate for the Promotion Setgroup resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSetgroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/property-group": { + "post": { + "tags": [ + "Property Group" + ], + "summary": "Aggregate for the Property Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/property-group-option": { + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Aggregate for the Property Group Option resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroupOption", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/rule": { + "post": { + "tags": [ + "Rule" + ], + "summary": "Aggregate for the Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/rule-condition": { + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Aggregate for the Rule Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRuleCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel": { + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Aggregate for the Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-analytics": { + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Aggregate for the Sales Channel Analytics resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelAnalytics", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-domain": { + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Aggregate for the Sales Channel Domain resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelDomain", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-type": { + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Aggregate for the Sales Channel Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/salutation": { + "post": { + "tags": [ + "Salutation" + ], + "summary": "Aggregate for the Salutation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalutation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Aggregate for the Scheduled Task resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScheduledTask", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/script": { + "post": { + "tags": [ + "Script" + ], + "summary": "Aggregate for the Script resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScript", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/seo-url": { + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Aggregate for the Seo Url resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrl", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/seo-url-template": { + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Aggregate for the Seo Url Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrlTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/shipping-method": { + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Aggregate for the Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/shipping-method-price": { + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Aggregate for the Shipping Method Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethodPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Aggregate for the Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/snippet-set": { + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Aggregate for the Snippet Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippetSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Aggregate for the State Machine resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachine", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Aggregate for the State Machine History resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-state": { + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Aggregate for the State Machine State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-transition": { + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Aggregate for the State Machine Transition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineTransition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/system-config": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Aggregate for the System Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSystemConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/tag": { + "post": { + "tags": [ + "Tag" + ], + "summary": "Aggregate for the Tag resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTag", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/tax": { + "post": { + "tags": [ + "Tax" + ], + "summary": "Aggregate for the Tax resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTax", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/tax-provider": { + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Aggregate for the Tax Provider resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxProvider", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/tax-rule": { + "post": { + "tags": [ + "Tax Rule" + ], + "summary": "Aggregate for the Tax Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/tax-rule-type": { + "post": { + "tags": [ + "Tax Rule Type" + ], + "summary": "Aggregate for the Tax Rule Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRuleType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/theme": { + "post": { + "tags": [ + "Theme" + ], + "summary": "Aggregate for the Theme resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTheme", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/unit": { + "post": { + "tags": [ + "Unit" + ], + "summary": "Aggregate for the Unit resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUnit", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/user": { + "post": { + "tags": [ + "User" + ], + "summary": "Aggregate for the User resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUser", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/user-access-key": { + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Aggregate for the User Access Key resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/user-config": { + "post": { + "tags": [ + "User Config" + ], + "summary": "Aggregate for the User Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/user-recovery": { + "post": { + "tags": [ + "User Recovery" + ], + "summary": "Aggregate for the User Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserRecovery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRecovery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/webhook": { + "post": { + "tags": [ + "Webhook" + ], + "summary": "Aggregate for the Webhook resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhook", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Webhook", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "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" + } + } + } + }, + "/aggregate/webhook-event-log": { + "post": { + "tags": [ + "Webhook Event Log" + ], + "summary": "Aggregate for the Webhook Event Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhookEventLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of WebhookEventLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "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" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JoinAppointmentResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/start": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/end": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "End a presentation for a appointment", + "description": "Complete all needed data and remove unneeded to close the presentation", + "operationId": "endAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "" + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the sw-context-token for a attendee", + "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", + "operationId": "getAttendeeToken", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "The sw-context-token from the attendee", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "attendee-sw-context-token": { + "type": "string" + } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" + } + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/instant-listing": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "productIds" + ], + "properties": { + "productIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Created a new instant listing", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "index": { + "type": "integer", + "description": "The current index of the instant listing which is created by this request" + } + }, + "example": { + "index": 1 + } + } + } + } + } + } + }, + "patch": { + "tags": [ + "Appointment" + ], + "summary": "Update a instant listing from the presentation", + "description": "Updates the products for the given listing", + "operationId": "updateInstantListing", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], + "properties": { + "addProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "removeProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be removed to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Updated the instant listing", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the instant listing page" + }, + "pickedProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which are picked for the instant listing" + }, + "title": { + "type": "string", + "description": "The title of the instant listing" + } + }, + "example": { + "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", + "pickedProductIds": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ], + "title": "Default Digital Sales Rooms product listing page" + } + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/presentation/state": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GuidePresentationStateResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VideoChatCreateStruct" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Appointment" + ], + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": [] + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get attendee insights", + "description": "Get attendee insights for the given appointment", + "operationId": "getAttendeeInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get cart insights", + "description": "Get cart insights for the given appointment", + "operationId": "getCartInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/GetCartInsightsResponse" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get cart statistics", + "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", + "operationId": "getCartStatistics", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the cart line items", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the cart line items", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get last seen products insights", + "description": "Get last seen products of all attendees for the given appointment", + "operationId": "getLastSeenProductsInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the last seen products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "limit", + "in": "query", + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the wishlist products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" } }, "example": { @@ -4556,7 +16286,7 @@ } }, "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { - "post": { + "get": { "tags": [ "Appointment" ], @@ -4610,6 +16340,204 @@ } } } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Load a temporary cart for the attendee", + "description": "Load a temporary cart for the attendee", + "operationId": "loadTempCart", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "sw-context-token", + "in": "header", + "description": "Contains sw-context-token value", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Add discount to the temp cart", + "description": "Add discount to the temp cart", + "operationId": "addTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddTempDiscountRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Remove all discount from the temp cart", + "description": "Remove all discount from the temp cart", + "operationId": "removeTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Apply the discount from the temp cart to the attendee cart", + "description": "Apply the discount from the temp cart to the attendee cart", + "operationId": "applyTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Add discount to the attendee cart", + "description": "Add discount to the attendee cart", + "operationId": "addCartDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AddCartDiscountRequestBody" + } + } + } + }, + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Cart" + } + } + } + } + } + } } }, "components": { @@ -5289,6 +17217,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, "sourceType": { "type": "string" }, @@ -5791,6 +17722,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, "sourceType": { "type": "string" }, @@ -7334,6 +19268,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7410,6 +19347,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -8970,8 +20910,7 @@ "id", "position", "type", - "pageId", - "name" + "pageId" ], "properties": { "id": { @@ -8988,6 +20927,9 @@ "locked": { "type": "boolean" }, + "name": { + "type": "string" + }, "sizingMode": { "type": "string" }, @@ -9046,7 +20988,38 @@ "format": "date-time", "readOnly": true }, - "translated": { + "extensions": { + "properties": { + "dsrSlideExtension": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_cms_slide" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f7b1c34af8f346efae2c5862529520d8" + } + } + } + }, + "type": "object" + } + }, "type": "object" }, "relationships": { @@ -9154,8 +21127,7 @@ "id", "position", "type", - "pageId", - "name" + "pageId" ], "properties": { "id": { @@ -9172,6 +21144,9 @@ "locked": { "type": "boolean" }, + "name": { + "type": "string" + }, "sizingMode": { "type": "string" }, @@ -9230,7 +21205,38 @@ "format": "date-time", "readOnly": true }, - "translated": { + "extensions": { + "properties": { + "dsrSlideExtension": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_cms_slide" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f7b1c34af8f346efae2c5862529520d8" + } + } + } + }, + "type": "object" + } + }, "type": "object" }, "page": { @@ -11036,6 +23042,9 @@ "allowCartExpose": { "type": "boolean" }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11150,6 +23159,9 @@ "allowCartExpose": { "type": "boolean" }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11590,21 +23602,12 @@ "lastName": { "type": "string" }, - "company": { - "type": "string" - }, "email": { "type": "string" }, "title": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, "affiliateCode": { "type": "string" }, @@ -11684,9 +23687,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -11892,6 +23892,35 @@ }, "type": "object" }, + "activeBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } + } + }, + "type": "object" + }, "defaultShippingAddress": { "properties": { "links": { @@ -11921,6 +23950,35 @@ }, "type": "object" }, + "activeShippingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } + } + }, + "type": "object" + }, "salutation": { "properties": { "links": { @@ -12380,21 +24438,12 @@ "lastName": { "type": "string" }, - "company": { - "type": "string" - }, "email": { "type": "string" }, "title": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, "affiliateCode": { "type": "string" }, @@ -12474,9 +24523,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -12550,9 +24596,15 @@ "defaultBillingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, "defaultShippingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, "salutation": { "$ref": "#/components/schemas/Salutation" }, @@ -12683,6 +24735,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -12887,6 +24943,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -13834,10 +25894,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -13848,9 +25908,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -13863,6 +25920,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -13885,6 +25946,9 @@ "customFields": { "type": "object" }, + "fileType": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -14043,6 +26107,35 @@ } }, "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -14057,10 +26150,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -14071,9 +26164,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -14086,6 +26176,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -14108,6 +26202,9 @@ "customFields": { "type": "object" }, + "fileType": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -14135,6 +26232,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -15222,13 +27322,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "guideCartPermissionsGranted": { - "type": "boolean" - }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "employeeId": { + "type": "string" + }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -15443,13 +27543,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "guideCartPermissionsGranted": { - "type": "boolean" - }, "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "employeeId": { + "type": "string" + }, "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -15527,8 +27627,7 @@ "firstName", "lastName", "emailAddress", - "subject", - "requestedById" + "subject" ], "properties": { "id": { @@ -15716,8 +27815,7 @@ "firstName", "lastName", "emailAddress", - "subject", - "requestedById" + "subject" ], "properties": { "id": { @@ -16070,6 +28168,134 @@ }, "type": "object" }, + "DsrCmsSlideJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "slideName", + "cmsSectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "slideName": { + "type": "string" + }, + "cmsSectionId": { + "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 + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "cmsSection": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/dsr-cms-slide/35f9e2e1b6a51eabbee81458ba860d95/cmsSection" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "212545e6991db0675b783d4574ab20dc" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DsrCmsSlide": { + "required": [ + "id", + "slideName", + "cmsSectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "slideName": { + "type": "string" + }, + "cmsSectionId": { + "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 + }, + "translated": { + "type": "object" + }, + "cmsSection": { + "$ref": "#/components/schemas/CmsSection" + } + }, + "type": "object" + }, "DsrInteractionJsonApi": { "allOf": [ { @@ -20228,8 +32454,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -20241,8 +32466,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -20283,6 +32507,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -21101,8 +33328,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -21114,8 +33340,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -21156,6 +33381,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -24547,6 +36775,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -24793,6 +37025,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -30081,6 +42317,9 @@ } }, "type": "object" + }, + { + "$ref": "#/components/schemas/DiscountLineItemPayload" } ] }, @@ -34972,8 +47211,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -35131,8 +47369,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -44682,37 +56919,6 @@ }, "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" - }, "dsrAppointmentGuideUser": { "properties": { "links": { @@ -44898,6 +57104,37 @@ } }, "type": "object" + }, + "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" @@ -45375,7 +57612,7 @@ }, "extensions": { "properties": { - "createdNotifications": { + "dsrAppointmentGuideUser": { "properties": { "links": { "type": "object", @@ -45383,7 +57620,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/dsrAppointmentGuideUser" } } }, @@ -45394,11 +57631,11 @@ "properties": { "type": { "type": "string", - "example": "notification" + "example": "dsr_appointment" }, "id": { "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" + "example": "e8e8e4db862bed157007764e46f5aecb" } } } @@ -45406,7 +57643,7 @@ }, "type": "object" }, - "dsrAppointmentGuideUser": { + "createdPresentations": { "properties": { "links": { "type": "object", @@ -45414,7 +57651,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/dsrAppointmentGuideUser" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" } } }, @@ -45425,11 +57662,11 @@ "properties": { "type": { "type": "string", - "example": "dsr_appointment" + "example": "dsr_presentation" }, "id": { "type": "string", - "example": "e8e8e4db862bed157007764e46f5aecb" + "example": "d1e11035d87216918d95e78a7ac396da" } } } @@ -45437,7 +57674,7 @@ }, "type": "object" }, - "createdPresentations": { + "updatedPresentations": { "properties": { "links": { "type": "object", @@ -45445,7 +57682,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdPresentations" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" } } }, @@ -45460,7 +57697,7 @@ }, "id": { "type": "string", - "example": "d1e11035d87216918d95e78a7ac396da" + "example": "49fb9c4fad69d4a3da998a936016c88d" } } } @@ -45468,7 +57705,7 @@ }, "type": "object" }, - "updatedPresentations": { + "createdAppointments": { "properties": { "links": { "type": "object", @@ -45476,7 +57713,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedPresentations" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" } } }, @@ -45487,11 +57724,11 @@ "properties": { "type": { "type": "string", - "example": "dsr_presentation" + "example": "dsr_appointment" }, "id": { "type": "string", - "example": "49fb9c4fad69d4a3da998a936016c88d" + "example": "888e350c3c9a465bc4d7c8a80840b2aa" } } } @@ -45499,7 +57736,7 @@ }, "type": "object" }, - "createdAppointments": { + "updatedAppointments": { "properties": { "links": { "type": "object", @@ -45507,7 +57744,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAppointments" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" } } }, @@ -45522,7 +57759,7 @@ }, "id": { "type": "string", - "example": "888e350c3c9a465bc4d7c8a80840b2aa" + "example": "b64277a1e650794e2c57924c07825014" } } } @@ -45530,7 +57767,7 @@ }, "type": "object" }, - "updatedAppointments": { + "createdLayouts": { "properties": { "links": { "type": "object", @@ -45538,7 +57775,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAppointments" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" } } }, @@ -45549,11 +57786,11 @@ "properties": { "type": { "type": "string", - "example": "dsr_appointment" + "example": "cms_page" }, "id": { "type": "string", - "example": "b64277a1e650794e2c57924c07825014" + "example": "22b76a69d00feab60733ea096895a432" } } } @@ -45561,7 +57798,7 @@ }, "type": "object" }, - "createdLayouts": { + "createdNotifications": { "properties": { "links": { "type": "object", @@ -45569,7 +57806,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdLayouts" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" } } }, @@ -45580,11 +57817,11 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "notification" }, "id": { "type": "string", - "example": "22b76a69d00feab60733ea096895a432" + "example": "04f88ea12127fe03b65beffbc2c96954" } } } @@ -45689,18 +57926,377 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accessKey": { + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "secretAccessKey": { + "eventName": { "type": "string" }, - "lastUsageAt": { - "type": "string", - "format": "date-time" + "url": { + "type": "string" }, - "customFields": { - "type": "object" + "onlyLiveVersion": { + "type": "boolean" + }, + "errorCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -45714,7 +58310,7 @@ }, "relationships": { "properties": { - "user": { + "app": { "properties": { "links": { "type": "object", @@ -45722,7 +58318,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user-access-key/01614dd7e96bd79868128dca72e7eff8/user" + "example": "/webhook/150c7abfca6c489fee5cb82fbb7a9bc4/app" } } }, @@ -45731,12 +58327,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -45751,35 +58347,42 @@ } ] }, - "UserAccessKey": { - "description": "Added since version: 6.0.0.0", + "Webhook": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "userId", - "accessKey", - "secretAccessKey" + "name", + "eventName", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "accessKey": { + "eventName": { "type": "string" }, - "secretAccessKey": { + "url": { "type": "string" }, - "lastUsageAt": { - "type": "string", - "format": "date-time" + "onlyLiveVersion": { + "type": "boolean" }, - "customFields": { - "type": "object" + "errorCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "type": "boolean" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -45791,14 +58394,14 @@ "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "UserConfigJsonApi": { - "description": "Added since version: 6.3.5.0", + "WebhookEventLogJsonApi": { + "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -45806,22 +58409,59 @@ { "required": [ "id", - "userId", - "key" + "webhookName", + "eventName", + "deliveryStatus", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "appName": { + "type": "string" }, - "key": { + "webhookName": { "type": "string" }, - "value": { + "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": { @@ -45833,66 +58473,69 @@ "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", + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", "required": [ "id", - "userId", - "key" + "webhookName", + "eventName", + "deliveryStatus", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "appName": { + "type": "string" }, - "key": { + "webhookName": { "type": "string" }, - "value": { + "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": { @@ -45904,477 +58547,702 @@ "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" + "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": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "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": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "associations": { + "$ref": "#/components/schemas/Associations" + }, + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + }, + "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" + ] + }, + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } }, + "includes": { + "$ref": "#/components/schemas/Includes" + } + } + }, + "Includes": { + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "anyOf": [ { - "required": [ - "id", - "hash", - "userId" - ], + "type": "object", "properties": { - "id": { + "type": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] }, - "hash": { + "field": { "type": "string" }, - "userId": { + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + { + "type": "object", + "properties": { + "type": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "equalsAny", + "equalsAll" + ] }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "field": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "value": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type", + "field", + "value" + ] + } + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" }, - "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": "number" + }, + { + "type": "boolean" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "type", + "field", + "value" + ] + }, + "MultiNotFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "multi", + "not" + ] + }, + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] + }, + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] + }, + "field": { + "type": "string" + }, + "parameters": { + "type": "object", + "properties": { + "gte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "gt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" } - }, - "type": "object" + ] + }, + "lt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] } - }, - "type": "object" + } } + }, + "required": [ + "type", + "field", + "parameters" ] }, - "UserRecovery": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "hash", - "userId" - ], + "Sort": { + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "hash": { + "field": { "type": "string" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { + "order": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "ASC", + "DESC" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "naturalSorting": { + "type": "boolean" }, - "user": { - "$ref": "#/components/schemas/User" + "type": { + "type": "string" } }, - "type": "object" + "required": [ + "field", + "order" + ] }, - "WebhookJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Aggregation": { + "anyOf": [ { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/AggregationMetrics" }, { - "required": [ - "id", - "name", - "eventName", - "url" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" }, - "name": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" }, - "eventName": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "url": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "onlyLiveVersion": { - "type": "boolean" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" }, - "errorCount": { - "type": "integer", - "format": "int64", - "readOnly": true + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "active": { - "type": "boolean" + { + "$ref": "#/components/schemas/AggregationEntity" }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + { + "$ref": "#/components/schemas/AggregationFilter" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "$ref": "#/components/schemas/AggregationTerms" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "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" + { + "$ref": "#/components/schemas/AggregationRange" } - }, - "type": "object" + ] } - ] + } }, - "Webhook": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "name", - "eventName", - "url" - ], + "AggregationEntity": { + "title": "AggregationEntity", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "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": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "entity" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "app": { - "$ref": "#/components/schemas/App" + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", + "type": "string" } }, - "type": "object" + "required": [ + "name", + "type", + "field", + "definition" + ] }, - "WebhookEventLogJsonApi": { - "description": "Added since version: 6.4.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "AggregationFilter": { + "title": "AggregationFilter", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - { - "required": [ - "id", - "webhookName", - "eventName", - "deliveryStatus", - "url" - ], - "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" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "filter" + ] + }, + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } } + }, + "required": [ + "name", + "type", + "filter" ] }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.0", - "required": [ - "id", - "webhookName", - "eventName", - "deliveryStatus", - "url" - ], + "AggregationTerms": { + "title": "AggregationTerms", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "webhookName": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "eventName": { - "type": "string" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "terms" + ] }, - "deliveryStatus": { + "field": { + "description": "The field you want to aggregate over.", "type": "string" }, - "timestamp": { - "type": "integer", - "format": "int64" - }, - "processingTime": { - "type": "integer", - "format": "int64" + "limit": { + "description": "The number of terms to return", + "type": "number" }, - "appVersion": { + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "requestContent": { - "type": "object" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "histogram" + ] }, - "responseContent": { - "type": "object" + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "responseStatusCode": { - "type": "integer", - "format": "int64" + "interval": { + "description": "The interval of the histogram", + "type": "number" }, - "responseReasonPhrase": { + "format": { + "description": "The format of the histogram", "type": "string" }, - "url": { + "timeZone": { + "description": "The timezone of the histogram", "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" + "required": [ + "name", + "type", + "field" + ] }, - "infoConfigResponse": { + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", "type": "object", "properties": { - "version": { - "type": "string", - "description": "The Shopware version." + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "versionRevision": { + "type": { + "description": "The type of aggregation", "type": "string", - "description": "The Shopware version revision." + "enum": [ + "range" + ] }, - "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" - } - } - } + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "bundles": { - "type": "object", - "description": "Asset files of active extensions", - "additionalProperties": { + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { "type": "object", - "properties": { - "css": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the css file." - } + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the js file." - } + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] } - } + ] } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "settings": { - "type": "object", - "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." - } - } + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" } - } + }, + "required": [ + "name", + "type", + "field" + ] }, "Price": { "type": "object", @@ -46455,61 +59323,63 @@ "net" ] }, - "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" + "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." }, - "description": "Extensions data of event" + "transports": { + "type": "array", + "description": "Configured transports.", + "items": { + "type": "string" + } + } } - } - } - }, - "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": { + }, + "bundles": { + "type": "object", + "description": "Asset files of active extensions", + "additionalProperties": { "type": "object", - "description": "Available data of event" - }, - "aware": { - "type": "array", - "description": "Flow builder will base on awareness to show actions", - "items": { - "type": "string" + "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." + } + } } - }, - "extensions": { - "type": "array", - "description": "Extensions data of event", - "items": { - "type": "string" + } + }, + "settings": { + "type": "object", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the `urlFeature` setting." } } } @@ -46639,617 +59509,1118 @@ } ] }, - "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" - } + "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" }, - "required": [ - "field" - ] + "description": "Extensions data of event" } - }, - "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": { + } + } + }, + "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", - "properties": { - "type": { - "type": "string" - }, - "field": { - "type": "string" - }, - "value": { - "type": "string" - } - }, - "required": [ - "type", - "field", - "value" - ] + "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" + } } + } + } + }, + "GetListBodyRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" }, - "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" - ] - } + "page": { + "type": "integer", + "description": "The page to be returned" + } + } + }, + "DiscountType": { + "type": "string", + "description": "Type of the discount", + "enum": [ + "percentage", + "absolute" + ] + }, + "AddTempDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue", + "appliedItemIds" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" - } + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 }, - "fields": { + "appliedItemIds": { "type": "array", - "description": "Fields which should be returned in the search result.", "items": { "type": "string", - "description": "Name of a field" - } + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the items to which the discount should be applied" + } + } + }, + "AddCartDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "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" - ] + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 } } }, - "GuidePresentationStateResponse": { + "AttendeeInsights": { "type": "object", + "description": "Attendee Insights", "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" + }, + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" } }, "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "allowUserActionsForGuide": true, - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "guideCartPermissionsGranted": true, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "guideCartPermissionsGranted": false, - "hasJoined": true - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 } } }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true } - ] + } }, - "CartDelivery": { + "WidgetProductListing": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } - }, - "location": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "state": { - "$ref": "#/components/schemas/CountryState" - } - } + "extensions": { + "type": "array", + "description": "List of extensions", + "default": [] }, - "positions": { + "products": { "type": "array", + "description": "List of last seen products", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" + "allOf": [ + { + "$ref": "#/components/schemas/Product" + }, + { + "type": "object", + "properties": { + "customFields": { + "type": "object", + "properties": { + "wishlistAttendeeIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] } }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "total": { + "type": "integer", + "description": "The total number of products" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "page": { + "type": "integer", + "description": "The current page" + }, + "limit": { + "type": "integer", + "description": "The number of products per page" } } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity" - ] - }, - "LineItem": { + "VideoChatCreateStruct": { "type": "object", + "description": "Includes all data you will need to attend to a appointment.", "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" }, - "good": { - "type": "boolean" + "roomName": { + "type": "string", + "description": "Name of the video room in daily" }, - "id": { - "type": "string" + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" }, - "label": { - "type": "string" + "ownerToken": { + "type": "string", + "description": "Token for the room owner (guide) to connect to the daily room" + } + }, + "example": { + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "dummy user token", + "ownerToken": "dummy owner token", + "roomName": "rSq20mrgwsj4eIXo1u95", + "extensions": [] + } + }, + "GetCartInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current carts within the appointment.", + "properties": { + "cartSum": { + "type": "number", + "description": "Sum of all products from all attenddees which were added to the cart during the appointment" }, - "modified": { - "type": "boolean" + "productCount": { + "type": "number", + "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" }, - "modifiedByApp": { - "type": "boolean" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the shown currency" }, - "payload": { - "$ref": "#/components/schemas/ProductJsonApi" + "currencySymbol": { + "type": "string", + "description": "The currency symbol from the shown currency" }, - "price": { + "topProducts": { "type": "object", + "required": [ + "byQuantity", + "byRevenue" + ], "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { + "byQuantity": { "type": "array", + "uniqueItems": true, "items": { "type": "object", "properties": { - "apiAlias": { + "productId": { "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" }, - "price": { - "type": "number" + "value": { + "type": "number", + "description": "The quantity in carts of this product" } }, "required": [ - "apiAlias", - "tax", - "taxRate", - "price" + "productId", + "value" ] } }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" - }, - "taxRules": { + "byRevenue": { "type": "array", - "description": "Currently active tax rules and/or rates", + "uniqueItems": true, "items": { "type": "object", "properties": { - "taxRate": { - "type": "number", - "format": "float" + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id from the product" }, - "name": { - "type": "string" + "value": { + "type": "number", + "description": "The net revenue in the shown currency in carts of this product" } - } + }, + "required": [ + "productId", + "value" + ] } } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" + } + } + }, + "example": { + "extensions": [], + "cartSum": 6770.53, + "productCount": 3, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$", + "topProducts": { + "byQuantity": [ + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1 + }, + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 1 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 1 + } + ], + "byRevenue": [ + { + "productId": "fee3ca762be94bb49b692e359d529563", + "value": 5333.03 + }, + { + "productId": "01ae0dee60ea48fdafaf881b96361d59", + "value": 1152.62 + }, + { + "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", + "value": 284.88 + } + ] + } + } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "CartPriceQuantity": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" ] }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" + "isCalculated": { + "type": "boolean" + }, + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" + }, + "price": { + "type": "number" }, "quantity": { "type": "number" }, - "quantityInformation": { - "type": "object", + "regulationPrice": { "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "taxRules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } } } }, - "referencedId": { + "type": { "type": "string" + } + }, + "required": [ + "apiAlias" + ] + }, + "BasePresentationSlideData": { + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "removable": { - "type": "boolean" + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + } + } + } + }, + "PresentationSlideData": { + "type": "object", + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "stackable": { - "type": "boolean" + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + } }, - "states": { + "product": { + "$ref": "#/components/schemas/Product" + }, + "category": { + "$ref": "#/components/schemas/Category" + }, + "configurator": { "type": "array", "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] + "$ref": "#/components/schemas/PropertyGroup" + } + } + }, + "example": { + "extensions": { + "cmsPageRelation": { + "translated": { + "title": null + }, + "createdAt": "2023-08-09T11:00:13.160+00:00", + "updatedAt": null, + "presentationId": "506cce706e914c1e8b083f05670d85c4", + "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "title": null, + "productId": null, + "productStreamId": null, + "position": 2, + "isInstantListing": false, + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ + { + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": null, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" + } + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" + }, + "pickedProductIds": null, + "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", + "id": "4ee08e142ed046eb99681594f67599f1", + "customFields": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "apiAlias": "dsr_presentation_cms_page" } }, - "type": { - "$ref": "#/components/schemas/LineItemType" + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ + { + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": { + "listing": { + "elements": [ + { + "versionId": null, + "translated": [], + "createdAt": null, + "updatedAt": null, + "parentId": null, + "childCount": null, + "taxId": null, + "manufacturerId": null, + "unitId": null, + "active": null, + "displayGroup": null, + "manufacturerNumber": null, + "ean": null, + "sales": null, + "productNumber": null, + "stock": null, + "availableStock": null, + "available": null, + "deliveryTimeId": null, + "deliveryTime": null, + "restockTime": null, + "isCloseout": null, + "purchaseSteps": null, + "maxPurchase": null, + "minPurchase": null, + "purchaseUnit": null, + "referenceUnit": null, + "shippingFree": null, + "markAsTopseller": null, + "weight": null, + "width": null, + "height": null, + "length": null, + "releaseDate": null, + "categoryTree": null, + "streamIds": null, + "optionIds": null, + "propertyIds": null, + "name": null, + "keywords": null, + "description": null, + "metaDescription": null, + "metaTitle": null, + "packUnit": null, + "packUnitPlural": null, + "tax": null, + "manufacturer": null, + "unit": null, + "cover": null, + "parent": null, + "children": null, + "media": null, + "cmsPageId": null, + "cmsPage": null, + "translations": null, + "categories": null, + "properties": null, + "options": null, + "configuratorSettings": null, + "categoriesRo": null, + "coverId": null, + "categoryIds": null, + "productReviews": null, + "ratingAverage": null, + "mainCategories": null, + "seoUrls": null, + "crossSellings": null, + "canonicalProductId": null, + "canonicalProduct": null, + "streams": null, + "downloads": null, + "states": [], + "id": "a32702bb0b1443e3881c3b9a38c09169", + "customFields": null, + "apiAlias": "product" + } + ], + "aggregations": [], + "page": 1, + "limit": null, + "entity": "product", + "total": 0, + "states": [], + "apiAlias": "dal_entity_search_result" + }, + "apiAlias": "cms_product_listing" + }, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" + } + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" }, - "uniqueIdentifier": { + "category": { + "versionId": null, + "translated": { + "breadcrumb": [] + }, + "createdAt": null, + "updatedAt": null, + "afterCategoryId": null, + "parentId": null, + "mediaId": null, + "name": null, + "breadcrumb": [], + "path": null, + "level": null, + "active": null, + "childCount": null, + "visibleChildCount": 0, + "displayNestedProducts": null, + "parent": null, + "children": null, + "translations": null, + "media": null, + "cmsPageId": null, + "cmsPageIdSwitched": false, + "cmsPage": null, + "linkType": null, + "linkNewTab": null, + "internalLink": null, + "externalLink": null, + "visible": null, + "type": null, + "productAssignmentType": null, + "description": null, + "metaTitle": null, + "metaDescription": null, + "keywords": null, + "seoUrls": null, + "customEntityTypeId": null, + "id": "34f21c5eb6d54a939f10973204aa5f08", + "customFields": null, + "apiAlias": "category" + }, + "apiAlias": "pwa_page_result" + } + }, + "GetAttendeeInsightsResponse": { + "type": "object", + "description": "Returns aggregations for the current attendees within the appointment.", + "properties": { + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" + } + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencySymbol": { "type": "string" } }, - "required": [ - "id", - "type" - ] + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + }, + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" + } }, - "CartDeliveryInformation": { + "CalculatedPrice": { "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_information" - ] + "unitPrice": { + "type": "number" }, - "freeDelivery": { - "type": "boolean" + "quantity": { + "type": "number" }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" + "rawTotal": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } }, - "min": { - "type": "integer" + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" }, - "max": { - "type": "integer" + { + "type": "null" + } + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" }, - "unit": { - "type": "string" + { + "type": "null" + } + ] + }, + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" }, "apiAlias": { "type": "string", "enum": [ - "cart_delivery_time" + "cart_regulation_price" ] } - } - }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" + }, + "nullable": true }, - "restockTime": { - "type": "integer" + "hasRange": { + "type": "boolean" }, - "stock": { - "type": "integer" + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true }, - "weight": { - "type": "integer" + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] }, - "width": { - "type": "integer" + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } } }, "required": [ - "apiAlias" + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" ] }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" }, - "opened": { - "type": "boolean", - "default": true - } - } - }, - "GetAttendeeInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", - "properties": { - "attendees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AttendeeInsights" + { + "type": "object", + "properties": { + "pickedProductIds": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } + }, + { + "type": "null" + } + ], + "description": "The product id is assigned to presentation if it's product listing or instant listing" + } } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencySymbol": { - "type": "string" } - }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } + ] }, "Cart": { "type": "object", @@ -47320,173 +60691,6 @@ } } }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" - }, - "percentage": { - "type": "number" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_list_price" - ] - } - }, - "required": [ - "apiAlias" - ] - }, - "GetCartInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current carts within the appointment.", - "properties": { - "cartSum": { - "type": "number", - "description": "Sum of all products from all attenddees which were added to the cart during the appointment" - }, - "productCount": { - "type": "number", - "description": "Sum of all product quantities from all attendees which were added to the cart during the appointment" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the shown currency" - }, - "currencySymbol": { - "type": "string", - "description": "The currency symbol from the shown currency" - }, - "topProducts": { - "type": "object", - "required": [ - "byQuantity", - "byRevenue" - ], - "properties": { - "byQuantity": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The quantity in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] - } - }, - "byRevenue": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "object", - "properties": { - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id from the product" - }, - "value": { - "type": "number", - "description": "The net revenue in the shown currency in carts of this product" - } - }, - "required": [ - "productId", - "value" - ] - } - } - } - } - }, - "example": { - "extensions": [], - "cartSum": 6770.53, - "productCount": 3, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$", - "topProducts": { - "byQuantity": [ - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1 - }, - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 1 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 1 - } - ], - "byRevenue": [ - { - "productId": "fee3ca762be94bb49b692e359d529563", - "value": 5333.03 - }, - { - "productId": "01ae0dee60ea48fdafaf881b96361d59", - "value": 1152.62 - }, - { - "productId": "a31b4e64efe047b6844cb4dd5a1ce0da", - "value": 284.88 - } - ] - } - } - }, - "WidgetProductListing": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "extensions": { - "type": "array", - "description": "List of extensions", - "default": [] - }, - "products": { - "type": "array", - "description": "List of last seen products", - "items": { - "$ref": "#/components/schemas/Product" - } - }, - "total": { - "type": "integer", - "description": "The total number of products" - }, - "page": { - "type": "integer", - "description": "The current page" - }, - "limit": { - "type": "integer", - "description": "The number of products per page" - } - } - }, "JoinAppointmentResponse": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", @@ -47550,7 +60754,7 @@ }, "newContextToken": { "type": "string", - "description": "The new context token" + "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" }, "attendeeId": { "type": "string", @@ -47606,7 +60810,13 @@ }, "b2bFeatures": { "type": "object", - "description": "The b2b features that available for the appointment" + "description": "The b2b features that available for the appointment", + "properties": { + "quoteManagement": { + "type": "boolean", + "description": "To know if the quote management is enabled for current customer" + } + } } }, "example": { @@ -47636,258 +60846,63 @@ "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" } }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" - }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" - }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" - } - }, - "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - } - }, - "PresentationCmsPage": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation cms page id" - }, - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ], - "description": "The title of presentation cms page" - }, - "presentationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The presentation using this presentation cms page" - }, - "dsrPresentationVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "cmsPageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page id the presentation using" - }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The CMS page version id the presentation using" - }, - "productId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product detail" - }, - "productStreamId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ], - "description": "The product stream id is assigned to presentation if it's product listing" - }, - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } - }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" - }, - "position": { - "type": "integer", - "description": "The position of slide" - }, - "isInstantListing": { - "type": "boolean", - "description": "True if this slide is an instant listing" - }, - "createdAt": { - "type": "string", - "format": "date-time" - }, - "updatedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "customFields": { - "anyOf": [ - { - "type": "object" - }, - { - "type": "null" - } - ] - }, - "translated": { - "type": "object", - "properties": { - "title": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - } - } - } - }, - "CartPriceReference": { - "type": "object", - "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] - }, - "CartDeliveryPosition": { + "CartDeliveryInformation": { "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "deliveryDate": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] + }, + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { "type": "object", "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "name": { + "type": "string" }, - "latest": { + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { "type": "string", - "format": "date-time" + "enum": [ + "cart_delivery_time" + ] } } }, - "identifier": { - "type": "string" + "height": { + "type": "integer" }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "length": { + "type": "integer" }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" } - } + }, + "required": [ + "apiAlias" + ] }, "CartError": { "type": "object", @@ -47918,291 +60933,306 @@ } } }, - "VideoChatCreateStruct": { + "CartItems": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity", + "dsr-line-item-discount", + "dsr-cart-discount" + ] + }, + "DiscountLineItemPayload": { + "type": "object", + "properties": { + "discountType": { "type": "string", - "description": "Name of the video room in daily" + "enum": [ + "percentage", + "absolute" + ] }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 } - }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] } }, - "CalculatedPrice": { + "LineItem": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "unitPrice": { - "type": "number" + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "quantity": { - "type": "number" + "cover": { + "$ref": "#/components/schemas/ProductMedia" }, - "rawTotal": { - "type": "number" + "dataContextHash": { + "type": "string" }, - "totalPrice": { - "type": "number" + "dataTimestamp": { + "type": "string" }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } - }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, - { - "type": "null" - } - ] + "description": { + "type": "string" }, - "listPrice": { - "oneOf": [ + "good": { + "type": "boolean" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "allOf": [ { - "$ref": "#/components/schemas/CartListPrice" + "$ref": "#/components/schemas/ProductJsonApi" }, { - "type": "null" + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] + }, + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } } ] }, - "positionPrice": { - "type": "number" - }, - "netPrice": { - "type": "number" + "extensions": { + "type": "object", + "properties": { + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } + } + } }, - "regulationPrice": { + "price": { "type": "object", "properties": { - "price": { - "type": "number" - }, "apiAlias": { "type": "string", "enum": [ - "cart_regulation_price" + "calculated_price" ] - } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" + }, + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "quantity": { + "type": "number" + }, + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } }, - "name": { - "type": "string" + "nullable": true + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } } } - } - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] - }, - "StateForGuides": { - "type": "object", - "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" }, - "default": [] + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] }, - "inactiveClients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" }, - "guides": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "quantity": { + "type": "number" }, - "videoGuideToken": { - "anyOf": [ - { - "type": "string" + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" }, - { - "type": "null" + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + } }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "CartPriceQuantity": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_quantity" - ] + "referencedId": { + "type": "string" }, - "isCalculated": { + "removable": { "type": "boolean" }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" + "stackable": { + "type": "boolean" }, - "taxRules": { + "states": { "type": "array", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] } }, "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { "type": "string" } }, "required": [ - "apiAlias" + "id", + "type" ] }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" - } - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - } - } - }, "StateForAll": { "type": "object", "properties": { @@ -48391,10 +61421,6 @@ } ] }, - "allowUserActionsForGuide": { - "type": "boolean", - "default": false - }, "broadcastMode": { "type": "boolean", "default": false @@ -48417,6 +61443,314 @@ "default": [] } } + }, + "GuidePresentationStateResponse": { + "type": "object", + "properties": { + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" + }, + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" + } + }, + "example": { + "extensions": [], + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "broadcastMode": false, + "extensions": [] + }, + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false + }, + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "hasJoined": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "hasJoined": false + } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + } + } + }, + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "quickViewState": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "extensions": { + "type": "array", + "default": [] + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" + }, + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDeliveryPosition" + } + }, + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_list_price" + ] + } + }, + "required": [ + "apiAlias" + ] + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } } }, "responses": { @@ -48779,7 +62113,7 @@ "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", - "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { @@ -48938,6 +62272,10 @@ "name": "Dsr Attendee Product Collection", "description": "The endpoint for operations on Dsr Attendee Product Collection" }, + { + "name": "Dsr Cms Slide", + "description": "The endpoint for operations on Dsr Cms Slide" + }, { "name": "Dsr Interaction", "description": "The endpoint for operations on Dsr Interaction" diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index d469189..6ad9b40 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -1,7 +1,12 @@ { "paths": [ + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount", + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount", + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount", "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids", + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart", "/_action/dsr/appointment/attendee/{attendeeId}/remove", + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount", "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token", "/_action/dsr/appointment/{appointmentId}/end", "/_action/dsr/appointment/{appointmentId}/instant-listing", @@ -12,8 +17,152 @@ "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights", "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights", "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen", - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist", + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", + "/aggregate/acl-role", + "/aggregate/app", + "/aggregate/app-action-button", + "/aggregate/app-administration-snippet", + "/aggregate/app-cms-block", + "/aggregate/app-flow-action", + "/aggregate/app-flow-event", + "/aggregate/app-payment-method", + "/aggregate/app-script-condition", + "/aggregate/app-shipping-method", + "/aggregate/app-template", + "/aggregate/category", + "/aggregate/cms-block", + "/aggregate/cms-page", + "/aggregate/cms-section", + "/aggregate/cms-slot", + "/aggregate/country", + "/aggregate/country-state", + "/aggregate/currency", + "/aggregate/currency-country-rounding", + "/aggregate/custom-entity", + "/aggregate/custom-field", + "/aggregate/custom-field-set", + "/aggregate/custom-field-set-relation", + "/aggregate/customer", + "/aggregate/customer-address", + "/aggregate/customer-group", + "/aggregate/customer-recovery", + "/aggregate/customer-wishlist", + "/aggregate/customer-wishlist-product", + "/aggregate/delivery-time", + "/aggregate/document", + "/aggregate/document-base-config", + "/aggregate/document-base-config-sales-channel", + "/aggregate/document-type", + "/aggregate/dsr-appointment", + "/aggregate/dsr-appointment-attendee", + "/aggregate/dsr-appointment-request", + "/aggregate/dsr-appointment-video-chat", + "/aggregate/dsr-attendee-product-collection", + "/aggregate/dsr-cms-slide", + "/aggregate/dsr-interaction", + "/aggregate/dsr-presentation", + "/aggregate/dsr-presentation-cms-page", + "/aggregate/flow", + "/aggregate/flow-sequence", + "/aggregate/flow-template", + "/aggregate/import-export-file", + "/aggregate/import-export-log", + "/aggregate/import-export-profile", + "/aggregate/integration", + "/aggregate/landing-page", + "/aggregate/language", + "/aggregate/locale", + "/aggregate/log-entry", + "/aggregate/mail-header-footer", + "/aggregate/mail-template", + "/aggregate/mail-template-type", + "/aggregate/main-category", + "/aggregate/media", + "/aggregate/media-default-folder", + "/aggregate/media-folder", + "/aggregate/media-folder-configuration", + "/aggregate/media-thumbnail", + "/aggregate/media-thumbnail-size", + "/aggregate/newsletter-recipient", + "/aggregate/notification", + "/aggregate/number-range", + "/aggregate/number-range-sales-channel", + "/aggregate/number-range-state", + "/aggregate/number-range-type", + "/aggregate/order", + "/aggregate/order-address", + "/aggregate/order-customer", + "/aggregate/order-delivery", + "/aggregate/order-delivery-position", + "/aggregate/order-line-item", + "/aggregate/order-line-item-download", + "/aggregate/order-transaction", + "/aggregate/order-transaction-capture", + "/aggregate/order-transaction-capture-refund", + "/aggregate/order-transaction-capture-refund-position", + "/aggregate/payment-method", + "/aggregate/plugin", + "/aggregate/product", + "/aggregate/product-configurator-setting", + "/aggregate/product-cross-selling", + "/aggregate/product-cross-selling-assigned-products", + "/aggregate/product-download", + "/aggregate/product-export", + "/aggregate/product-feature-set", + "/aggregate/product-keyword-dictionary", + "/aggregate/product-manufacturer", + "/aggregate/product-media", + "/aggregate/product-price", + "/aggregate/product-review", + "/aggregate/product-search-config", + "/aggregate/product-search-config-field", + "/aggregate/product-search-keyword", + "/aggregate/product-sorting", + "/aggregate/product-stream", + "/aggregate/product-stream-filter", + "/aggregate/product-visibility", + "/aggregate/promotion", + "/aggregate/promotion-discount", + "/aggregate/promotion-discount-prices", + "/aggregate/promotion-individual-code", + "/aggregate/promotion-sales-channel", + "/aggregate/promotion-setgroup", + "/aggregate/property-group", + "/aggregate/property-group-option", + "/aggregate/rule", + "/aggregate/rule-condition", + "/aggregate/sales-channel", + "/aggregate/sales-channel-analytics", + "/aggregate/sales-channel-domain", + "/aggregate/sales-channel-type", + "/aggregate/salutation", + "/aggregate/scheduled-task", + "/aggregate/script", + "/aggregate/seo-url", + "/aggregate/seo-url-template", + "/aggregate/shipping-method", + "/aggregate/shipping-method-price", + "/aggregate/snippet", + "/aggregate/snippet-set", + "/aggregate/state-machine", + "/aggregate/state-machine-history", + "/aggregate/state-machine-state", + "/aggregate/state-machine-transition", + "/aggregate/system-config", + "/aggregate/tag", + "/aggregate/tax", + "/aggregate/tax-provider", + "/aggregate/tax-rule", + "/aggregate/tax-rule-type", + "/aggregate/theme", + "/aggregate/unit", + "/aggregate/user", + "/aggregate/user-access-key", + "/aggregate/user-config", + "/aggregate/user-recovery", + "/aggregate/webhook", + "/aggregate/webhook-event-log", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -24,6 +173,8 @@ "/dsr-appointment/{id}", "/dsr-attendee-product-collection", "/dsr-attendee-product-collection/{id}", + "/dsr-cms-slide", + "/dsr-cms-slide/{id}", "/dsr-interaction", "/dsr-interaction/{id}", "/dsr-presentation", @@ -35,6 +186,7 @@ "/search/dsr-appointment-request", "/search/dsr-appointment-video-chat", "/search/dsr-attendee-product-collection", + "/search/dsr-cms-slide", "/search/dsr-interaction", "/search/dsr-presentation", "/search/dsr-presentation-cms-page" @@ -44,6 +196,15 @@ "AclRole", "AclRoleJsonApi", "AclUserRole", + "AddCartDiscountRequestBody", + "AddTempDiscountRequestBody", + "Aggregation", + "AggregationEntity", + "AggregationFilter", + "AggregationHistogram", + "AggregationMetrics", + "AggregationRange", + "AggregationTerms", "App", "AppActionButton", "AppActionButtonJsonApi", @@ -64,7 +225,9 @@ "AppShippingMethodJsonApi", "AppTemplate", "AppTemplateJsonApi", + "Associations", "AttendeeInsights", + "BasePresentationSlideData", "CalculatedPrice", "Cart", "CartDelivery", @@ -119,6 +282,8 @@ "CustomerWishlistProductJsonApi", "DeliveryTime", "DeliveryTimeJsonApi", + "DiscountLineItemPayload", + "DiscountType", "Document", "DocumentBaseConfig", "DocumentBaseConfigJsonApi", @@ -137,6 +302,8 @@ "DsrAppointmentVideoChatJsonApi", "DsrAttendeeProductCollection", "DsrAttendeeProductCollectionJsonApi", + "DsrCmsSlide", + "DsrCmsSlideJsonApi", "DsrInteraction", "DsrInteractionJsonApi", "DsrPresentation", @@ -144,6 +311,8 @@ "DsrPresentationCmsPageJsonApi", "DsrPresentationJsonApi", "DynamicPageOpenedPayload", + "EqualsFilter", + "Filters", "Flow", "FlowJsonApi", "FlowSequence", @@ -160,6 +329,7 @@ "ImportExportLogJsonApi", "ImportExportProfile", "ImportExportProfileJsonApi", + "Includes", "Integration", "IntegrationJsonApi", "IntegrationRole", @@ -199,6 +369,7 @@ "MediaThumbnailJsonApi", "MediaThumbnailSize", "MediaThumbnailSizeJsonApi", + "MultiNotFilter", "NewsletterRecipient", "NewsletterRecipientJsonApi", "NewsletterRecipientTag", @@ -245,6 +416,7 @@ "Plugin", "PluginJsonApi", "PresentationCmsPage", + "PresentationSlideData", "Price", "Product", "ProductCategory", @@ -313,6 +485,7 @@ "PropertyGroupJsonApi", "PropertyGroupOption", "PropertyGroupOptionJsonApi", + "RangeFilter", "Rule", "RuleCondition", "RuleConditionJsonApi", @@ -346,10 +519,12 @@ "ShippingMethodPrice", "ShippingMethodPriceJsonApi", "ShippingMethodTag", + "SimpleFilter", "Snippet", "SnippetJsonApi", "SnippetSet", "SnippetSetJsonApi", + "Sort", "StateForAll", "StateForGuides", "StateMachine", @@ -360,6 +535,7 @@ "StateMachineStateJsonApi", "StateMachineTransition", "StateMachineTransitionJsonApi", + "SubAggregations", "SystemConfig", "SystemConfigJsonApi", "Tag", From 058f61e610a9b89c15b70bfb58d60f75eb4f7896 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 7 May 2025 10:03:17 +0200 Subject: [PATCH 40/63] [create-pull-request] automated change (#356) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 14842 +++++++++++++++-- SwagCustomizedProducts-adminapi.summary.json | 145 + 2 files changed, 13421 insertions(+), 1566 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index a44c1ce..ea8674c 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.6.9.0" + "version": "6.6.10.4" }, "servers": [ { @@ -15,43 +15,38 @@ } ], "paths": { - "/swag-customized-products-template": { - "get": { + "/aggregate/acl-role": { + "post": { "tags": [ - "Swag Customized Products Template" + "Acl Role" ], - "summary": "List with basic information of Swag Customized Products Template resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Acl Role resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAclRole", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Swag Customized Products Template resources.", + "description": "List of AclRole", "content": { "application/vnd.api+json": { "schema": { @@ -63,41 +58,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template?limit=25" - }, - "last": { - "example": "/swag-customized-products-template?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } } } } @@ -114,7 +78,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AclRole" } } } @@ -122,44 +86,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/app": { "post": { "tags": [ - "Swag Customized Products Template" - ], - "summary": "Create a new Swag Customized Products Template resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App" ], + "summary": "Aggregate for the App resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateApp", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "List of App", "content": { "application/vnd.api+json": { "schema": { @@ -171,7 +138,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -181,12 +151,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } } } } @@ -202,27 +175,38 @@ } } }, - "/search/swag-customized-products-template": { + "/aggregate/app-action-button": { "post": { "tags": [ - "Swag Customized Products Template" + "App Action Button" ], - "summary": "Search for the Swag Customized Products Template resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplate", + "summary": "Aggregate for the App Action Button resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppActionButton", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplate", + "description": "List of AppActionButton", "content": { "application/vnd.api+json": { "schema": { @@ -236,7 +220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppActionButton" } } } @@ -254,7 +238,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "$ref": "#/components/schemas/AppActionButton" } } } @@ -271,29 +255,38 @@ } } }, - "/swag-customized-products-template/{id}": { - "get": { + "/aggregate/app-administration-snippet": { + "post": { "tags": [ - "Swag Customized Products Template" + "App Administration Snippet" ], - "summary": "Detailed information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the App Administration Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppAdministrationSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "List of AppAdministrationSnippet", "content": { "application/vnd.api+json": { "schema": { @@ -305,7 +298,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } @@ -315,107 +311,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "Delete a Swag Customized Products Template resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/app-cms-block": { + "post": { "tags": [ - "Swag Customized Products Template" - ], - "summary": "Partially update information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "App Cms Block" ], + "summary": "Aggregate for the App Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppCmsBlock", "requestBody": { - "description": "Partially update information about a Swag Customized Products Template resource.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplate", + "description": "List of AppCmsBlock", "content": { "application/vnd.api+json": { "schema": { @@ -427,7 +378,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -437,12 +391,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } } } } @@ -452,52 +409,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/swag-customized-products-template-configuration": { - "get": { + "/aggregate/app-flow-action": { + "post": { "tags": [ - "Swag Customized Products Template Configuration" + "App Flow Action" ], - "summary": "List with basic information of Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the App Flow Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowAction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration resources.", + "description": "List of AppFlowAction", "content": { "application/vnd.api+json": { "schema": { @@ -509,41 +458,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template-configuration?limit=25" - }, - "last": { - "example": "/swag-customized-products-template-configuration?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template-configuration?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template-configuration?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } } } } @@ -560,7 +478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppFlowAction" } } } @@ -568,44 +486,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/app-flow-event": { "post": { "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "Create a new Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfiguration", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "App Flow Event" ], + "summary": "Aggregate for the App Flow Event resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowEvent", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "List of AppFlowEvent", "content": { "application/vnd.api+json": { "schema": { @@ -617,7 +538,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -627,12 +551,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } } } } @@ -648,27 +575,38 @@ } } }, - "/search/swag-customized-products-template-configuration": { + "/aggregate/app-payment-method": { "post": { "tags": [ - "Swag Customized Products Template Configuration" + "App Payment Method" ], - "summary": "Search for the Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "summary": "Aggregate for the App Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppPaymentMethod", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", + "description": "List of AppPaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -682,7 +620,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppPaymentMethod" } } } @@ -700,7 +638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/AppPaymentMethod" } } } @@ -717,29 +655,38 @@ } } }, - "/swag-customized-products-template-configuration/{id}": { - "get": { + "/aggregate/app-script-condition": { + "post": { "tags": [ - "Swag Customized Products Template Configuration" + "App Script Condition" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the App Script Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppScriptCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "List of AppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -751,7 +698,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } @@ -761,20 +711,11408 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/app-shipping-method": { + "post": { + "tags": [ + "App Shipping Method" + ], + "summary": "Aggregate for the App Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppShippingMethod", + "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 AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/app-template": { + "post": { + "tags": [ + "App Template" + ], + "summary": "Aggregate for the App Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/category": { + "post": { + "tags": [ + "Category" + ], + "summary": "Aggregate for the Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCategory", + "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 Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/cms-block": { + "post": { + "tags": [ + "Cms Block" + ], + "summary": "Aggregate for the Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsBlock", + "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 CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/cms-page": { + "post": { + "tags": [ + "Cms Page" + ], + "summary": "Aggregate for the Cms Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/cms-section": { + "post": { + "tags": [ + "Cms Section" + ], + "summary": "Aggregate for the Cms Section resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSection", + "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 CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/cms-slot": { + "post": { + "tags": [ + "Cms Slot" + ], + "summary": "Aggregate for the Cms Slot resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSlot", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/country": { + "post": { + "tags": [ + "Country" + ], + "summary": "Aggregate for the Country resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountry", + "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 Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/country-state": { + "post": { + "tags": [ + "Country State" + ], + "summary": "Aggregate for the Country State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountryState", + "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 CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/currency": { + "post": { + "tags": [ + "Currency" + ], + "summary": "Aggregate for the Currency resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrency", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/currency-country-rounding": { + "post": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Aggregate for the Currency Country Rounding resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrencyCountryRounding", + "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 CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/custom-entity": { + "post": { + "tags": [ + "Custom Entity" + ], + "summary": "Aggregate for the Custom Entity resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomEntity", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/custom-field": { + "post": { + "tags": [ + "Custom Field" + ], + "summary": "Aggregate for the Custom Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomField", + "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 CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/custom-field-set": { + "post": { + "tags": [ + "Custom Field Set" + ], + "summary": "Aggregate for the Custom Field Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSet", + "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 CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/custom-field-set-relation": { + "post": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Aggregate for the Custom Field Set Relation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSetRelation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/customer": { + "post": { + "tags": [ + "Customer" + ], + "summary": "Aggregate for the Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomer", + "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 Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/customer-address": { + "post": { + "tags": [ + "Customer Address" + ], + "summary": "Aggregate for the Customer Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/customer-group": { + "post": { + "tags": [ + "Customer Group" + ], + "summary": "Aggregate for the Customer Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerGroup", + "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 CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/customer-recovery": { + "post": { + "tags": [ + "Customer Recovery" + ], + "summary": "Aggregate for the Customer Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerRecovery", + "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 CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/customer-wishlist": { + "post": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Aggregate for the Customer Wishlist resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlist", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/customer-wishlist-product": { + "post": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Aggregate for the Customer Wishlist Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlistProduct", + "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 CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/delivery-time": { + "post": { + "tags": [ + "Delivery Time" + ], + "summary": "Aggregate for the Delivery Time resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDeliveryTime", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/document": { + "post": { + "tags": [ + "Document" + ], + "summary": "Aggregate for the Document resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocument", + "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 Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/document-base-config": { + "post": { + "tags": [ + "Document Base Config" + ], + "summary": "Aggregate for the Document Base Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfig", + "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 DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/document-base-config-sales-channel": { + "post": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Aggregate for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfigSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/document-type": { + "post": { + "tags": [ + "Document Type" + ], + "summary": "Aggregate for the Document Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentType", + "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 DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/flow": { + "post": { + "tags": [ + "Flow" + ], + "summary": "Aggregate for the Flow resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlow", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/flow-sequence": { + "post": { + "tags": [ + "Flow Sequence" + ], + "summary": "Aggregate for the Flow Sequence resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowSequence", + "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 FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/flow-template": { + "post": { + "tags": [ + "Flow Template" + ], + "summary": "Aggregate for the Flow Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowTemplate", + "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 FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/import-export-file": { + "post": { + "tags": [ + "Import Export File" + ], + "summary": "Aggregate for the Import Export File resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportFile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/import-export-log": { + "post": { + "tags": [ + "Import Export Log" + ], + "summary": "Aggregate for the Import Export Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/import-export-profile": { + "post": { + "tags": [ + "Import Export Profile" + ], + "summary": "Aggregate for the Import Export Profile resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportProfile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/integration": { + "post": { + "tags": [ + "Integration" + ], + "summary": "Aggregate for the Integration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateIntegration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/landing-page": { + "post": { + "tags": [ + "Landing Page" + ], + "summary": "Aggregate for the Landing Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLandingPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/language": { + "post": { + "tags": [ + "Language" + ], + "summary": "Aggregate for the Language resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLanguage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/locale": { + "post": { + "tags": [ + "Locale" + ], + "summary": "Aggregate for the Locale resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLocale", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/log-entry": { + "post": { + "tags": [ + "Log Entry" + ], + "summary": "Aggregate for the Log Entry resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLogEntry", + "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 LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/mail-header-footer": { + "post": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Aggregate for the Mail Header Footer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailHeaderFooter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/mail-template": { + "post": { + "tags": [ + "Mail Template" + ], + "summary": "Aggregate for the Mail Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/mail-template-type": { + "post": { + "tags": [ + "Mail Template Type" + ], + "summary": "Aggregate for the Mail Template Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplateType", + "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 MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/main-category": { + "post": { + "tags": [ + "Main Category" + ], + "summary": "Aggregate for the Main Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMainCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media": { + "post": { + "tags": [ + "Media" + ], + "summary": "Aggregate for the Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-default-folder": { + "post": { + "tags": [ + "Media Default Folder" + ], + "summary": "Aggregate for the Media Default Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaDefaultFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-folder": { + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Aggregate for the Media Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-folder-configuration": { + "post": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Aggregate for the Media Folder Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolderConfiguration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-thumbnail": { + "post": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Aggregate for the Media Thumbnail resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/media-thumbnail-size": { + "post": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Aggregate for the Media Thumbnail Size resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnailSize", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/newsletter-recipient": { + "post": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Aggregate for the Newsletter Recipient resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNewsletterRecipient", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/notification": { + "post": { + "tags": [ + "Notification" + ], + "summary": "Aggregate for the Notification resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNotification", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range": { + "post": { + "tags": [ + "Number Range" + ], + "summary": "Aggregate for the Number Range resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRange", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range-sales-channel": { + "post": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Aggregate for the Number Range Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range-state": { + "post": { + "tags": [ + "Number Range State" + ], + "summary": "Aggregate for the Number Range State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/number-range-type": { + "post": { + "tags": [ + "Number Range Type" + ], + "summary": "Aggregate for the Number Range Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order": { + "post": { + "tags": [ + "Order" + ], + "summary": "Aggregate for the Order resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-address": { + "post": { + "tags": [ + "Order Address" + ], + "summary": "Aggregate for the Order Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-customer": { + "post": { + "tags": [ + "Order Customer" + ], + "summary": "Aggregate for the Order Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderCustomer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-delivery": { + "post": { + "tags": [ + "Order Delivery" + ], + "summary": "Aggregate for the Order Delivery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDelivery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-delivery-position": { + "post": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Aggregate for the Order Delivery Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDeliveryPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-line-item": { + "post": { + "tags": [ + "Order Line Item" + ], + "summary": "Aggregate for the Order Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItem", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-line-item-download": { + "post": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Aggregate for the Order Line Item Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItemDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction": { + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Aggregate for the Order Transaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransaction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction-capture": { + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Aggregate for the Order Transaction Capture resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCapture", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Aggregate for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/order-transaction-capture-refund-position": { + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefundPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/payment-method": { + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Aggregate for the Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/plugin": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Aggregate for the Plugin resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePlugin", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product": { + "post": { + "tags": [ + "Product" + ], + "summary": "Aggregate for the Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProduct", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-configurator-setting": { + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Aggregate for the Product Configurator Setting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductConfiguratorSetting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-cross-selling": { + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Aggregate for the Product Cross Selling resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSelling", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-cross-selling-assigned-products": { + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSellingAssignedProducts", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-download": { + "post": { + "tags": [ + "Product Download" + ], + "summary": "Aggregate for the Product Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-export": { + "post": { + "tags": [ + "Product Export" + ], + "summary": "Aggregate for the Product Export resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductExport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-feature-set": { + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Aggregate for the Product Feature Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductFeatureSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-keyword-dictionary": { + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Aggregate for the Product Keyword Dictionary resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductKeywordDictionary", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-manufacturer": { + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Aggregate for the Product Manufacturer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductManufacturer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-media": { + "post": { + "tags": [ + "Product Media" + ], + "summary": "Aggregate for the Product Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-price": { + "post": { + "tags": [ + "Product Price" + ], + "summary": "Aggregate for the Product Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-review": { + "post": { + "tags": [ + "Product Review" + ], + "summary": "Aggregate for the Product Review resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductReview", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-search-config": { + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Aggregate for the Product Search Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-search-config-field": { + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Aggregate for the Product Search Config Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-search-keyword": { + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Aggregate for the Product Search Keyword resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchKeyword", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Aggregate for the Product Sorting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSorting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-stream": { + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Aggregate for the Product Stream resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStream", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-stream-filter": { + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Aggregate for the Product Stream Filter resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/product-visibility": { + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Aggregate for the Product Visibility resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductVisibility", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion": { + "post": { + "tags": [ + "Promotion" + ], + "summary": "Aggregate for the Promotion resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-discount": { + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Aggregate for the Promotion Discount resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscount", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-discount-prices": { + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Aggregate for the Promotion Discount Prices resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscountPrices", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-individual-code": { + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Aggregate for the Promotion Individual Code resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionIndividualCode", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-sales-channel": { + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Aggregate for the Promotion Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/promotion-setgroup": { + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Aggregate for the Promotion Setgroup resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSetgroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/property-group": { + "post": { + "tags": [ + "Property Group" + ], + "summary": "Aggregate for the Property Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/property-group-option": { + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Aggregate for the Property Group Option resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroupOption", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/rule": { + "post": { + "tags": [ + "Rule" + ], + "summary": "Aggregate for the Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/rule-condition": { + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Aggregate for the Rule Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRuleCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel": { + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Aggregate for the Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-analytics": { + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Aggregate for the Sales Channel Analytics resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelAnalytics", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-domain": { + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Aggregate for the Sales Channel Domain resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelDomain", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sales-channel-type": { + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Aggregate for the Sales Channel Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/salutation": { + "post": { + "tags": [ + "Salutation" + ], + "summary": "Aggregate for the Salutation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalutation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Aggregate for the Scheduled Task resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScheduledTask", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/script": { + "post": { + "tags": [ + "Script" + ], + "summary": "Aggregate for the Script resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScript", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/seo-url": { + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Aggregate for the Seo Url resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrl", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/seo-url-template": { + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Aggregate for the Seo Url Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrlTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/shipping-method": { + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Aggregate for the Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/shipping-method-price": { + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Aggregate for the Shipping Method Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethodPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Aggregate for the Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/snippet-set": { + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Aggregate for the Snippet Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippetSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Aggregate for the State Machine resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachine", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Aggregate for the State Machine History resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-state": { + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Aggregate for the State Machine State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-transition": { + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Aggregate for the State Machine Transition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineTransition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template": { + "get": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "List with basic information of Swag Customized Products Template resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateList", + "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 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/SwagCustomizedProductsTemplate" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template?limit=25" + }, + "last": { + "example": "/swag-customized-products-template?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "Create a new Swag Customized Products Template resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplate", + "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/SwagCustomizedProductsTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template": { + "post": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "Search for the Swag Customized Products Template resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "Detailed information about a Swag Customized Products Template resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "Delete a Swag Customized Products Template resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template", + "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" + ], + "summary": "Partially update information about a Swag Customized Products Template resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplate", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template", + "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 resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template": { + "post": { + "tags": [ + "Swag Customized Products Template" + ], + "summary": "Aggregate for the Swag Customized Products Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplate", + "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 SwagCustomizedProductsTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-configuration": { + "get": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "List with basic information of Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfigurationList", + "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 Configuration 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/SwagCustomizedProductsTemplateConfiguration" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-configuration?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-configuration?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-configuration?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-configuration?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "Create a new Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateConfiguration", + "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/SwagCustomizedProductsTemplateConfiguration" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-configuration": { + "post": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "Search for the Swag Customized Products Template Configuration resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-configuration/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfiguration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_configuration", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "Delete a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_configuration", + "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 Configuration" + ], + "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateConfiguration", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_configuration", + "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 Configuration resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-configuration": { + "post": { + "tags": [ + "Swag Customized Products Template Configuration" + ], + "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", + "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 SwagCustomizedProductsTemplateConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-configuration-share": { + "get": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", + "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 Configuration Share 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/SwagCustomizedProductsTemplateConfigurationShare" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-configuration-share?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "Create a new Swag Customized Products Template Configuration Share resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", + "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/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-configuration-share": { + "post": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "Search for the Swag Customized Products Template Configuration Share resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-configuration-share/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_configuration_share", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "Delete a Swag Customized Products Template Configuration Share resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_configuration_share", + "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 Configuration Share" + ], + "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_configuration_share", + "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 Configuration Share resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-configuration-share": { + "post": { + "tags": [ + "Swag Customized Products Template Configuration Share" + ], + "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", + "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 SwagCustomizedProductsTemplateConfigurationShare", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-exclusion": { + "get": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateExclusionList", + "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 Exclusion 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/SwagCustomizedProductsTemplateExclusion" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-exclusion?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-exclusion?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-exclusion?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-exclusion?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "Create a new Swag Customized Products Template Exclusion resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateExclusion", + "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/SwagCustomizedProductsTemplateExclusion" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-exclusion": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "Search for the Swag Customized Products Template Exclusion resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-exclusion/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateExclusion", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_exclusion", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "Delete a Swag Customized Products Template Exclusion resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateExclusion", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_exclusion", + "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 Exclusion" + ], + "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateExclusion", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_exclusion", + "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 Exclusion resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-customized-products-template-exclusion": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion" + ], + "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", + "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 SwagCustomizedProductsTemplateExclusion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-exclusion-condition": { + "get": { + "tags": [ + "Swag Customized Products Template Exclusion Condition" + ], + "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", + "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 Exclusion Condition 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/SwagCustomizedProductsTemplateExclusionCondition" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-exclusion-condition?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Customized Products Template Exclusion Condition" + ], + "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", + "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/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-customized-products-template-exclusion-condition": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion Condition" + ], + "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-exclusion-condition/{id}": { + "get": { + "tags": [ + "Swag Customized Products Template Exclusion Condition" + ], + "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" @@ -783,16 +12121,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Delete a Swag Customized Products Template Configuration resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -823,16 +12161,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfiguration", + "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -850,18 +12188,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 Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -873,7 +12211,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -888,7 +12226,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -907,14 +12245,94 @@ } } }, - "/swag-customized-products-template-configuration-share": { + "/aggregate/swag-customized-products-template-exclusion-condition": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion Condition" + ], + "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", + "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 SwagCustomizedProductsTemplateExclusionCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-exclusion-operator": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", "parameters": [ { "name": "limit", @@ -943,7 +12361,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration Share resources.", + "description": "List of Swag Customized Products Template Exclusion Operator resources.", "content": { "application/vnd.api+json": { "schema": { @@ -962,7 +12380,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } ] @@ -976,16 +12394,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration-share?limit=25" + "example": "/swag-customized-products-template-exclusion-operator?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" } } } @@ -1006,7 +12424,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1021,11 +12439,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Create a new Swag Customized Products Template Configuration Share resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "_response", @@ -1044,14 +12462,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -1063,7 +12481,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1078,7 +12496,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1094,14 +12512,14 @@ } } }, - "/search/swag-customized-products-template-configuration-share": { + "/search/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Search for the Swag Customized Products Template Configuration Share resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", "requestBody": { "required": true, "content": { @@ -1114,7 +12532,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -1128,7 +12546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1146,7 +12564,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1163,19 +12581,19 @@ } } }, - "/swag-customized-products-template-configuration-share/{id}": { + "/swag-customized-products-template-exclusion-operator/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -1185,7 +12603,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -1197,7 +12615,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1212,7 +12630,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1229,16 +12647,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Delete a Swag Customized Products Template Configuration Share resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -1269,16 +12687,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -1296,18 +12714,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 Operator resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -1319,7 +12737,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1334,7 +12752,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -1353,14 +12771,94 @@ } } }, - "/swag-customized-products-template-exclusion": { + "/aggregate/swag-customized-products-template-exclusion-operator": { + "post": { + "tags": [ + "Swag Customized Products Template Exclusion Operator" + ], + "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "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 SwagCustomizedProductsTemplateExclusionOperator", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Option" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", + "summary": "List with basic information of Swag Customized Products Template Option resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionList", + "operationId": "getSwagCustomizedProductsTemplateOptionList", "parameters": [ { "name": "limit", @@ -1389,7 +12887,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion resources.", + "description": "List of Swag Customized Products Template Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1408,7 +12906,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } ] @@ -1422,16 +12920,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion?limit=25" + "example": "/swag-customized-products-template-option?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=11" + "example": "/swag-customized-products-template-option?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=4" + "example": "/swag-customized-products-template-option?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=2" + "example": "/swag-customized-products-template-option?limit=25&page=2" } } } @@ -1452,7 +12950,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1467,11 +12965,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Option" ], - "summary": "Create a new Swag Customized Products Template Exclusion resources.", + "summary": "Create a new Swag Customized Products Template Option resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusion", + "operationId": "createSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "_response", @@ -1490,14 +12988,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -1509,7 +13007,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1524,7 +13022,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1540,14 +13038,14 @@ } } }, - "/search/swag-customized-products-template-exclusion": { + "/search/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Option" ], - "summary": "Search for the Swag Customized Products Template Exclusion resources.", + "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "operationId": "searchSwagCustomizedProductsTemplateOption", "requestBody": { "required": true, "content": { @@ -1560,7 +13058,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -1574,7 +13072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1592,7 +13090,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1609,19 +13107,19 @@ } } }, - "/swag-customized-products-template-exclusion/{id}": { + "/swag-customized-products-template-option/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Option" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", + "summary": "Detailed information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusion", + "operationId": "getSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -1631,7 +13129,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -1643,7 +13141,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1658,7 +13156,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1675,16 +13173,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Option" ], - "summary": "Delete a Swag Customized Products Template Exclusion resource.", + "summary": "Delete a Swag Customized Products Template Option resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusion", + "operationId": "deleteSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -1715,16 +13213,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Option" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "summary": "Partially update information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusion", + "operationId": "updateSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -1742,18 +13240,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "description": "Partially update information about a Swag Customized Products Template Option resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -1765,7 +13263,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1780,7 +13278,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -1799,14 +13297,94 @@ } } }, - "/swag-customized-products-template-exclusion-condition": { + "/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 Exclusion Condition" + "Swag Customized Products Template Option Price" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", + "summary": "List with basic information of Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", + "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", "parameters": [ { "name": "limit", @@ -1835,7 +13413,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Condition resources.", + "description": "List of Swag Customized Products Template Option Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1854,7 +13432,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } ] @@ -1868,16 +13446,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25" + "example": "/swag-customized-products-template-option-price?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" + "example": "/swag-customized-products-template-option-price?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" + "example": "/swag-customized-products-template-option-price?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" + "example": "/swag-customized-products-template-option-price?limit=25&page=2" } } } @@ -1898,7 +13476,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -1913,11 +13491,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option Price" ], - "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", + "summary": "Create a new Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "createSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "_response", @@ -1936,14 +13514,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -1955,7 +13533,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -1970,7 +13548,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -1986,14 +13564,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-condition": { + "/search/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option Price" ], - "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Search for the Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", "requestBody": { "required": true, "content": { @@ -2006,7 +13584,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -2020,7 +13598,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -2038,7 +13616,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -2055,19 +13633,19 @@ } } }, - "/swag-customized-products-template-exclusion-condition/{id}": { + "/swag-customized-products-template-option-price/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option Price" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "getSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -2077,7 +13655,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -2089,7 +13667,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -2104,7 +13682,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -2121,16 +13699,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option Price" ], - "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Delete a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -2161,16 +13739,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Option Price" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -2188,18 +13766,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 Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -2211,7 +13789,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -2226,7 +13804,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -2245,14 +13823,94 @@ } } }, - "/swag-customized-products-template-exclusion-operator": { + "/aggregate/swag-customized-products-template-option-price": { + "post": { + "tags": [ + "Swag Customized Products Template Option Price" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", + "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 SwagCustomizedProductsTemplateOptionPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-customized-products-template-option-value": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Value" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", + "summary": "List with basic information of Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", + "operationId": "getSwagCustomizedProductsTemplateOptionValueList", "parameters": [ { "name": "limit", @@ -2281,7 +13939,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Operator resources.", + "description": "List of Swag Customized Products Template Option Value resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2300,7 +13958,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } ] @@ -2314,16 +13972,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25" + "example": "/swag-customized-products-template-option-value?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" + "example": "/swag-customized-products-template-option-value?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" + "example": "/swag-customized-products-template-option-value?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" + "example": "/swag-customized-products-template-option-value?limit=25&page=2" } } } @@ -2344,7 +14002,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2359,11 +14017,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Value" ], - "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", + "summary": "Create a new Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "createSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "_response", @@ -2382,14 +14040,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -2401,7 +14059,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2416,7 +14074,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2432,14 +14090,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-operator": { + "/search/swag-customized-products-template-option-value": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Value" ], - "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Search for the Swag Customized Products Template Option Value resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "searchSwagCustomizedProductsTemplateOptionValue", "requestBody": { "required": true, "content": { @@ -2452,7 +14110,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -2466,7 +14124,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2484,7 +14142,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2501,19 +14159,19 @@ } } }, - "/swag-customized-products-template-exclusion-operator/{id}": { + "/swag-customized-products-template-option-value/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Value" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "getSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", @@ -2523,7 +14181,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -2535,7 +14193,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2550,7 +14208,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2567,16 +14225,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Value" ], - "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Delete a Swag Customized Products Template Option Value resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", @@ -2607,16 +14265,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Option Value" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "updateSwagCustomizedProductsTemplateOptionValue", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_option_value", "required": true, "schema": { "type": "string", @@ -2634,18 +14292,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 Value resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -2657,7 +14315,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2672,7 +14330,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -2691,14 +14349,94 @@ } } }, - "/swag-customized-products-template-option": { + "/aggregate/swag-customized-products-template-option-value": { + "post": { + "tags": [ + "Swag Customized Products Template Option Value" + ], + "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", + "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 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" + "Swag Customized Products Template Option Value Price" ], - "summary": "List with basic information of Swag Customized Products Template Option resources.", + "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionList", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", "parameters": [ { "name": "limit", @@ -2727,7 +14465,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option resources.", + "description": "List of Swag Customized Products Template Option Value Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2746,7 +14484,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } ] @@ -2760,16 +14498,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option?limit=25" + "example": "/swag-customized-products-template-option-value-price?limit=25" }, "last": { - "example": "/swag-customized-products-template-option?limit=25&page=11" + "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option?limit=25&page=4" + "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option?limit=25&page=2" + "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" } } } @@ -2790,7 +14528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -2805,11 +14543,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value Price" ], - "summary": "Create a new Swag Customized Products Template Option resources.", + "summary": "Create a new Swag Customized Products Template Option Value Price resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOption", + "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "_response", @@ -2828,14 +14566,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -2847,7 +14585,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -2862,7 +14600,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -2878,14 +14616,14 @@ } } }, - "/search/swag-customized-products-template-option": { + "/search/swag-customized-products-template-option-value-price": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value Price" ], - "summary": "Search for the Swag Customized Products Template Option resources.", + "summary": "Search for the Swag Customized Products Template Option Value Price resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOption", + "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", "requestBody": { "required": true, "content": { @@ -2898,7 +14636,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -2912,7 +14650,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -2930,7 +14668,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -2947,19 +14685,19 @@ } } }, - "/swag-customized-products-template-option/{id}": { + "/swag-customized-products-template-option-value-price/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value Price" ], - "summary": "Detailed information about a Swag Customized Products Template Option resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOption", + "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", @@ -2969,7 +14707,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -2981,7 +14719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -2996,7 +14734,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -3013,16 +14751,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value Price" ], - "summary": "Delete a Swag Customized Products Template Option resource.", + "summary": "Delete a Swag Customized Products Template Option Value Price resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOption", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", @@ -3053,16 +14791,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Option Value Price" ], - "summary": "Partially update information about a Swag Customized Products Template Option resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOption", + "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_option_value_price", "required": true, "schema": { "type": "string", @@ -3080,18 +14818,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option resource.", + "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -3103,7 +14841,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -3118,7 +14856,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -3137,89 +14875,53 @@ } } }, - "/swag-customized-products-template-option-price": { - "get": { + "/aggregate/swag-customized-products-template-option-value-price": { + "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Option Value 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" + "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": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Swag Customized Products Template Option Price resources.", + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "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/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + } } } } @@ -3236,7 +14938,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -3244,44 +14946,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/system-config": { "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" - ] - } - } + "System Config" ], + "summary": "Aggregate for the System Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSystemConfig", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -3293,7 +14998,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } } } } @@ -3303,12 +15011,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } } } } @@ -3324,27 +15035,38 @@ } } }, - "/search/swag-customized-products-template-option-price": { + "/aggregate/tag": { "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Tag" ], - "summary": "Search for the Swag Customized Products Template Option Price resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", + "summary": "Aggregate for the Tag resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTag", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -3358,7 +15080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/Tag" } } } @@ -3376,7 +15098,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/Tag" } } } @@ -3393,29 +15115,38 @@ } } }, - "/swag-customized-products-template-option-price/{id}": { - "get": { + "/aggregate/tax": { + "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Tax" ], - "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Tax resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTax", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -3427,7 +15158,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } } } } @@ -3437,107 +15171,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "Delete a Swag Customized Products Template Option Price resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/tax-provider": { + "post": { "tags": [ - "Swag Customized Products Template Option Price" - ], - "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", - "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" - } - } + "Tax Provider" ], + "summary": "Aggregate for the Tax Provider resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxProvider", "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Price resource.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -3549,7 +15238,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } } } } @@ -3559,12 +15251,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } } } } @@ -3574,52 +15269,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/swag-customized-products-template-option-value": { - "get": { + "/aggregate/tax-rule": { + "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Tax Rule" ], - "summary": "List with basic information of Swag Customized Products Template Option Value resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValueList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" + "summary": "Aggregate for the Tax Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value resources.", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -3631,41 +15318,10 @@ "type": "object", "properties": { "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template-option-value?limit=25" - }, - "last": { - "example": "/swag-customized-products-template-option-value?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template-option-value?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template-option-value?limit=25&page=2" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } } } } @@ -3682,7 +15338,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/TaxRule" } } } @@ -3690,44 +15346,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/tax-rule-type": { "post": { "tags": [ - "Swag Customized Products Template Option Value" - ], - "summary": "Create a new Swag Customized Products Template Option Value resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValue", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "Tax Rule Type" ], + "summary": "Aggregate for the Tax Rule Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRuleType", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -3739,7 +15398,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } } } } @@ -3749,12 +15411,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } } } } @@ -3770,27 +15435,38 @@ } } }, - "/search/swag-customized-products-template-option-value": { + "/aggregate/theme": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Theme" ], - "summary": "Search for the Swag Customized Products Template Option Value resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "summary": "Aggregate for the Theme resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTheme", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -3804,7 +15480,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/Theme" } } } @@ -3822,7 +15498,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/Theme" } } } @@ -3839,29 +15515,38 @@ } } }, - "/swag-customized-products-template-option-value/{id}": { - "get": { + "/aggregate/unit": { + "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Unit" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValue", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "summary": "Aggregate for the Unit resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUnit", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -3873,7 +15558,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } } } } @@ -3883,107 +15571,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template Option Value" - ], - "summary": "Delete a Swag Customized Products Template Option Value resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } - } - }, - "patch": { - "tags": [ - "Swag Customized Products Template Option Value" - ], - "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValue", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", - "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" - } - } + } + } + }, + "/aggregate/user": { + "post": { + "tags": [ + "User" ], + "summary": "Aggregate for the User resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUser", "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value resource.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -3995,7 +15638,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } } } } @@ -4005,12 +15651,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } } } } @@ -4020,52 +15669,44 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } } } }, - "/swag-customized-products-template-option-value-price": { - "get": { + "/aggregate/user-access-key": { + "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "User Access Key" ], - "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" + "summary": "Aggregate for the User Access Key resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } } } - ], + }, "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value Price resources.", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -4077,41 +15718,10 @@ "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" - } - } - } - ] + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } } } } @@ -4128,7 +15738,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -4136,44 +15746,47 @@ } } }, + "400": { + "$ref": "#/components/responses/400" + }, "401": { "$ref": "#/components/responses/401" } } - }, + } + }, + "/aggregate/user-config": { "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" - ] - } - } + "User Config" ], + "summary": "Aggregate for the User Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserConfig", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -4185,7 +15798,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } } } } @@ -4195,12 +15811,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } } } } @@ -4216,27 +15835,38 @@ } } }, - "/search/swag-customized-products-template-option-value-price": { + "/aggregate/user-recovery": { "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "User Recovery" ], - "summary": "Search for the Swag Customized Products Template Option Value Price resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", + "summary": "Aggregate for the User Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserRecovery", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Criteria" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -4250,7 +15880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -4268,7 +15898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -4285,29 +15915,38 @@ } } }, - "/swag-customized-products-template-option-value-price/{id}": { - "get": { + "/aggregate/webhook": { + "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Webhook" ], - "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": "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": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of Webhook", "content": { "application/vnd.api+json": { "schema": { @@ -4319,7 +15958,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } } } } @@ -4329,107 +15971,62 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } } } } } } }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template Option Value Price" - ], - "summary": "Delete a Swag Customized Products Template Option Value Price resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", - "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}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" + "400": { + "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } - }, - "patch": { + } + }, + "/aggregate/webhook-event-log": { + "post": { "tags": [ - "Swag Customized Products Template Option Value Price" - ], - "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", - "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}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } + "Webhook Event Log" ], + "summary": "Aggregate for the Webhook Event Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhookEventLog", "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of WebhookEventLog", "content": { "application/vnd.api+json": { "schema": { @@ -4441,7 +16038,10 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } } } @@ -4451,12 +16051,15 @@ "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { + "total": { + "type": "integer" + }, "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "type": "array", + "items": { + "$ref": "#/components/schemas/WebhookEventLog" + } } } } @@ -4466,9 +16069,6 @@ "400": { "$ref": "#/components/responses/400" }, - "404": { - "$ref": "#/components/responses/404" - }, "401": { "$ref": "#/components/responses/401" } @@ -7204,6 +18804,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -7280,6 +18883,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10836,6 +22442,9 @@ "allowCartExpose": { "type": "boolean" }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -10950,6 +22559,9 @@ "allowCartExpose": { "type": "boolean" }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11390,21 +23002,12 @@ "lastName": { "type": "string" }, - "company": { - "type": "string" - }, "email": { "type": "string" }, "title": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, "affiliateCode": { "type": "string" }, @@ -11484,9 +23087,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -11656,6 +23256,35 @@ }, "type": "object" }, + "activeBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } + } + }, + "type": "object" + }, "defaultShippingAddress": { "properties": { "links": { @@ -11685,6 +23314,35 @@ }, "type": "object" }, + "activeShippingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } + } + }, + "type": "object" + }, "salutation": { "properties": { "links": { @@ -12144,21 +23802,12 @@ "lastName": { "type": "string" }, - "company": { - "type": "string" - }, "email": { "type": "string" }, "title": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, "affiliateCode": { "type": "string" }, @@ -12238,9 +23887,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -12278,9 +23924,15 @@ "defaultBillingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, "defaultShippingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, "salutation": { "$ref": "#/components/schemas/Salutation" }, @@ -12411,6 +24063,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -12615,6 +24271,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -13562,10 +25222,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -13576,9 +25236,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -13591,6 +25248,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -13613,6 +25274,9 @@ "customFields": { "type": "object" }, + "fileType": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13771,6 +25435,35 @@ } }, "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -13785,10 +25478,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -13799,9 +25492,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -13814,6 +25504,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -13836,6 +25530,9 @@ "customFields": { "type": "object" }, + "fileType": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -13863,6 +25560,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -17837,8 +29537,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -17850,8 +29549,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -17892,6 +29590,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -18741,8 +30442,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -18754,8 +30454,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -18796,6 +30495,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -22218,6 +33920,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -22464,6 +34170,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -45868,331 +57578,6 @@ }, "type": "object" }, - "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" - ] - } - ] - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "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" - } - } - } - }, - "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" - } - } - } - } - }, - "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." - } - } - } - } - }, "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)", @@ -46885,6 +58270,331 @@ "type", "field" ] + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "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" + } + } + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "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" + ] + } + ] + }, + "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." + } + } + } + } } }, "responses": { @@ -47247,7 +58957,7 @@ "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", - "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index 2b4343f..3f1dd99 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,5 +1,150 @@ { "paths": [ + "/aggregate/acl-role", + "/aggregate/app", + "/aggregate/app-action-button", + "/aggregate/app-administration-snippet", + "/aggregate/app-cms-block", + "/aggregate/app-flow-action", + "/aggregate/app-flow-event", + "/aggregate/app-payment-method", + "/aggregate/app-script-condition", + "/aggregate/app-shipping-method", + "/aggregate/app-template", + "/aggregate/category", + "/aggregate/cms-block", + "/aggregate/cms-page", + "/aggregate/cms-section", + "/aggregate/cms-slot", + "/aggregate/country", + "/aggregate/country-state", + "/aggregate/currency", + "/aggregate/currency-country-rounding", + "/aggregate/custom-entity", + "/aggregate/custom-field", + "/aggregate/custom-field-set", + "/aggregate/custom-field-set-relation", + "/aggregate/customer", + "/aggregate/customer-address", + "/aggregate/customer-group", + "/aggregate/customer-recovery", + "/aggregate/customer-wishlist", + "/aggregate/customer-wishlist-product", + "/aggregate/delivery-time", + "/aggregate/document", + "/aggregate/document-base-config", + "/aggregate/document-base-config-sales-channel", + "/aggregate/document-type", + "/aggregate/flow", + "/aggregate/flow-sequence", + "/aggregate/flow-template", + "/aggregate/import-export-file", + "/aggregate/import-export-log", + "/aggregate/import-export-profile", + "/aggregate/integration", + "/aggregate/landing-page", + "/aggregate/language", + "/aggregate/locale", + "/aggregate/log-entry", + "/aggregate/mail-header-footer", + "/aggregate/mail-template", + "/aggregate/mail-template-type", + "/aggregate/main-category", + "/aggregate/media", + "/aggregate/media-default-folder", + "/aggregate/media-folder", + "/aggregate/media-folder-configuration", + "/aggregate/media-thumbnail", + "/aggregate/media-thumbnail-size", + "/aggregate/newsletter-recipient", + "/aggregate/notification", + "/aggregate/number-range", + "/aggregate/number-range-sales-channel", + "/aggregate/number-range-state", + "/aggregate/number-range-type", + "/aggregate/order", + "/aggregate/order-address", + "/aggregate/order-customer", + "/aggregate/order-delivery", + "/aggregate/order-delivery-position", + "/aggregate/order-line-item", + "/aggregate/order-line-item-download", + "/aggregate/order-transaction", + "/aggregate/order-transaction-capture", + "/aggregate/order-transaction-capture-refund", + "/aggregate/order-transaction-capture-refund-position", + "/aggregate/payment-method", + "/aggregate/plugin", + "/aggregate/product", + "/aggregate/product-configurator-setting", + "/aggregate/product-cross-selling", + "/aggregate/product-cross-selling-assigned-products", + "/aggregate/product-download", + "/aggregate/product-export", + "/aggregate/product-feature-set", + "/aggregate/product-keyword-dictionary", + "/aggregate/product-manufacturer", + "/aggregate/product-media", + "/aggregate/product-price", + "/aggregate/product-review", + "/aggregate/product-search-config", + "/aggregate/product-search-config-field", + "/aggregate/product-search-keyword", + "/aggregate/product-sorting", + "/aggregate/product-stream", + "/aggregate/product-stream-filter", + "/aggregate/product-visibility", + "/aggregate/promotion", + "/aggregate/promotion-discount", + "/aggregate/promotion-discount-prices", + "/aggregate/promotion-individual-code", + "/aggregate/promotion-sales-channel", + "/aggregate/promotion-setgroup", + "/aggregate/property-group", + "/aggregate/property-group-option", + "/aggregate/rule", + "/aggregate/rule-condition", + "/aggregate/sales-channel", + "/aggregate/sales-channel-analytics", + "/aggregate/sales-channel-domain", + "/aggregate/sales-channel-type", + "/aggregate/salutation", + "/aggregate/scheduled-task", + "/aggregate/script", + "/aggregate/seo-url", + "/aggregate/seo-url-template", + "/aggregate/shipping-method", + "/aggregate/shipping-method-price", + "/aggregate/snippet", + "/aggregate/snippet-set", + "/aggregate/state-machine", + "/aggregate/state-machine-history", + "/aggregate/state-machine-state", + "/aggregate/state-machine-transition", + "/aggregate/swag-customized-products-template", + "/aggregate/swag-customized-products-template-configuration", + "/aggregate/swag-customized-products-template-configuration-share", + "/aggregate/swag-customized-products-template-exclusion", + "/aggregate/swag-customized-products-template-exclusion-condition", + "/aggregate/swag-customized-products-template-exclusion-operator", + "/aggregate/swag-customized-products-template-option", + "/aggregate/swag-customized-products-template-option-price", + "/aggregate/swag-customized-products-template-option-value", + "/aggregate/swag-customized-products-template-option-value-price", + "/aggregate/system-config", + "/aggregate/tag", + "/aggregate/tax", + "/aggregate/tax-provider", + "/aggregate/tax-rule", + "/aggregate/tax-rule-type", + "/aggregate/theme", + "/aggregate/unit", + "/aggregate/user", + "/aggregate/user-access-key", + "/aggregate/user-config", + "/aggregate/user-recovery", + "/aggregate/webhook", + "/aggregate/webhook-event-log", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", From 8aa957fedd5f4bd734131c3b9306e153af1b3597 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 7 May 2025 10:05:13 +0200 Subject: [PATCH 41/63] [create-pull-request] automated change (#355) Co-authored-by: shopwareBot --- adminapi.json | 13682 ++++++++++++++++++++++++++++++++++++---- adminapi.summary.json | 135 + 2 files changed, 12434 insertions(+), 1383 deletions(-) diff --git a/adminapi.json b/adminapi.json index 53a8b59..cc8f672 100644 --- a/adminapi.json +++ b/adminapi.json @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.9.0" + "version": "6.6.10.4" }, "servers": [ { @@ -461,6 +461,86 @@ } } }, + "/aggregate/acl-role": { + "post": { + "tags": [ + "Acl Role" + ], + "summary": "Aggregate for the Acl Role resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAclRole", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AclRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app": { "get": { "tags": [ @@ -907,6 +987,86 @@ } } }, + "/aggregate/app": { + "post": { + "tags": [ + "App" + ], + "summary": "Aggregate for the App resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateApp", + "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 App", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/App" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-action-button": { "get": { "tags": [ @@ -1353,6 +1513,86 @@ } } }, + "/aggregate/app-action-button": { + "post": { + "tags": [ + "App Action Button" + ], + "summary": "Aggregate for the App Action Button resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppActionButton", + "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 AppActionButton", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-administration-snippet": { "get": { "tags": [ @@ -1799,6 +2039,86 @@ } } }, + "/aggregate/app-administration-snippet": { + "post": { + "tags": [ + "App Administration Snippet" + ], + "summary": "Aggregate for the App Administration Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppAdministrationSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppAdministrationSnippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppAdministrationSnippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-cms-block": { "get": { "tags": [ @@ -2245,6 +2565,86 @@ } } }, + "/aggregate/app-cms-block": { + "post": { + "tags": [ + "App Cms Block" + ], + "summary": "Aggregate for the App Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppCmsBlock", + "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 AppCmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-flow-action": { "get": { "tags": [ @@ -2691,6 +3091,86 @@ } } }, + "/aggregate/app-flow-action": { + "post": { + "tags": [ + "App Flow Action" + ], + "summary": "Aggregate for the App Flow Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowAction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppFlowAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-flow-event": { "get": { "tags": [ @@ -3137,6 +3617,86 @@ } } }, + "/aggregate/app-flow-event": { + "post": { + "tags": [ + "App Flow Event" + ], + "summary": "Aggregate for the App Flow Event resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppFlowEvent", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppFlowEvent", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-payment-method": { "get": { "tags": [ @@ -3583,6 +4143,86 @@ } } }, + "/aggregate/app-payment-method": { + "post": { + "tags": [ + "App Payment Method" + ], + "summary": "Aggregate for the App Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppPaymentMethod", + "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 AppPaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-script-condition": { "get": { "tags": [ @@ -4029,6 +4669,86 @@ } } }, + "/aggregate/app-script-condition": { + "post": { + "tags": [ + "App Script Condition" + ], + "summary": "Aggregate for the App Script Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppScriptCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppScriptCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-shipping-method": { "get": { "tags": [ @@ -4475,6 +5195,86 @@ } } }, + "/aggregate/app-shipping-method": { + "post": { + "tags": [ + "App Shipping Method" + ], + "summary": "Aggregate for the App Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppShippingMethod", + "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 AppShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/app-template": { "get": { "tags": [ @@ -4921,6 +5721,86 @@ } } }, + "/aggregate/app-template": { + "post": { + "tags": [ + "App Template" + ], + "summary": "Aggregate for the App Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAppTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of AppTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/category": { "get": { "tags": [ @@ -5367,6 +6247,86 @@ } } }, + "/aggregate/category": { + "post": { + "tags": [ + "Category" + ], + "summary": "Aggregate for the Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCategory", + "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 Category", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-block": { "get": { "tags": [ @@ -5813,6 +6773,86 @@ } } }, + "/aggregate/cms-block": { + "post": { + "tags": [ + "Cms Block" + ], + "summary": "Aggregate for the Cms Block resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsBlock", + "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 CmsBlock", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-page": { "get": { "tags": [ @@ -6259,6 +7299,86 @@ } } }, + "/aggregate/cms-page": { + "post": { + "tags": [ + "Cms Page" + ], + "summary": "Aggregate for the Cms Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-section": { "get": { "tags": [ @@ -6705,6 +7825,86 @@ } } }, + "/aggregate/cms-section": { + "post": { + "tags": [ + "Cms Section" + ], + "summary": "Aggregate for the Cms Section resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSection", + "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 CmsSection", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/cms-slot": { "get": { "tags": [ @@ -7151,6 +8351,86 @@ } } }, + "/aggregate/cms-slot": { + "post": { + "tags": [ + "Cms Slot" + ], + "summary": "Aggregate for the Cms Slot resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCmsSlot", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CmsSlot", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSlot" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/country": { "get": { "tags": [ @@ -7597,6 +8877,86 @@ } } }, + "/aggregate/country": { + "post": { + "tags": [ + "Country" + ], + "summary": "Aggregate for the Country resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountry", + "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 Country", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Country" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/country-state": { "get": { "tags": [ @@ -8043,6 +9403,86 @@ } } }, + "/aggregate/country-state": { + "post": { + "tags": [ + "Country State" + ], + "summary": "Aggregate for the Country State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCountryState", + "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 CountryState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/currency": { "get": { "tags": [ @@ -8489,6 +9929,86 @@ } } }, + "/aggregate/currency": { + "post": { + "tags": [ + "Currency" + ], + "summary": "Aggregate for the Currency resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrency", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Currency", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Currency" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/currency-country-rounding": { "get": { "tags": [ @@ -8935,6 +10455,86 @@ } } }, + "/aggregate/currency-country-rounding": { + "post": { + "tags": [ + "Currency Country Rounding" + ], + "summary": "Aggregate for the Currency Country Rounding resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCurrencyCountryRounding", + "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 CurrencyCountryRounding", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-entity": { "get": { "tags": [ @@ -9381,6 +10981,86 @@ } } }, + "/aggregate/custom-entity": { + "post": { + "tags": [ + "Custom Entity" + ], + "summary": "Aggregate for the Custom Entity resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomEntity", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomEntity", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomEntity" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-field": { "get": { "tags": [ @@ -9827,6 +11507,86 @@ } } }, + "/aggregate/custom-field": { + "post": { + "tags": [ + "Custom Field" + ], + "summary": "Aggregate for the Custom Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomField", + "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 CustomField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-field-set": { "get": { "tags": [ @@ -10273,6 +12033,86 @@ } } }, + "/aggregate/custom-field-set": { + "post": { + "tags": [ + "Custom Field Set" + ], + "summary": "Aggregate for the Custom Field Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSet", + "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 CustomFieldSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/custom-field-set-relation": { "get": { "tags": [ @@ -10719,6 +12559,86 @@ } } }, + "/aggregate/custom-field-set-relation": { + "post": { + "tags": [ + "Custom Field Set Relation" + ], + "summary": "Aggregate for the Custom Field Set Relation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomFieldSetRelation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomFieldSetRelation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer": { "get": { "tags": [ @@ -11165,6 +13085,86 @@ } } }, + "/aggregate/customer": { + "post": { + "tags": [ + "Customer" + ], + "summary": "Aggregate for the Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomer", + "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 Customer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Customer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-address": { "get": { "tags": [ @@ -11611,6 +13611,86 @@ } } }, + "/aggregate/customer-address": { + "post": { + "tags": [ + "Customer Address" + ], + "summary": "Aggregate for the Customer Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-group": { "get": { "tags": [ @@ -12057,6 +14137,86 @@ } } }, + "/aggregate/customer-group": { + "post": { + "tags": [ + "Customer Group" + ], + "summary": "Aggregate for the Customer Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerGroup", + "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 CustomerGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-recovery": { "get": { "tags": [ @@ -12503,6 +14663,86 @@ } } }, + "/aggregate/customer-recovery": { + "post": { + "tags": [ + "Customer Recovery" + ], + "summary": "Aggregate for the Customer Recovery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerRecovery", + "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 CustomerRecovery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerRecovery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-wishlist": { "get": { "tags": [ @@ -12949,6 +15189,86 @@ } } }, + "/aggregate/customer-wishlist": { + "post": { + "tags": [ + "Customer Wishlist" + ], + "summary": "Aggregate for the Customer Wishlist resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlist", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of CustomerWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlist" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/customer-wishlist-product": { "get": { "tags": [ @@ -13395,6 +15715,86 @@ } } }, + "/aggregate/customer-wishlist-product": { + "post": { + "tags": [ + "Customer Wishlist Product" + ], + "summary": "Aggregate for the Customer Wishlist Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerWishlistProduct", + "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 CustomerWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/delivery-time": { "get": { "tags": [ @@ -13841,6 +16241,86 @@ } } }, + "/aggregate/delivery-time": { + "post": { + "tags": [ + "Delivery Time" + ], + "summary": "Aggregate for the Delivery Time resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDeliveryTime", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DeliveryTime", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DeliveryTime" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document": { "get": { "tags": [ @@ -14287,6 +16767,86 @@ } } }, + "/aggregate/document": { + "post": { + "tags": [ + "Document" + ], + "summary": "Aggregate for the Document resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocument", + "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 Document", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document-base-config": { "get": { "tags": [ @@ -14733,6 +17293,86 @@ } } }, + "/aggregate/document-base-config": { + "post": { + "tags": [ + "Document Base Config" + ], + "summary": "Aggregate for the Document Base Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfig", + "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 DocumentBaseConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document-base-config-sales-channel": { "get": { "tags": [ @@ -15179,6 +17819,86 @@ } } }, + "/aggregate/document-base-config-sales-channel": { + "post": { + "tags": [ + "Document Base Config Sales Channel" + ], + "summary": "Aggregate for the Document Base Config Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentBaseConfigSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of DocumentBaseConfigSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/document-type": { "get": { "tags": [ @@ -15625,6 +18345,86 @@ } } }, + "/aggregate/document-type": { + "post": { + "tags": [ + "Document Type" + ], + "summary": "Aggregate for the Document Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDocumentType", + "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 DocumentType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/flow": { "get": { "tags": [ @@ -16071,6 +18871,86 @@ } } }, + "/aggregate/flow": { + "post": { + "tags": [ + "Flow" + ], + "summary": "Aggregate for the Flow resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlow", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Flow", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/flow-sequence": { "get": { "tags": [ @@ -16517,6 +19397,86 @@ } } }, + "/aggregate/flow-sequence": { + "post": { + "tags": [ + "Flow Sequence" + ], + "summary": "Aggregate for the Flow Sequence resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowSequence", + "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 FlowSequence", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/flow-template": { "get": { "tags": [ @@ -16963,6 +19923,86 @@ } } }, + "/aggregate/flow-template": { + "post": { + "tags": [ + "Flow Template" + ], + "summary": "Aggregate for the Flow Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateFlowTemplate", + "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 FlowTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/import-export-file": { "get": { "tags": [ @@ -17409,6 +20449,86 @@ } } }, + "/aggregate/import-export-file": { + "post": { + "tags": [ + "Import Export File" + ], + "summary": "Aggregate for the Import Export File resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportFile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportFile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportFile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/import-export-log": { "get": { "tags": [ @@ -17855,6 +20975,86 @@ } } }, + "/aggregate/import-export-log": { + "post": { + "tags": [ + "Import Export Log" + ], + "summary": "Aggregate for the Import Export Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportLog" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/import-export-profile": { "get": { "tags": [ @@ -18301,6 +21501,86 @@ } } }, + "/aggregate/import-export-profile": { + "post": { + "tags": [ + "Import Export Profile" + ], + "summary": "Aggregate for the Import Export Profile resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateImportExportProfile", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ImportExportProfile", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ImportExportProfile" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/integration": { "get": { "tags": [ @@ -18747,6 +22027,86 @@ } } }, + "/aggregate/integration": { + "post": { + "tags": [ + "Integration" + ], + "summary": "Aggregate for the Integration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateIntegration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Integration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/landing-page": { "get": { "tags": [ @@ -19193,6 +22553,86 @@ } } }, + "/aggregate/landing-page": { + "post": { + "tags": [ + "Landing Page" + ], + "summary": "Aggregate for the Landing Page resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLandingPage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of LandingPage", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/language": { "get": { "tags": [ @@ -19639,6 +23079,86 @@ } } }, + "/aggregate/language": { + "post": { + "tags": [ + "Language" + ], + "summary": "Aggregate for the Language resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLanguage", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Language", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/locale": { "get": { "tags": [ @@ -20085,6 +23605,86 @@ } } }, + "/aggregate/locale": { + "post": { + "tags": [ + "Locale" + ], + "summary": "Aggregate for the Locale resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLocale", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Locale", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Locale" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/log-entry": { "get": { "tags": [ @@ -20531,6 +24131,86 @@ } } }, + "/aggregate/log-entry": { + "post": { + "tags": [ + "Log Entry" + ], + "summary": "Aggregate for the Log Entry resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateLogEntry", + "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 LogEntry", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LogEntry" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/mail-header-footer": { "get": { "tags": [ @@ -20977,6 +24657,86 @@ } } }, + "/aggregate/mail-header-footer": { + "post": { + "tags": [ + "Mail Header Footer" + ], + "summary": "Aggregate for the Mail Header Footer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailHeaderFooter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailHeaderFooter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailHeaderFooter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/mail-template": { "get": { "tags": [ @@ -21423,6 +25183,86 @@ } } }, + "/aggregate/mail-template": { + "post": { + "tags": [ + "Mail Template" + ], + "summary": "Aggregate for the Mail Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MailTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/mail-template-type": { "get": { "tags": [ @@ -21869,6 +25709,86 @@ } } }, + "/aggregate/mail-template-type": { + "post": { + "tags": [ + "Mail Template Type" + ], + "summary": "Aggregate for the Mail Template Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMailTemplateType", + "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 MailTemplateType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MailTemplateType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/main-category": { "get": { "tags": [ @@ -22315,6 +26235,86 @@ } } }, + "/aggregate/main-category": { + "post": { + "tags": [ + "Main Category" + ], + "summary": "Aggregate for the Main Category resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMainCategory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MainCategory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media": { "get": { "tags": [ @@ -22761,6 +26761,86 @@ } } }, + "/aggregate/media": { + "post": { + "tags": [ + "Media" + ], + "summary": "Aggregate for the Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Media", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Media" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-default-folder": { "get": { "tags": [ @@ -23207,6 +27287,86 @@ } } }, + "/aggregate/media-default-folder": { + "post": { + "tags": [ + "Media Default Folder" + ], + "summary": "Aggregate for the Media Default Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaDefaultFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaDefaultFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaDefaultFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-folder": { "get": { "tags": [ @@ -23653,6 +27813,86 @@ } } }, + "/aggregate/media-folder": { + "post": { + "tags": [ + "Media Folder" + ], + "summary": "Aggregate for the Media Folder resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-folder-configuration": { "get": { "tags": [ @@ -24099,6 +28339,86 @@ } } }, + "/aggregate/media-folder-configuration": { + "post": { + "tags": [ + "Media Folder Configuration" + ], + "summary": "Aggregate for the Media Folder Configuration resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaFolderConfiguration", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaFolderConfiguration", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaFolderConfiguration" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-thumbnail": { "get": { "tags": [ @@ -24545,6 +28865,86 @@ } } }, + "/aggregate/media-thumbnail": { + "post": { + "tags": [ + "Media Thumbnail" + ], + "summary": "Aggregate for the Media Thumbnail resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnail", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnail", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/media-thumbnail-size": { "get": { "tags": [ @@ -24991,6 +29391,86 @@ } } }, + "/aggregate/media-thumbnail-size": { + "post": { + "tags": [ + "Media Thumbnail Size" + ], + "summary": "Aggregate for the Media Thumbnail Size resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaThumbnailSize", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of MediaThumbnailSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/newsletter-recipient": { "get": { "tags": [ @@ -25437,6 +29917,86 @@ } } }, + "/aggregate/newsletter-recipient": { + "post": { + "tags": [ + "Newsletter Recipient" + ], + "summary": "Aggregate for the Newsletter Recipient resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNewsletterRecipient", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NewsletterRecipient", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NewsletterRecipient" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/notification": { "get": { "tags": [ @@ -25883,6 +30443,86 @@ } } }, + "/aggregate/notification": { + "post": { + "tags": [ + "Notification" + ], + "summary": "Aggregate for the Notification resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNotification", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Notification", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Notification" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range": { "get": { "tags": [ @@ -26329,6 +30969,86 @@ } } }, + "/aggregate/number-range": { + "post": { + "tags": [ + "Number Range" + ], + "summary": "Aggregate for the Number Range resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRange", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRange", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range-sales-channel": { "get": { "tags": [ @@ -26775,6 +31495,86 @@ } } }, + "/aggregate/number-range-sales-channel": { + "post": { + "tags": [ + "Number Range Sales Channel" + ], + "summary": "Aggregate for the Number Range Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range-state": { "get": { "tags": [ @@ -27221,6 +32021,86 @@ } } }, + "/aggregate/number-range-state": { + "post": { + "tags": [ + "Number Range State" + ], + "summary": "Aggregate for the Number Range State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/number-range-type": { "get": { "tags": [ @@ -27667,6 +32547,86 @@ } } }, + "/aggregate/number-range-type": { + "post": { + "tags": [ + "Number Range Type" + ], + "summary": "Aggregate for the Number Range Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateNumberRangeType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of NumberRangeType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order": { "get": { "tags": [ @@ -28113,6 +33073,86 @@ } } }, + "/aggregate/order": { + "post": { + "tags": [ + "Order" + ], + "summary": "Aggregate for the Order resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrder", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Order", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-address": { "get": { "tags": [ @@ -28559,6 +33599,86 @@ } } }, + "/aggregate/order-address": { + "post": { + "tags": [ + "Order Address" + ], + "summary": "Aggregate for the Order Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderAddress", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-customer": { "get": { "tags": [ @@ -29005,6 +34125,86 @@ } } }, + "/aggregate/order-customer": { + "post": { + "tags": [ + "Order Customer" + ], + "summary": "Aggregate for the Order Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderCustomer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-delivery": { "get": { "tags": [ @@ -29451,6 +34651,86 @@ } } }, + "/aggregate/order-delivery": { + "post": { + "tags": [ + "Order Delivery" + ], + "summary": "Aggregate for the Order Delivery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDelivery", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-delivery-position": { "get": { "tags": [ @@ -29897,6 +35177,86 @@ } } }, + "/aggregate/order-delivery-position": { + "post": { + "tags": [ + "Order Delivery Position" + ], + "summary": "Aggregate for the Order Delivery Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderDeliveryPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-line-item": { "get": { "tags": [ @@ -30343,6 +35703,86 @@ } } }, + "/aggregate/order-line-item": { + "post": { + "tags": [ + "Order Line Item" + ], + "summary": "Aggregate for the Order Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItem", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-line-item-download": { "get": { "tags": [ @@ -30789,6 +36229,86 @@ } } }, + "/aggregate/order-line-item-download": { + "post": { + "tags": [ + "Order Line Item Download" + ], + "summary": "Aggregate for the Order Line Item Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderLineItemDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderLineItemDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction": { "get": { "tags": [ @@ -31235,6 +36755,86 @@ } } }, + "/aggregate/order-transaction": { + "post": { + "tags": [ + "Order Transaction" + ], + "summary": "Aggregate for the Order Transaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransaction", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction-capture": { "get": { "tags": [ @@ -31681,6 +37281,86 @@ } } }, + "/aggregate/order-transaction-capture": { + "post": { + "tags": [ + "Order Transaction Capture" + ], + "summary": "Aggregate for the Order Transaction Capture resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCapture", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCapture", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction-capture-refund": { "get": { "tags": [ @@ -32127,6 +37807,86 @@ } } }, + "/aggregate/order-transaction-capture-refund": { + "post": { + "tags": [ + "Order Transaction Capture Refund" + ], + "summary": "Aggregate for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefund", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefund", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/order-transaction-capture-refund-position": { "get": { "tags": [ @@ -32573,6 +38333,86 @@ } } }, + "/aggregate/order-transaction-capture-refund-position": { + "post": { + "tags": [ + "Order Transaction Capture Refund Position" + ], + "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderTransactionCaptureRefundPosition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of OrderTransactionCaptureRefundPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/payment-method": { "get": { "tags": [ @@ -33019,6 +38859,86 @@ } } }, + "/aggregate/payment-method": { + "post": { + "tags": [ + "Payment Method" + ], + "summary": "Aggregate for the Payment Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePaymentMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PaymentMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PaymentMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/plugin": { "get": { "tags": [ @@ -33465,6 +39385,86 @@ } } }, + "/aggregate/plugin": { + "post": { + "tags": [ + "Plugin" + ], + "summary": "Aggregate for the Plugin resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePlugin", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Plugin", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plugin" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product": { "get": { "tags": [ @@ -33911,6 +39911,86 @@ } } }, + "/aggregate/product": { + "post": { + "tags": [ + "Product" + ], + "summary": "Aggregate for the Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProduct", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Product", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-configurator-setting": { "get": { "tags": [ @@ -34357,6 +40437,86 @@ } } }, + "/aggregate/product-configurator-setting": { + "post": { + "tags": [ + "Product Configurator Setting" + ], + "summary": "Aggregate for the Product Configurator Setting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductConfiguratorSetting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductConfiguratorSetting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-cross-selling": { "get": { "tags": [ @@ -34803,6 +40963,86 @@ } } }, + "/aggregate/product-cross-selling": { + "post": { + "tags": [ + "Product Cross Selling" + ], + "summary": "Aggregate for the Product Cross Selling resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSelling", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSelling", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-cross-selling-assigned-products": { "get": { "tags": [ @@ -35249,6 +41489,86 @@ } } }, + "/aggregate/product-cross-selling-assigned-products": { + "post": { + "tags": [ + "Product Cross Selling Assigned Products" + ], + "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductCrossSellingAssignedProducts", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductCrossSellingAssignedProducts", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-download": { "get": { "tags": [ @@ -35695,6 +42015,86 @@ } } }, + "/aggregate/product-download": { + "post": { + "tags": [ + "Product Download" + ], + "summary": "Aggregate for the Product Download resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductDownload", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductDownload", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-export": { "get": { "tags": [ @@ -36141,6 +42541,86 @@ } } }, + "/aggregate/product-export": { + "post": { + "tags": [ + "Product Export" + ], + "summary": "Aggregate for the Product Export resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductExport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductExport", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-feature-set": { "get": { "tags": [ @@ -36587,6 +43067,86 @@ } } }, + "/aggregate/product-feature-set": { + "post": { + "tags": [ + "Product Feature Set" + ], + "summary": "Aggregate for the Product Feature Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductFeatureSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductFeatureSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductFeatureSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-keyword-dictionary": { "get": { "tags": [ @@ -37033,6 +43593,86 @@ } } }, + "/aggregate/product-keyword-dictionary": { + "post": { + "tags": [ + "Product Keyword Dictionary" + ], + "summary": "Aggregate for the Product Keyword Dictionary resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductKeywordDictionary", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductKeywordDictionary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductKeywordDictionary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-manufacturer": { "get": { "tags": [ @@ -37479,6 +44119,86 @@ } } }, + "/aggregate/product-manufacturer": { + "post": { + "tags": [ + "Product Manufacturer" + ], + "summary": "Aggregate for the Product Manufacturer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductManufacturer", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductManufacturer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductManufacturer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-media": { "get": { "tags": [ @@ -37925,6 +44645,86 @@ } } }, + "/aggregate/product-media": { + "post": { + "tags": [ + "Product Media" + ], + "summary": "Aggregate for the Product Media resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductMedia", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductMedia", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-price": { "get": { "tags": [ @@ -38371,6 +45171,86 @@ } } }, + "/aggregate/product-price": { + "post": { + "tags": [ + "Product Price" + ], + "summary": "Aggregate for the Product Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-review": { "get": { "tags": [ @@ -38817,6 +45697,86 @@ } } }, + "/aggregate/product-review": { + "post": { + "tags": [ + "Product Review" + ], + "summary": "Aggregate for the Product Review resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductReview", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductReview", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-search-config": { "get": { "tags": [ @@ -39263,6 +46223,86 @@ } } }, + "/aggregate/product-search-config": { + "post": { + "tags": [ + "Product Search Config" + ], + "summary": "Aggregate for the Product Search Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-search-config-field": { "get": { "tags": [ @@ -39709,6 +46749,86 @@ } } }, + "/aggregate/product-search-config-field": { + "post": { + "tags": [ + "Product Search Config Field" + ], + "summary": "Aggregate for the Product Search Config Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchConfigField", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-search-keyword": { "get": { "tags": [ @@ -40155,6 +47275,86 @@ } } }, + "/aggregate/product-search-keyword": { + "post": { + "tags": [ + "Product Search Keyword" + ], + "summary": "Aggregate for the Product Search Keyword resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSearchKeyword", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSearchKeyword", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-sorting": { "get": { "tags": [ @@ -40601,6 +47801,86 @@ } } }, + "/aggregate/product-sorting": { + "post": { + "tags": [ + "Product Sorting" + ], + "summary": "Aggregate for the Product Sorting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductSorting", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductSorting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSorting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-stream": { "get": { "tags": [ @@ -41047,6 +48327,86 @@ } } }, + "/aggregate/product-stream": { + "post": { + "tags": [ + "Product Stream" + ], + "summary": "Aggregate for the Product Stream resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStream", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-stream-filter": { "get": { "tags": [ @@ -41493,6 +48853,86 @@ } } }, + "/aggregate/product-stream-filter": { + "post": { + "tags": [ + "Product Stream Filter" + ], + "summary": "Aggregate for the Product Stream Filter resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductStreamFilter", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/product-visibility": { "get": { "tags": [ @@ -41939,6 +49379,86 @@ } } }, + "/aggregate/product-visibility": { + "post": { + "tags": [ + "Product Visibility" + ], + "summary": "Aggregate for the Product Visibility resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductVisibility", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ProductVisibility", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion": { "get": { "tags": [ @@ -42385,6 +49905,86 @@ } } }, + "/aggregate/promotion": { + "post": { + "tags": [ + "Promotion" + ], + "summary": "Aggregate for the Promotion resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotion", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Promotion", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-discount": { "get": { "tags": [ @@ -42831,6 +50431,86 @@ } } }, + "/aggregate/promotion-discount": { + "post": { + "tags": [ + "Promotion Discount" + ], + "summary": "Aggregate for the Promotion Discount resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscount", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-discount-prices": { "get": { "tags": [ @@ -43277,6 +50957,86 @@ } } }, + "/aggregate/promotion-discount-prices": { + "post": { + "tags": [ + "Promotion Discount Prices" + ], + "summary": "Aggregate for the Promotion Discount Prices resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionDiscountPrices", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionDiscountPrices", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-individual-code": { "get": { "tags": [ @@ -43723,6 +51483,86 @@ } } }, + "/aggregate/promotion-individual-code": { + "post": { + "tags": [ + "Promotion Individual Code" + ], + "summary": "Aggregate for the Promotion Individual Code resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionIndividualCode", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionIndividualCode", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionIndividualCode" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-sales-channel": { "get": { "tags": [ @@ -44169,6 +52009,86 @@ } } }, + "/aggregate/promotion-sales-channel": { + "post": { + "tags": [ + "Promotion Sales Channel" + ], + "summary": "Aggregate for the Promotion Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/promotion-setgroup": { "get": { "tags": [ @@ -44615,6 +52535,86 @@ } } }, + "/aggregate/promotion-setgroup": { + "post": { + "tags": [ + "Promotion Setgroup" + ], + "summary": "Aggregate for the Promotion Setgroup resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePromotionSetgroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PromotionSetgroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionSetgroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/property-group": { "get": { "tags": [ @@ -45061,6 +53061,86 @@ } } }, + "/aggregate/property-group": { + "post": { + "tags": [ + "Property Group" + ], + "summary": "Aggregate for the Property Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/property-group-option": { "get": { "tags": [ @@ -45507,6 +53587,86 @@ } } }, + "/aggregate/property-group-option": { + "post": { + "tags": [ + "Property Group Option" + ], + "summary": "Aggregate for the Property Group Option resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregatePropertyGroupOption", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of PropertyGroupOption", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/rule": { "get": { "tags": [ @@ -45953,6 +54113,86 @@ } } }, + "/aggregate/rule": { + "post": { + "tags": [ + "Rule" + ], + "summary": "Aggregate for the Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Rule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/rule-condition": { "get": { "tags": [ @@ -46399,6 +54639,86 @@ } } }, + "/aggregate/rule-condition": { + "post": { + "tags": [ + "Rule Condition" + ], + "summary": "Aggregate for the Rule Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateRuleCondition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of RuleCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel": { "get": { "tags": [ @@ -46845,6 +55165,86 @@ } } }, + "/aggregate/sales-channel": { + "post": { + "tags": [ + "Sales Channel" + ], + "summary": "Aggregate for the Sales Channel resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannel", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannel", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel-analytics": { "get": { "tags": [ @@ -47291,6 +55691,86 @@ } } }, + "/aggregate/sales-channel-analytics": { + "post": { + "tags": [ + "Sales Channel Analytics" + ], + "summary": "Aggregate for the Sales Channel Analytics resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelAnalytics", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelAnalytics", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelAnalytics" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel-domain": { "get": { "tags": [ @@ -47737,6 +56217,86 @@ } } }, + "/aggregate/sales-channel-domain": { + "post": { + "tags": [ + "Sales Channel Domain" + ], + "summary": "Aggregate for the Sales Channel Domain resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelDomain", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelDomain", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/sales-channel-type": { "get": { "tags": [ @@ -48183,6 +56743,86 @@ } } }, + "/aggregate/sales-channel-type": { + "post": { + "tags": [ + "Sales Channel Type" + ], + "summary": "Aggregate for the Sales Channel Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalesChannelType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SalesChannelType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/salutation": { "get": { "tags": [ @@ -48629,6 +57269,86 @@ } } }, + "/aggregate/salutation": { + "post": { + "tags": [ + "Salutation" + ], + "summary": "Aggregate for the Salutation resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSalutation", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Salutation", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Salutation" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/scheduled-task": { "get": { "tags": [ @@ -49075,6 +57795,86 @@ } } }, + "/aggregate/scheduled-task": { + "post": { + "tags": [ + "Scheduled Task" + ], + "summary": "Aggregate for the Scheduled Task resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScheduledTask", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ScheduledTask", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ScheduledTask" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/script": { "get": { "tags": [ @@ -49521,6 +58321,86 @@ } } }, + "/aggregate/script": { + "post": { + "tags": [ + "Script" + ], + "summary": "Aggregate for the Script resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateScript", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Script", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Script" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/seo-url": { "get": { "tags": [ @@ -49967,6 +58847,86 @@ } } }, + "/aggregate/seo-url": { + "post": { + "tags": [ + "Seo Url" + ], + "summary": "Aggregate for the Seo Url resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrl", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrl", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/seo-url-template": { "get": { "tags": [ @@ -50413,6 +59373,86 @@ } } }, + "/aggregate/seo-url-template": { + "post": { + "tags": [ + "Seo Url Template" + ], + "summary": "Aggregate for the Seo Url Template resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSeoUrlTemplate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SeoUrlTemplate", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrlTemplate" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/shipping-method": { "get": { "tags": [ @@ -50859,6 +59899,86 @@ } } }, + "/aggregate/shipping-method": { + "post": { + "tags": [ + "Shipping Method" + ], + "summary": "Aggregate for the Shipping Method resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethod", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethod", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/shipping-method-price": { "get": { "tags": [ @@ -51305,6 +60425,86 @@ } } }, + "/aggregate/shipping-method-price": { + "post": { + "tags": [ + "Shipping Method Price" + ], + "summary": "Aggregate for the Shipping Method Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateShippingMethodPrice", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of ShippingMethodPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethodPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/snippet": { "get": { "tags": [ @@ -51751,6 +60951,86 @@ } } }, + "/aggregate/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Aggregate for the Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/snippet-set": { "get": { "tags": [ @@ -52197,6 +61477,86 @@ } } }, + "/aggregate/snippet-set": { + "post": { + "tags": [ + "Snippet Set" + ], + "summary": "Aggregate for the Snippet Set resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippetSet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SnippetSet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SnippetSet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine": { "get": { "tags": [ @@ -52643,6 +62003,86 @@ } } }, + "/aggregate/state-machine": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Aggregate for the State Machine resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachine", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachine", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachine" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine-history": { "get": { "tags": [ @@ -53089,6 +62529,86 @@ } } }, + "/aggregate/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Aggregate for the State Machine History resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine-state": { "get": { "tags": [ @@ -53535,6 +63055,86 @@ } } }, + "/aggregate/state-machine-state": { + "post": { + "tags": [ + "State Machine State" + ], + "summary": "Aggregate for the State Machine State resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineState", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineState", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineState" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/state-machine-transition": { "get": { "tags": [ @@ -53981,6 +63581,86 @@ } } }, + "/aggregate/state-machine-transition": { + "post": { + "tags": [ + "State Machine Transition" + ], + "summary": "Aggregate for the State Machine Transition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineTransition", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineTransition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineTransition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/system-config": { "get": { "tags": [ @@ -54427,6 +64107,86 @@ } } }, + "/aggregate/system-config": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Aggregate for the System Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSystemConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tag": { "get": { "tags": [ @@ -54873,6 +64633,86 @@ } } }, + "/aggregate/tag": { + "post": { + "tags": [ + "Tag" + ], + "summary": "Aggregate for the Tag resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTag", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Tag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax": { "get": { "tags": [ @@ -55319,6 +65159,86 @@ } } }, + "/aggregate/tax": { + "post": { + "tags": [ + "Tax" + ], + "summary": "Aggregate for the Tax resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTax", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Tax", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tax" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax-provider": { "get": { "tags": [ @@ -55765,6 +65685,86 @@ } } }, + "/aggregate/tax-provider": { + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Aggregate for the Tax Provider resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxProvider", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax-rule": { "get": { "tags": [ @@ -56211,6 +66211,86 @@ } } }, + "/aggregate/tax-rule": { + "post": { + "tags": [ + "Tax Rule" + ], + "summary": "Aggregate for the Tax Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRule", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/tax-rule-type": { "get": { "tags": [ @@ -56657,6 +66737,86 @@ } } }, + "/aggregate/tax-rule-type": { + "post": { + "tags": [ + "Tax Rule Type" + ], + "summary": "Aggregate for the Tax Rule Type resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxRuleType", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxRuleType", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRuleType" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/theme": { "get": { "tags": [ @@ -57103,6 +67263,86 @@ } } }, + "/aggregate/theme": { + "post": { + "tags": [ + "Theme" + ], + "summary": "Aggregate for the Theme resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTheme", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/unit": { "get": { "tags": [ @@ -57549,6 +67789,86 @@ } } }, + "/aggregate/unit": { + "post": { + "tags": [ + "Unit" + ], + "summary": "Aggregate for the Unit resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUnit", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of Unit", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Unit" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user": { "get": { "tags": [ @@ -57995,6 +68315,86 @@ } } }, + "/aggregate/user": { + "post": { + "tags": [ + "User" + ], + "summary": "Aggregate for the User resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUser", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of User", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user-access-key": { "get": { "tags": [ @@ -58441,6 +68841,86 @@ } } }, + "/aggregate/user-access-key": { + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Aggregate for the User Access Key resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user-config": { "get": { "tags": [ @@ -58887,6 +69367,86 @@ } } }, + "/aggregate/user-config": { + "post": { + "tags": [ + "User Config" + ], + "summary": "Aggregate for the User Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of UserConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/user-recovery": { "get": { "tags": [ @@ -59333,6 +69893,86 @@ } } }, + "/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": [ @@ -59779,6 +70419,86 @@ } } }, + "/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": [ @@ -60225,34 +70945,136 @@ } } }, - "/_action/indexing": { + "/aggregate/webhook-event-log": { "post": { + "tags": [ + "Webhook Event Log" + ], + "summary": "Aggregate for the Webhook Event Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhookEventLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of WebhookEventLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "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" + } + } + } + }, + "/_action/cleanup": { + "delete": { "tags": [ "System Operations" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cleanup finished." + } + } + } + }, + "/_info/events.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { "200": { - "description": "Returns an empty response indicating that the indexing process started." + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } } } } }, - "/_action/indexing/{indexer}": { + "/_action/order_transaction_capture_refund/{refundId}": { "post": { "tags": [ - "System Operations" + "Order Management" ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", "parameters": [ { - "name": "indexer", + "name": "refundId", "in": "path", - "description": "Name of the indexer to iterate.", + "description": "Identifier of the order transaction capture refund.", "required": true, "schema": { "type": "string", @@ -60260,41 +71082,149 @@ } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" + "responses": { + "204": { + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_info/flow-actions.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", + "responses": { + "200": { + "description": "Returns a list of action for flow builder.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flowBuilderActionsResponse" + } } } } - }, + } + } + }, + "/_action/cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } + }, + "/_action/cache-delayed": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } + }, + "/_info/health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Check that the Application is running", + "operationId": "healthCheck", "responses": { "200": { - "description": "Returns information about the iteration.", + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_info/system-health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" + } + ], + "responses": { + "200": { + "description": "Returns the system health check results", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } } - }, - "type": "object" + } } } } + }, + "500": { + "description": "Application is not working properly" } } } @@ -60359,67 +71289,117 @@ } } }, - "/_action/container_cache": { - "delete": { + "/_action/indexing": { + "post": { "tags": [ "System Operations" ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." + "200": { + "description": "Returns an empty response indicating that the indexing process started." } } } }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { + "/_action/indexing/{indexer}": { + "post": { "tags": [ - "Document Management" + "System Operations" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", "parameters": [ { - "name": "documentId", + "name": "indexer", "in": "path", - "description": "Identifier of the document to be downloaded.", + "description": "Name of the indexer to iterate.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, - "schema": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } } - }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false + } + }, + "responses": { + "200": { + "description": "Returns information about the iteration.", + "content": { + "application/json": { + "schema": { + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" + } + } } } - ], + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", "responses": { "200": { - "description": "The document.", + "description": "Successful operation", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } } } } @@ -60427,83 +71407,115 @@ } } }, - "/_action/document/{documentId}/upload": { + "/_action/sync": { "post": { "tags": [ - "Document Management" + "Bulk Operations" ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", "parameters": [ { - "name": "documentId", - "in": "path", - "description": "Identifier of the document the new file should be added to.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { - "type": "string" + "type": "boolean", + "default": true } }, { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", - "required": true, + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", "schema": { - "type": "string" + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] } } ], "requestBody": { + "required": true, "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" - } - }, - "type": "object" + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "filter": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + } + }, + "type": "object" + } } } } }, "responses": { "200": { - "description": "Document uploaded successful", + "description": "Returns a sync result containing information about the updated entities", "content": { "application/json": { "schema": { "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "data": { + "description": "Object with information about updated entities", + "type": "object" }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" } }, "type": "object" @@ -60514,23 +71526,144 @@ } } }, - "/_action/index": { + "/_action/mail-template/send": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], "type": "array", "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", "type": "string" } } @@ -60541,36 +71674,49 @@ } }, "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." + "200": { + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" + } + } + } } } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/mail-template/validate": { "post": { "tags": [ - "Customer impersonation" + "Mail Operations" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "customerId", - "salesChannelId" + "contentHtml", + "contentPlain" ], "properties": { - "customerId": { - "description": "ID of the customer", + "contentHtml": { + "description": "The content of the mail in HTML format.", "type": "string" }, - "salesChannelId": { - "description": "ID of the sales channel", + "contentPlain": { + "description": "The content of the mail as plain text.", "type": "string" } }, @@ -60580,55 +71726,72 @@ } }, "responses": { - "200": { - "description": "The generated customer impersonation token.", - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, - "/_action/order/document/download": { + "/_action/mail-template/build": { "post": { "tags": [ - "Document Management" + "Mail Operations" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", "requestBody": { - "description": "documentIds", + "required": true, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" } } } }, "responses": { "200": { - "description": "The documents.", + "description": "The rendered preview of the mail template.", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "string" } } } @@ -60636,16 +71799,125 @@ } } }, - "/_action/order/document/{documentTypeName}/create": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": [ - "Document Management" + "Order Management" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", - "parameters": [ - { + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", + "parameters": [ + { + "name": "orderDeliveryId", + "in": "path", + "description": "Identifier of the order delivery.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be send to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_action/order/document/download": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", + "requestBody": { + "description": "documentIds", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "responses": { + "200": { + "description": "The documents.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/order/document/{documentTypeName}/create": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", + "parameters": [ + { "name": "documentTypeName", "in": "path", "description": "The type of document to create", @@ -60783,31 +72055,89 @@ } } }, - "/_action/cache_info": { + "/_info/openapi3.json": { "get": { "tags": [ - "System Operations" + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", "responses": { "200": { - "description": "Information about the cache state.", + "$ref": "#/components/responses/OpenApi3" + } + } + } + }, + "/oauth/token": { + "post": { + "tags": [ + "Authorization & Authentication" + ], + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" + }, + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "Authorized successfully.", "content": { "application/json": { "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], "properties": { - "environment": { - "description": "The active environment.", + "token_type": { + "description": "Type of the token.", "type": "string" }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" }, - "cacheAdapter": { - "description": "The active cache adapter.", + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", "type": "string" } }, @@ -60815,110 +72145,89 @@ } } } - } - } - } - }, - "/_info/health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", - "responses": { - "200": { - "description": "Returns empty response" }, - "500": { - "description": "Application is not working properly" + "400": { + "$ref": "#/components/responses/400" } } } }, - "/_info/system-health-check": { - "get": { + "/_action/order/{orderId}/order-address": { + "post": { "tags": [ - "System Info & Health Check" + "Order address" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", "parameters": [ { - "name": "verbose", - "in": "query", - "required": false, + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } ], - "responses": { - "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "type": "string", + "description": "The ID of the delivery (optional)", + "nullable": true } - } - } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" } } } } }, - "500": { - "description": "Application is not working properly" + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." } } } }, - "/_info/events.json": { - "get": { + "/_action/container_cache": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "responses": { - "200": { - "description": "Returns a list of about the business events.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/businessEventsResponse" - } - } - } + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." } } } @@ -60945,50 +72254,6 @@ } } }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "endpoints" - ], - "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - }, "/_action/scheduled-task/run": { "post": { "tags": [ @@ -61045,90 +72310,123 @@ } } }, - "/_action/order/{orderId}/order-address": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ - "Order address" + "Order Management" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "orderId", + "name": "orderTransactionId", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier of the order transaction.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } } ], "requestBody": { + "required": false, "content": { "application/json": { "schema": { - "type": "object", "properties": { - "mapping": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", "type": "array", "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "type": "string", - "description": "The ID of the delivery (optional)", - "nullable": true - } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" } - } + }, + "type": "object" } } - }, - "required": true + } }, "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." + "200": { + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/_info/flow-actions.json": { - "get": { + "/_action/index": { + "post": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" - } + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" } } } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." + } + } + } + }, + "/_action/index-products": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." + } } } }, @@ -61208,161 +72506,24 @@ } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { - "post": { + "/_info/version": { + "get": { "tags": [ - "Order Management" - ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", - "parameters": [ - { - "name": "orderDeliveryId", - "in": "path", - "description": "Identifier of the order delivery.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", - "required": true, - "schema": { - "type": "string" - } - } + "System Info & Health Check" ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be send to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - } - }, - "type": "object" - } - } - } - }, + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" - } - } - } - }, - "/_action/sync": { - "post": { - "tags": [ - "Bulk Operations" - ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", - "parameters": [ - { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", - "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", - "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } - }, - "filter": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } + "version": { + "description": "The Shopware version.", + "type": "string" } }, "type": "object" @@ -61370,25 +72531,35 @@ } } } - }, + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "Returns a sync result containing information about the updated entities", + "description": "Information about the cache state.", "content": { "application/json": { "schema": { "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" + "environment": { + "description": "The active environment.", + "type": "string" }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" } }, "type": "object" @@ -61399,146 +72570,31 @@ } } }, - "/_action/mail-template/send": { + "/_proxy/generate-imitate-customer-token": { "post": { "tags": [ - "Mail Operations" + "Customer impersonation" ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" + "customerId", + "salesChannelId" ], "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", + "customerId": { + "description": "ID of the customer", "type": "string" }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "salesChannelId": { + "description": "ID of the sales channel", "type": "string" - }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } } }, "type": "object" @@ -61548,14 +72604,14 @@ }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "token": { + "description": "The generated customer impersonation token", + "type": "string" } }, "type": "object" @@ -61566,105 +72622,52 @@ } } }, - "/_action/mail-template/validate": { - "post": { + "/_action/document/{documentId}/{deepLinkCode}": { + "get": { "tags": [ - "Mail Operations" + "Document Management" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" - } + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } - } - }, - "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." - } - } - } - }, - "/_action/mail-template/build": { - "post": { - "tags": [ - "Mail Operations" - ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], - "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" - } - }, - "type": "object" - } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false } } - }, + ], "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "The document.", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "type": "string" + "type": "string", + "format": "binary" } } } @@ -61672,19 +72675,19 @@ } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/_action/document/{documentId}/upload": { "post": { "tags": [ - "Order Management" + "Document Management" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", "parameters": [ { - "name": "orderTransactionId", + "name": "documentId", "in": "path", - "description": "Identifier of the order transaction.", + "description": "Identifier of the document the new file should be added to.", "required": true, "schema": { "type": "string", @@ -61692,9 +72695,18 @@ } }, { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", "required": true, "schema": { "type": "string" @@ -61702,34 +72714,22 @@ } ], "requestBody": { - "required": false, "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { + "required": [ + "url" + ], "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" } }, "type": "object" @@ -61739,56 +72739,26 @@ }, "responses": { "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" - } - } - } - }, - "/_action/order_transaction_capture_refund/{refundId}": { - "post": { - "tags": [ - "Order Management" - ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", - "parameters": [ - { - "name": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": "Document uploaded successful", + "content": { + "application/json": { + "schema": { + "properties": { + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", + "type": "string" + } + }, + "type": "object" + } + } } } - ], - "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" - } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." - } } } }, @@ -61838,176 +72808,6 @@ } } } - }, - "/_info/openapi3.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] - } - } - ], - "responses": { - "200": { - "$ref": "#/components/responses/OpenApi3" - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/cleanup": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." - } - } - } - }, - "/oauth/token": { - "post": { - "tags": [ - "Authorization & Authentication" - ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "Authorized successfully.", - "content": { - "application/json": { - "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], - "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - } - } - } - }, - "/_info/version": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } } }, "components": { @@ -64828,6 +75628,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -64909,6 +75712,9 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of app." }, + "hash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -68632,6 +79438,9 @@ "allowCartExpose": { "type": "boolean" }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -68754,6 +79563,9 @@ "type": "boolean", "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process." }, + "storeApiAware": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -69204,21 +80016,12 @@ "lastName": { "type": "string" }, - "company": { - "type": "string" - }, "email": { "type": "string" }, "title": { "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, "affiliateCode": { "type": "string" }, @@ -69298,9 +80101,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -69470,6 +80270,35 @@ }, "type": "object" }, + "activeBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } + } + }, + "type": "object" + }, "defaultShippingAddress": { "properties": { "links": { @@ -69499,6 +80328,35 @@ }, "type": "object" }, + "activeShippingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } + } + }, + "type": "object" + }, "salutation": { "properties": { "links": { @@ -69970,10 +80828,6 @@ "type": "string", "description": "Last name of the customer." }, - "company": { - "type": "string", - "description": "Company name of the customer." - }, "email": { "type": "string", "description": "Email ID of the customer." @@ -69982,13 +80836,6 @@ "type": "string", "description": "Titles or honorifics like Mr, Mrs, etc." }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Unique identity of VAT." - }, "affiliateCode": { "type": "string", "description": "An affiliate code is an identification option with which website operators can mark outgoing links." @@ -70088,10 +80935,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of bonus sales channel." }, - "accountType": { - "type": "string", - "description": "Account type can be personal or business." - }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -70130,9 +80973,15 @@ "defaultBillingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, "defaultShippingAddress": { "$ref": "#/components/schemas/CustomerAddress" }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, "salutation": { "$ref": "#/components/schemas/Salutation" }, @@ -70189,6 +81038,15 @@ }, "defaultPaymentMethod": { "$ref": "#/components/schemas/PaymentMethod" + }, + "company": { + "description": "Company name of the customer." + }, + "vatIds": { + "description": "Unique identity of VAT." + }, + "accountType": { + "description": "Account type can be personal or business." } }, "type": "object" @@ -70263,6 +81121,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -70483,6 +81345,10 @@ "type": "string", "description": "Additional customer's address information." }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -71465,10 +82331,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -71479,9 +82345,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -71494,6 +82357,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -71516,6 +82383,9 @@ "customFields": { "type": "object" }, + "fileType": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -71674,6 +82544,35 @@ } }, "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -71688,10 +82587,10 @@ "required": [ "id", "documentTypeId", - "fileType", "orderId", "config", - "deepLinkCode" + "deepLinkCode", + "fileType" ], "properties": { "id": { @@ -71704,10 +82603,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document type." }, - "fileType": { - "type": "string", - "description": "Type of file like PDF." - }, "referencedDocumentId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -71723,6 +82618,10 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of document media file." }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -71751,6 +82650,10 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "fileType": { + "type": "string", + "description": "Type of file like PDF." + }, "createdAt": { "type": "string", "format": "date-time", @@ -71778,6 +82681,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -75918,8 +86824,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "readOnly": true + "type": "string" }, "fileExtension": { "type": "string", @@ -75931,8 +86836,7 @@ "readOnly": true }, "fileName": { - "type": "string", - "readOnly": true + "type": "string" }, "fileSize": { "type": "integer", @@ -75973,6 +86877,9 @@ "customFields": { "type": "object" }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -76795,7 +87702,6 @@ }, "mimeType": { "type": "string", - "readOnly": true, "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg." }, "fileExtension": { @@ -76811,7 +87717,6 @@ }, "fileName": { "type": "string", - "readOnly": true, "description": "Name of the media file uploaded." }, "fileSize": { @@ -76860,6 +87765,9 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "fileHash": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -80379,6 +91287,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -80644,6 +91556,10 @@ "type": "string", "description": "Additional address input if necessary." }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -102467,348 +113383,6 @@ }, "type": "object" }, - "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" - ] - } - ] - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "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" - } - } - } - }, - "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" - } - } - } - }, - "properties": { - "name": { - "description": "Unique name of the businessEventsResponse." - }, - "class": { - "description": "Class name of business event." - }, - "data": { - "description": "Internal field." - }, - "aware": { - "description": "Parameter that indicates the areas in which the business event is supported." - }, - "extensions": { - "description": "Internal field." - } - } - }, - "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." - } - } - } - } - }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -103535,6 +114109,348 @@ "field" ] }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "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" + ] + } + ] + }, + "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" + } + } + } + }, + "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" + } + } + } + }, + "properties": { + "name": { + "description": "Unique name of the businessEventsResponse." + }, + "class": { + "description": "Class name of business event." + }, + "data": { + "description": "Internal field." + }, + "aware": { + "description": "Parameter that indicates the areas in which the business event is supported." + }, + "extensions": { + "description": "Internal field." + } + } + }, "Cart": { "properties": { "id": { @@ -105378,7 +116294,7 @@ "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", - "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { diff --git a/adminapi.summary.json b/adminapi.summary.json index ad55780..3f59c69 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -38,6 +38,141 @@ "/_proxy/generate-imitate-customer-token", "/acl-role", "/acl-role/{id}", + "/aggregate/acl-role", + "/aggregate/app", + "/aggregate/app-action-button", + "/aggregate/app-administration-snippet", + "/aggregate/app-cms-block", + "/aggregate/app-flow-action", + "/aggregate/app-flow-event", + "/aggregate/app-payment-method", + "/aggregate/app-script-condition", + "/aggregate/app-shipping-method", + "/aggregate/app-template", + "/aggregate/category", + "/aggregate/cms-block", + "/aggregate/cms-page", + "/aggregate/cms-section", + "/aggregate/cms-slot", + "/aggregate/country", + "/aggregate/country-state", + "/aggregate/currency", + "/aggregate/currency-country-rounding", + "/aggregate/custom-entity", + "/aggregate/custom-field", + "/aggregate/custom-field-set", + "/aggregate/custom-field-set-relation", + "/aggregate/customer", + "/aggregate/customer-address", + "/aggregate/customer-group", + "/aggregate/customer-recovery", + "/aggregate/customer-wishlist", + "/aggregate/customer-wishlist-product", + "/aggregate/delivery-time", + "/aggregate/document", + "/aggregate/document-base-config", + "/aggregate/document-base-config-sales-channel", + "/aggregate/document-type", + "/aggregate/flow", + "/aggregate/flow-sequence", + "/aggregate/flow-template", + "/aggregate/import-export-file", + "/aggregate/import-export-log", + "/aggregate/import-export-profile", + "/aggregate/integration", + "/aggregate/landing-page", + "/aggregate/language", + "/aggregate/locale", + "/aggregate/log-entry", + "/aggregate/mail-header-footer", + "/aggregate/mail-template", + "/aggregate/mail-template-type", + "/aggregate/main-category", + "/aggregate/media", + "/aggregate/media-default-folder", + "/aggregate/media-folder", + "/aggregate/media-folder-configuration", + "/aggregate/media-thumbnail", + "/aggregate/media-thumbnail-size", + "/aggregate/newsletter-recipient", + "/aggregate/notification", + "/aggregate/number-range", + "/aggregate/number-range-sales-channel", + "/aggregate/number-range-state", + "/aggregate/number-range-type", + "/aggregate/order", + "/aggregate/order-address", + "/aggregate/order-customer", + "/aggregate/order-delivery", + "/aggregate/order-delivery-position", + "/aggregate/order-line-item", + "/aggregate/order-line-item-download", + "/aggregate/order-transaction", + "/aggregate/order-transaction-capture", + "/aggregate/order-transaction-capture-refund", + "/aggregate/order-transaction-capture-refund-position", + "/aggregate/payment-method", + "/aggregate/plugin", + "/aggregate/product", + "/aggregate/product-configurator-setting", + "/aggregate/product-cross-selling", + "/aggregate/product-cross-selling-assigned-products", + "/aggregate/product-download", + "/aggregate/product-export", + "/aggregate/product-feature-set", + "/aggregate/product-keyword-dictionary", + "/aggregate/product-manufacturer", + "/aggregate/product-media", + "/aggregate/product-price", + "/aggregate/product-review", + "/aggregate/product-search-config", + "/aggregate/product-search-config-field", + "/aggregate/product-search-keyword", + "/aggregate/product-sorting", + "/aggregate/product-stream", + "/aggregate/product-stream-filter", + "/aggregate/product-visibility", + "/aggregate/promotion", + "/aggregate/promotion-discount", + "/aggregate/promotion-discount-prices", + "/aggregate/promotion-individual-code", + "/aggregate/promotion-sales-channel", + "/aggregate/promotion-setgroup", + "/aggregate/property-group", + "/aggregate/property-group-option", + "/aggregate/rule", + "/aggregate/rule-condition", + "/aggregate/sales-channel", + "/aggregate/sales-channel-analytics", + "/aggregate/sales-channel-domain", + "/aggregate/sales-channel-type", + "/aggregate/salutation", + "/aggregate/scheduled-task", + "/aggregate/script", + "/aggregate/seo-url", + "/aggregate/seo-url-template", + "/aggregate/shipping-method", + "/aggregate/shipping-method-price", + "/aggregate/snippet", + "/aggregate/snippet-set", + "/aggregate/state-machine", + "/aggregate/state-machine-history", + "/aggregate/state-machine-state", + "/aggregate/state-machine-transition", + "/aggregate/system-config", + "/aggregate/tag", + "/aggregate/tax", + "/aggregate/tax-provider", + "/aggregate/tax-rule", + "/aggregate/tax-rule-type", + "/aggregate/theme", + "/aggregate/unit", + "/aggregate/user", + "/aggregate/user-access-key", + "/aggregate/user-config", + "/aggregate/user-recovery", + "/aggregate/webhook", + "/aggregate/webhook-event-log", "/app", "/app-action-button", "/app-action-button/{id}", From 3acfe2b1c2997a62f6c362faf78bd46a71f01c4a Mon Sep 17 00:00:00 2001 From: Micha Date: Tue, 13 May 2025 10:32:55 +0200 Subject: [PATCH 42/63] chore: add-links --- toc.json | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/toc.json b/toc.json index d6cc01e..2f2ea59 100644 --- a/toc.json +++ b/toc.json @@ -41,7 +41,8 @@ { "type": "item", "title": "Authentication & Authorisation", - "uri": "docs/concepts/authentication-authorisation.md" + "uri": "docs/concepts/authentication-authorisation.md", + "slug": "authentication" }, { "type": "item", @@ -55,7 +56,8 @@ { "type": "item", "title": "Overview", - "uri": "docs/concepts/endpoint-structure/request-response-structure.md" + "uri": "docs/concepts/endpoint-structure/request-response-structure.md", + "slug": "request-and-response-structure" }, { "type": "item", @@ -152,4 +154,4 @@ "uri": "SwagCustomizedProducts-adminapi.json" } ] -} \ No newline at end of file +} From 74383fcedbfbd11b11c4c172f2a7d5af86eb9f01 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 17 Jun 2025 16:04:47 +0200 Subject: [PATCH 43/63] [create-pull-request] automated change (#362) Co-authored-by: shopwareBot --- adminapi.json | 2634 ++++++++++++++++++++++++------------------------- 1 file changed, 1282 insertions(+), 1352 deletions(-) diff --git a/adminapi.json b/adminapi.json index cc8f672..0cfcfdd 100644 --- a/adminapi.json +++ b/adminapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.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`.", @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.10.4" + "version": "6.7.0.0" }, "servers": [ { @@ -71040,366 +71040,36 @@ } } }, - "/_info/events.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", - "responses": { - "200": { - "description": "Returns a list of about the business events.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/businessEventsResponse" - } - } - } - } - } - } - }, - "/_action/order_transaction_capture_refund/{refundId}": { + "/_action/order/document/download": { "post": { - "tags": [ - "Order Management" - ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", - "parameters": [ - { - "name": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" - } - } - } - }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" - } - } - } - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_info/health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", - "responses": { - "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" - } - } - } - }, - "/_info/system-health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", - "parameters": [ - { - "name": "verbose", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" - } - ], - "responses": { - "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Application is not working properly" - } - } - } - }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { "tags": [ "Document Management" ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "description": "Number range not found" - } - } - } - }, - "/_action/indexing": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", - "responses": { - "200": { - "description": "Returns an empty response indicating that the indexing process started." - } - } - } - }, - "/_action/indexing/{indexer}": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", - "parameters": [ - { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", "requestBody": { + "description": "documentIds", "content": { "application/json": { "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Returns information about the iteration.", - "content": { - "application/json": { - "schema": { - "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" - } - }, - "type": "object" + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } } } - } - } - }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", + }, "responses": { "200": { - "description": "Successful operation", + "description": "The documents.", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "type": "object", - "required": [ - "endpoints" - ], - "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } - } - } + "type": "string", + "format": "binary" } } } @@ -71407,411 +71077,94 @@ } } }, - "/_action/sync": { + "/_action/order/document/{documentTypeName}/create": { "post": { "tags": [ - "Bulk Operations" + "Document Management" ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", "parameters": [ { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "name": "documentTypeName", + "in": "path", + "description": "The type of document to create", + "required": true, "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] + "type": "string" } } ], "requestBody": { + "description": "test", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { + "type": "object", "required": [ - "action", - "entity", - "payload" + "orderId", + "type" ], "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", + "orderId": { + "description": "Identifier of the order.", "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } + "pattern": "^[0-9a-f]{32}$" }, - "filter": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - } - }, - "type": "object" - } - } - } - } - }, - "responses": { - "200": { - "description": "Returns a sync result containing information about the updated entities", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" + "type": { + "description": "Type of the document to be generated.", + "type": "string" }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/mail-template/send": { - "post": { - "tags": [ - "Mail Operations" - ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], - "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" - }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", "type": "string", + "default": "null", "pattern": "^[0-9a-f]{32}$" - } - }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" } } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "The mail was sent successful", - "content": { - "application/json": { - "schema": { - "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" - } - }, - "type": "object" } } } } - } - } - }, - "/_action/mail-template/validate": { - "post": { - "tags": [ - "Mail Operations" - ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." - } - } - } - }, - "/_action/mail-template/build": { - "post": { - "tags": [ - "Mail Operations" - ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], - "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" - } - }, - "type": "object" - } - } - } }, "responses": { "200": { - "description": "The rendered preview of the mail template.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", "parameters": [ { - "name": "orderDeliveryId", + "name": "orderId", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Identifier of the order.", "required": true, "schema": { "type": "string", @@ -71821,7 +71174,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -71835,7 +71188,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be send to the customer." + "description": "Controls if a mail should be sent to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -71854,7 +71207,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "description": "This is the state column within the order database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" } @@ -71871,31 +71224,47 @@ } } }, - "/_action/order/document/download": { - "post": { + "/_action/document/{documentId}/{deepLinkCode}": { + "get": { "tags": [ "Document Management" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", - "requestBody": { - "description": "documentIds", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false } } - }, + ], "responses": { "200": { - "description": "The documents.", + "description": "The document.", "content": { "application/octet-stream": { "schema": { @@ -71908,19 +71277,38 @@ } } }, - "/_action/order/document/{documentTypeName}/create": { + "/_action/document/{documentId}/upload": { "post": { "tags": [ "Document Management" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", "parameters": [ { - "name": "documentTypeName", + "name": "documentId", "in": "path", - "description": "The type of document to create", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", "required": true, "schema": { "type": "string" @@ -71928,69 +71316,62 @@ } ], "requestBody": { - "description": "test", - "required": true, "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "required": [ - "orderId", - "type" - ], + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Document uploaded successful", + "content": { + "application/json": { + "schema": { "properties": { - "orderId": { - "description": "Identifier of the order.", + "documentId": { + "description": "Identifier of the document.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "description": "Type of the document to be generated.", + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", - "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", - "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" } - } + }, + "type": "object" } } } } - }, - "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." - } } } }, - "/_action/order/{orderId}/state/{transition}": { + "/_action/order/{orderId}/order-address": { "post": { "tags": [ - "Order Management" + "Order address" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", "parameters": [ { "name": "orderId", @@ -72001,85 +71382,77 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { - "required": false, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", + "mapping": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "description": "The ID of the delivery (optional)", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" } - }, - "type": "object" + } } } - } + }, + "required": true }, "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "204": { + "description": "Returns a no content response indicating that the update has been made." } } } }, - "/_info/openapi3.json": { + "/_info/events.json": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] - } - } - ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } } } } @@ -72152,82 +71525,275 @@ } } }, - "/_action/order/{orderId}/order-address": { + "/_action/mail-template/send": { "post": { "tags": [ - "Order address" - ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } + "Mail Operations" ], + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], "properties": { - "mapping": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], "type": "array", "items": { - "type": "object", "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" + "content": { + "description": "Binary content of the attachment.", + "type": "string" }, - "type": { - "type": "string", - "description": "The type of the address" + "fileName": { + "description": "File name of the attachment.", + "type": "string" }, - "deliveryId": { - "type": "string", - "description": "The ID of the delivery (optional)", - "nullable": true + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" } }, - "required": [ - "customerAddressId", - "type" - ] + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" }, - "description": "The mapping of order addresses" + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" } } } - }, - "required": true + } + } + } + }, + "/_action/mail-template/validate": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "contentHtml", + "contentPlain" + ], + "properties": { + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + } + }, + "type": "object" + } + } + } }, "responses": { "204": { - "description": "Returns a no content response indicating that the update has been made." + "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, - "/_action/container_cache": { - "delete": { + "/_action/mail-template/build": { + "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } } } } @@ -72254,6 +71820,28 @@ } } }, + "/_info/flow-actions.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", + "responses": { + "200": { + "description": "Returns a list of action for flow builder.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flowBuilderActionsResponse" + } + } + } + } + } + } + }, "/_action/scheduled-task/run": { "post": { "tags": [ @@ -72301,83 +71889,197 @@ "description": "Minimal interval in seconds.", "type": "string" } - }, - "type": "object" + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/indexing": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", + "parameters": [ + { + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns information about the iteration.", + "content": { + "application/json": { + "schema": { + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Check that the Application is running", + "operationId": "healthCheck", + "responses": { + "200": { + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_info/system-health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" + } + ], + "responses": { + "200": { + "description": "Returns the system health check results", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + } } } } + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { - "post": { + "/_action/cache": { + "delete": { "tags": [ - "Order Management" + "System Operations" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", - "parameters": [ - { - "name": "orderTransactionId", - "in": "path", - "description": "Identifier of the order transaction.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", - "required": true, - "schema": { - "type": "string" - } + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } + } + } + }, + "/_action/cache-delayed": { + "delete": { + "tags": [ + "System Operations" ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - } - }, - "type": "object" - } - } - } - }, + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", "responses": { - "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } @@ -72415,114 +72117,52 @@ } } }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." - } - } - } - }, - "/_action/media/{mediaId}/upload": { - "post": { + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { "tags": [ - "Asset Management" + "Document Management" ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", "parameters": [ { - "name": "mediaId", + "name": "type", "in": "path", - "description": "Identifier of the media entity.", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, "schema": { "type": "string" } }, { - "name": "extension", + "name": "preview", "in": "query", - "description": "Extension of the uploaded file. For example `png`", - "required": true, + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", - "schema": { - "type": "string" - } - } + "type": "boolean" } } - } - } - }, - "/_info/version": { - "get": { - "tags": [ - "System Info & Health Check" ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "Returns the version of the Shopware instance.", + "description": "The generated number", "content": { "application/json": { "schema": { "properties": { - "version": { - "description": "The Shopware version.", + "number": { + "description": "The generated (or previewed) document number.", "type": "string" } }, @@ -72530,42 +72170,71 @@ } } } + }, + "400": { + "description": "Number range not found" } } } }, - "/_action/cache_info": { + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", + "parameters": [ + { + "name": "refundId", + "in": "path", + "description": "Identifier of the order transaction capture refund.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_info/openapi3.json": { "get": { "tags": [ - "System Operations" + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", "responses": { "200": { - "description": "Information about the cache state.", - "content": { - "application/json": { - "schema": { - "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" - }, - "cacheAdapter": { - "description": "The active cache adapter.", - "type": "string" - } - }, - "type": "object" - } - } - } + "$ref": "#/components/responses/OpenApi3" } } } @@ -72622,19 +72291,19 @@ } } }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "post": { "tags": [ - "Document Management" + "Order Management" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", "parameters": [ { - "name": "documentId", + "name": "orderDeliveryId", "in": "path", - "description": "Identifier of the document to be downloaded.", + "description": "Identifier of the order delivery.", "required": true, "schema": { "type": "string", @@ -72642,32 +72311,95 @@ } }, { - "name": "deepLinkCode", + "name": "transition", "in": "path", - "description": "A unique hash code which was generated when the document was created.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", "required": true, "schema": { "type": "string" } - }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be send to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { - "description": "The document.", + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "responses": { + "200": { + "description": "Successful operation", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } } } } @@ -72675,19 +72407,121 @@ } } }, - "/_action/document/{documentId}/upload": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ - "Document Management" + "Order Management" ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "documentId", + "name": "orderTransactionId", "in": "path", - "description": "Identifier of the document the new file should be added to.", + "description": "Identifier of the order transaction.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" + } + } + } + }, + "/_action/index-products": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." + } + } + } + }, + "/_action/container_cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." + } + } + } + }, + "/_action/media/{mediaId}/upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "Identifier of the media entity.", "required": true, "schema": { "type": "string", @@ -72697,8 +72531,7 @@ { "name": "fileName", "in": "query", - "description": "Name of the uploaded file.", - "required": true, + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", "schema": { "type": "string" } @@ -72706,7 +72539,7 @@ { "name": "extension", "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", + "description": "Extension of the uploaded file. For example `png`", "required": true, "schema": { "type": "string" @@ -72728,7 +72561,7 @@ ], "properties": { "url": { - "description": "The url of the document that will be downloaded.", + "description": "The url of the media file that will be downloaded.", "type": "string" } }, @@ -72737,20 +72570,74 @@ } } }, + "responses": { + "204": { + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "Document uploaded successful", + "description": "Information about the cache state.", "content": { "application/json": { "schema": { "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "environment": { + "description": "The active environment.", + "type": "string" }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/version": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", + "responses": { + "200": { + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The Shopware version.", "type": "string" } }, @@ -72762,6 +72649,125 @@ } } }, + "/_action/sync": { + "post": { + "tags": [ + "Bulk Operations" + ], + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", + "parameters": [ + { + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "schema": { + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "filter": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + } + }, + "type": "object" + } + } + } + } + }, + "responses": { + "200": { + "description": "Returns a sync result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" + } + }, + "type": "object" + } + } + } + } + } + } + }, "/_action/message-queue/consume": { "post": { "tags": [ @@ -73187,8 +73193,7 @@ "privileges": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, "deletedAt": { @@ -73329,8 +73334,7 @@ "privileges": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" }, "description": "Privileges like read, write, delete, etc." }, @@ -76594,6 +76598,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { "type": "integer", "format": "int64" @@ -76656,14 +76668,6 @@ "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", @@ -76787,6 +76791,16 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS block." }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS Block version." + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS Section version." + }, "position": { "type": "integer", "format": "int64", @@ -76867,16 +76881,6 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS Block version." - }, - "cmsSectionVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS Section version." - }, "createdAt": { "type": "string", "format": "date-time", @@ -77282,6 +77286,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { "type": "integer", "format": "int64" @@ -77335,14 +77347,6 @@ "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", @@ -77466,6 +77470,16 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS section." }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS section's version." + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS page version." + }, "position": { "type": "integer", "format": "int64", @@ -77534,16 +77548,6 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS section's version." - }, - "cmsPageVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page version." - }, "createdAt": { "type": "string", "format": "date-time", @@ -77591,6 +77595,13 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { "type": "string" }, @@ -77614,13 +77625,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -77691,6 +77695,15 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Unique identity of CMS block version." + }, + "fieldConfig": { + "type": "object", + "description": "Con info of cms slot" + }, "type": { "type": "string", "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc." @@ -77721,15 +77734,6 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of CMS block where slot is defined." }, - "fieldConfig": { - "type": "object", - "description": "Con info of cms slot" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS block version." - }, "createdAt": { "type": "string", "format": "date-time", @@ -79966,8 +79970,7 @@ "customerNumber", "firstName", "lastName", - "email", - "defaultPaymentMethodId" + "email" ], "properties": { "id": { @@ -80109,10 +80112,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -80716,35 +80715,6 @@ } }, "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" @@ -80766,8 +80736,7 @@ "customerNumber", "firstName", "lastName", - "email", - "defaultPaymentMethodId" + "email" ], "properties": { "id": { @@ -80943,11 +80912,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of default payment method." - }, "createdAt": { "type": "string", "format": "date-time", @@ -81036,8 +81000,8 @@ "updatedBy": { "$ref": "#/components/schemas/User" }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "defaultPaymentMethodId": { + "description": "Unique identity of default payment method." }, "company": { "description": "Company name of the customer." @@ -82333,8 +82297,7 @@ "documentTypeId", "orderId", "config", - "deepLinkCode", - "fileType" + "deepLinkCode" ], "properties": { "id": { @@ -82383,9 +82346,6 @@ "customFields": { "type": "object" }, - "fileType": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -82589,8 +82549,7 @@ "documentTypeId", "orderId", "config", - "deepLinkCode", - "fileType" + "deepLinkCode" ], "properties": { "id": { @@ -82650,10 +82609,6 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, - "fileType": { - "type": "string", - "description": "Type of file like PDF." - }, "createdAt": { "type": "string", "format": "date-time", @@ -82684,6 +82639,9 @@ }, "documentA11yMediaFile": { "$ref": "#/components/schemas/Media" + }, + "fileType": { + "description": "Type of file like PDF." } }, "type": "object" @@ -84338,6 +84296,7 @@ { "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", @@ -84349,6 +84308,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, @@ -84379,12 +84341,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -84443,6 +84399,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", @@ -84455,6 +84412,9 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of import-export profile." }, + "technicalName": { + "type": "string" + }, "label": { "type": "string", "description": "Label given to ImportExportProfile." @@ -84493,13 +84453,6 @@ "type": "object", "description": "Specifies detailed information about the component." }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string", - "description": "Unique name of the import-export file." - }, "createdAt": { "type": "string", "format": "date-time", @@ -84519,6 +84472,9 @@ "items": { "$ref": "#/components/schemas/ImportExportLog" } + }, + "name": { + "description": "Unique name of the import-export file." } }, "type": "object" @@ -90320,9 +90276,15 @@ "customerComment": { "type": "string" }, + "internalComment": { + "type": "string" + }, "source": { "type": "string" }, + "taxCalculationType": { + "type": "string" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -91055,10 +91017,16 @@ "type": "string", "description": "Comments given by comments." }, + "internalComment": { + "type": "string" + }, "source": { "type": "string", "description": "Source of orders either via normal order placement or subscriptions." }, + "taxCalculationType": { + "type": "string" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -95111,6 +95079,7 @@ { "required": [ "id", + "technicalName", "name" ], "properties": { @@ -95161,38 +95130,13 @@ "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 + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -95460,6 +95404,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "name" ], "properties": { @@ -95522,38 +95467,13 @@ "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 + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -103306,6 +103226,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -103519,6 +103443,10 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media." }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -107939,6 +107867,7 @@ { "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -107950,6 +107879,9 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { "type": "boolean" }, @@ -107985,9 +107917,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -108315,6 +108244,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -108328,6 +108258,9 @@ "type": "string", "description": "Name of the shipping method." }, + "technicalName": { + "type": "string" + }, "active": { "type": "boolean", "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." @@ -108373,9 +108306,6 @@ "type": "string", "description": "This URL allows to track packages." }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -113383,6 +113313,32 @@ }, "type": "object" }, + "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" + } + } + } + }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -114250,6 +114206,57 @@ } } }, + "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" + } + } + } + }, + "properties": { + "name": { + "description": "Unique name of the businessEventsResponse." + }, + "class": { + "description": "Class name of business event." + }, + "data": { + "description": "Internal field." + }, + "aware": { + "description": "Parameter that indicates the areas in which the business event is supported." + }, + "extensions": { + "description": "Internal field." + } + } + }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", @@ -114374,83 +114381,6 @@ } ] }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "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" - } - } - } - }, - "properties": { - "name": { - "description": "Unique name of the businessEventsResponse." - }, - "class": { - "description": "Class name of business event." - }, - "data": { - "description": "Internal field." - }, - "aware": { - "description": "Parameter that indicates the areas in which the business event is supported." - }, - "extensions": { - "description": "Internal field." - } - } - }, "Cart": { "properties": { "id": { From 3928a61c051024031c065729750a4951cf150967 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 17 Jun 2025 16:05:44 +0200 Subject: [PATCH 44/63] [create-pull-request] automated change (#367) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 12620 ++--------------- SwagCustomizedProducts-adminapi.summary.json | 135 - 2 files changed, 910 insertions(+), 11845 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index ea8674c..d0c48f0 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.6.10.4" + "version": "6.6.10.5" }, "servers": [ { @@ -15,10746 +15,14 @@ } ], "paths": { - "/aggregate/acl-role": { - "post": { - "tags": [ - "Acl Role" - ], - "summary": "Aggregate for the Acl Role resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAclRole", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of AclRole", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app": { - "post": { - "tags": [ - "App" - ], - "summary": "Aggregate for the App resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateApp", - "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 App", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/App" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/App" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-action-button": { - "post": { - "tags": [ - "App Action Button" - ], - "summary": "Aggregate for the App Action Button resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppActionButton", - "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 AppActionButton", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppActionButton" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-administration-snippet": { - "post": { - "tags": [ - "App Administration Snippet" - ], - "summary": "Aggregate for the App Administration Snippet resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppAdministrationSnippet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of AppAdministrationSnippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-cms-block": { - "post": { - "tags": [ - "App Cms Block" - ], - "summary": "Aggregate for the App Cms Block resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppCmsBlock", - "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 AppCmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-flow-action": { - "post": { - "tags": [ - "App Flow Action" - ], - "summary": "Aggregate for the App Flow Action resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppFlowAction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of AppFlowAction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowAction" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-flow-event": { - "post": { - "tags": [ - "App Flow Event" - ], - "summary": "Aggregate for the App Flow Event resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppFlowEvent", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of AppFlowEvent", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-payment-method": { - "post": { - "tags": [ - "App Payment Method" - ], - "summary": "Aggregate for the App Payment Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppPaymentMethod", - "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 AppPaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-script-condition": { - "post": { - "tags": [ - "App Script Condition" - ], - "summary": "Aggregate for the App Script Condition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppScriptCondition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of AppScriptCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppScriptCondition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-shipping-method": { - "post": { - "tags": [ - "App Shipping Method" - ], - "summary": "Aggregate for the App Shipping Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppShippingMethod", - "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 AppShippingMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/app-template": { - "post": { - "tags": [ - "App Template" - ], - "summary": "Aggregate for the App Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of AppTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/category": { - "post": { - "tags": [ - "Category" - ], - "summary": "Aggregate for the Category resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCategory", - "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 Category", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/cms-block": { - "post": { - "tags": [ - "Cms Block" - ], - "summary": "Aggregate for the Cms Block resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsBlock", - "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 CmsBlock", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/cms-page": { - "post": { - "tags": [ - "Cms Page" - ], - "summary": "Aggregate for the Cms Page resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsPage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of CmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsPage" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/cms-section": { - "post": { - "tags": [ - "Cms Section" - ], - "summary": "Aggregate for the Cms Section resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsSection", - "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 CmsSection", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/cms-slot": { - "post": { - "tags": [ - "Cms Slot" - ], - "summary": "Aggregate for the Cms Slot resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsSlot", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of CmsSlot", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/country": { - "post": { - "tags": [ - "Country" - ], - "summary": "Aggregate for the Country resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCountry", - "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 Country", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/country-state": { - "post": { - "tags": [ - "Country State" - ], - "summary": "Aggregate for the Country State resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCountryState", - "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 CountryState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CountryState" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/currency": { - "post": { - "tags": [ - "Currency" - ], - "summary": "Aggregate for the Currency resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCurrency", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Currency", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/currency-country-rounding": { - "post": { - "tags": [ - "Currency Country Rounding" - ], - "summary": "Aggregate for the Currency Country Rounding resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCurrencyCountryRounding", - "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 CurrencyCountryRounding", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/custom-entity": { - "post": { - "tags": [ - "Custom Entity" - ], - "summary": "Aggregate for the Custom Entity resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomEntity", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomEntity", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomEntity" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/custom-field": { - "post": { - "tags": [ - "Custom Field" - ], - "summary": "Aggregate for the Custom Field resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomField", - "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 CustomField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/custom-field-set": { - "post": { - "tags": [ - "Custom Field Set" - ], - "summary": "Aggregate for the Custom Field Set resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomFieldSet", - "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 CustomFieldSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/custom-field-set-relation": { - "post": { - "tags": [ - "Custom Field Set Relation" - ], - "summary": "Aggregate for the Custom Field Set Relation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomFieldSetRelation", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomFieldSetRelation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/customer": { - "post": { - "tags": [ - "Customer" - ], - "summary": "Aggregate for the Customer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomer", - "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 Customer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/customer-address": { - "post": { - "tags": [ - "Customer Address" - ], - "summary": "Aggregate for the Customer Address resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerAddress", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/customer-group": { - "post": { - "tags": [ - "Customer Group" - ], - "summary": "Aggregate for the Customer Group resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerGroup", - "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 CustomerGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerGroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/customer-recovery": { - "post": { - "tags": [ - "Customer Recovery" - ], - "summary": "Aggregate for the Customer Recovery resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerRecovery", - "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 CustomerRecovery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/customer-wishlist": { - "post": { - "tags": [ - "Customer Wishlist" - ], - "summary": "Aggregate for the Customer Wishlist resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerWishlist", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of CustomerWishlist", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/customer-wishlist-product": { - "post": { - "tags": [ - "Customer Wishlist Product" - ], - "summary": "Aggregate for the Customer Wishlist Product resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerWishlistProduct", - "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 CustomerWishlistProduct", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/delivery-time": { - "post": { - "tags": [ - "Delivery Time" - ], - "summary": "Aggregate for the Delivery Time resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDeliveryTime", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of DeliveryTime", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeliveryTime" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/document": { - "post": { - "tags": [ - "Document" - ], - "summary": "Aggregate for the Document resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocument", - "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 Document", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/document-base-config": { - "post": { - "tags": [ - "Document Base Config" - ], - "summary": "Aggregate for the Document Base Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocumentBaseConfig", - "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 DocumentBaseConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/document-base-config-sales-channel": { - "post": { - "tags": [ - "Document Base Config Sales Channel" - ], - "summary": "Aggregate for the Document Base Config Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocumentBaseConfigSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of DocumentBaseConfigSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/document-type": { - "post": { - "tags": [ - "Document Type" - ], - "summary": "Aggregate for the Document Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocumentType", - "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 DocumentType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/flow": { - "post": { - "tags": [ - "Flow" - ], - "summary": "Aggregate for the Flow resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateFlow", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Flow", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/flow-sequence": { - "post": { - "tags": [ - "Flow Sequence" - ], - "summary": "Aggregate for the Flow Sequence resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateFlowSequence", - "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 FlowSequence", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/flow-template": { - "post": { - "tags": [ - "Flow Template" - ], - "summary": "Aggregate for the Flow Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateFlowTemplate", - "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 FlowTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/import-export-file": { - "post": { - "tags": [ - "Import Export File" - ], - "summary": "Aggregate for the Import Export File resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateImportExportFile", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ImportExportFile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/import-export-log": { - "post": { - "tags": [ - "Import Export Log" - ], - "summary": "Aggregate for the Import Export Log resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateImportExportLog", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ImportExportLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/import-export-profile": { - "post": { - "tags": [ - "Import Export Profile" - ], - "summary": "Aggregate for the Import Export Profile resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateImportExportProfile", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ImportExportProfile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/integration": { - "post": { - "tags": [ - "Integration" - ], - "summary": "Aggregate for the Integration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateIntegration", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Integration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/landing-page": { - "post": { - "tags": [ - "Landing Page" - ], - "summary": "Aggregate for the Landing Page resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLandingPage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of LandingPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/language": { - "post": { - "tags": [ - "Language" - ], - "summary": "Aggregate for the Language resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLanguage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Language", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/locale": { - "post": { - "tags": [ - "Locale" - ], - "summary": "Aggregate for the Locale resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLocale", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Locale", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/log-entry": { - "post": { - "tags": [ - "Log Entry" - ], - "summary": "Aggregate for the Log Entry resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLogEntry", - "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 LogEntry", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/mail-header-footer": { - "post": { - "tags": [ - "Mail Header Footer" - ], - "summary": "Aggregate for the Mail Header Footer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMailHeaderFooter", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MailHeaderFooter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/mail-template": { - "post": { - "tags": [ - "Mail Template" - ], - "summary": "Aggregate for the Mail Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMailTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MailTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/mail-template-type": { - "post": { - "tags": [ - "Mail Template Type" - ], - "summary": "Aggregate for the Mail Template Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMailTemplateType", - "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 MailTemplateType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/main-category": { - "post": { - "tags": [ - "Main Category" - ], - "summary": "Aggregate for the Main Category resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMainCategory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MainCategory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media": { - "post": { - "tags": [ - "Media" - ], - "summary": "Aggregate for the Media resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMedia", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Media", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media-default-folder": { - "post": { - "tags": [ - "Media Default Folder" - ], - "summary": "Aggregate for the Media Default Folder resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaDefaultFolder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaDefaultFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media-folder": { - "post": { - "tags": [ - "Media Folder" - ], - "summary": "Aggregate for the Media Folder resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaFolder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media-folder-configuration": { - "post": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "Aggregate for the Media Folder Configuration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaFolderConfiguration", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaFolderConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media-thumbnail": { - "post": { - "tags": [ - "Media Thumbnail" - ], - "summary": "Aggregate for the Media Thumbnail resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaThumbnail", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaThumbnail", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media-thumbnail-size": { - "post": { - "tags": [ - "Media Thumbnail Size" - ], - "summary": "Aggregate for the Media Thumbnail Size resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaThumbnailSize", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaThumbnailSize", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/newsletter-recipient": { - "post": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "Aggregate for the Newsletter Recipient resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNewsletterRecipient", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NewsletterRecipient", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/notification": { - "post": { - "tags": [ - "Notification" - ], - "summary": "Aggregate for the Notification resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNotification", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Notification", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range": { - "post": { - "tags": [ - "Number Range" - ], - "summary": "Aggregate for the Number Range resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRange", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRange", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range-sales-channel": { - "post": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "Aggregate for the Number Range Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range-state": { - "post": { - "tags": [ - "Number Range State" - ], - "summary": "Aggregate for the Number Range State resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeState", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range-type": { - "post": { - "tags": [ - "Number Range Type" - ], - "summary": "Aggregate for the Number Range Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order": { - "post": { - "tags": [ - "Order" - ], - "summary": "Aggregate for the Order resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Order", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-address": { - "post": { - "tags": [ - "Order Address" - ], - "summary": "Aggregate for the Order Address resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderAddress", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-customer": { - "post": { - "tags": [ - "Order Customer" - ], - "summary": "Aggregate for the Order Customer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderCustomer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-delivery": { - "post": { - "tags": [ - "Order Delivery" - ], - "summary": "Aggregate for the Order Delivery resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderDelivery", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderDelivery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-delivery-position": { - "post": { - "tags": [ - "Order Delivery Position" - ], - "summary": "Aggregate for the Order Delivery Position resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderDeliveryPosition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderDeliveryPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-line-item": { - "post": { - "tags": [ - "Order Line Item" - ], - "summary": "Aggregate for the Order Line Item resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderLineItem", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-line-item-download": { - "post": { - "tags": [ - "Order Line Item Download" - ], - "summary": "Aggregate for the Order Line Item Download resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderLineItemDownload", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderLineItemDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction": { - "post": { - "tags": [ - "Order Transaction" - ], - "summary": "Aggregate for the Order Transaction resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransaction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransaction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction-capture": { - "post": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "Aggregate for the Order Transaction Capture resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCapture", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCapture", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction-capture-refund": { - "post": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Aggregate for the Order Transaction Capture Refund resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCaptureRefund", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction-capture-refund-position": { - "post": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCaptureRefundPosition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefundPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/payment-method": { - "post": { - "tags": [ - "Payment Method" - ], - "summary": "Aggregate for the Payment Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePaymentMethod", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/plugin": { - "post": { - "tags": [ - "Plugin" - ], - "summary": "Aggregate for the Plugin resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePlugin", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Plugin", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product": { - "post": { - "tags": [ - "Product" - ], - "summary": "Aggregate for the Product resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProduct", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Product", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-configurator-setting": { - "post": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "Aggregate for the Product Configurator Setting resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductConfiguratorSetting", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductConfiguratorSetting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-cross-selling": { - "post": { - "tags": [ - "Product Cross Selling" - ], - "summary": "Aggregate for the Product Cross Selling resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductCrossSelling", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductCrossSelling", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-cross-selling-assigned-products": { - "post": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductCrossSellingAssignedProducts", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductCrossSellingAssignedProducts", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-download": { - "post": { - "tags": [ - "Product Download" - ], - "summary": "Aggregate for the Product Download resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductDownload", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-export": { - "post": { - "tags": [ - "Product Export" - ], - "summary": "Aggregate for the Product Export resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductExport", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductExport", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-feature-set": { - "post": { - "tags": [ - "Product Feature Set" - ], - "summary": "Aggregate for the Product Feature Set resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductFeatureSet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductFeatureSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-keyword-dictionary": { - "post": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "Aggregate for the Product Keyword Dictionary resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductKeywordDictionary", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductKeywordDictionary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-manufacturer": { - "post": { - "tags": [ - "Product Manufacturer" - ], - "summary": "Aggregate for the Product Manufacturer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductManufacturer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductManufacturer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-media": { - "post": { - "tags": [ - "Product Media" - ], - "summary": "Aggregate for the Product Media resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductMedia", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductMedia", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-price": { - "post": { - "tags": [ - "Product Price" - ], - "summary": "Aggregate for the Product Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductPrice", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-review": { - "post": { - "tags": [ - "Product Review" - ], - "summary": "Aggregate for the Product Review resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReview", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductReview", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-search-config": { - "post": { - "tags": [ - "Product Search Config" - ], - "summary": "Aggregate for the Product Search Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchConfig", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-search-config-field": { - "post": { - "tags": [ - "Product Search Config Field" - ], - "summary": "Aggregate for the Product Search Config Field resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchConfigField", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-search-keyword": { - "post": { - "tags": [ - "Product Search Keyword" - ], - "summary": "Aggregate for the Product Search Keyword resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchKeyword", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchKeyword", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-sorting": { - "post": { - "tags": [ - "Product Sorting" - ], - "summary": "Aggregate for the Product Sorting resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSorting", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-stream": { - "post": { - "tags": [ - "Product Stream" - ], - "summary": "Aggregate for the Product Stream resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductStream", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductStream", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-stream-filter": { - "post": { - "tags": [ - "Product Stream Filter" - ], - "summary": "Aggregate for the Product Stream Filter resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductStreamFilter", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-visibility": { - "post": { - "tags": [ - "Product Visibility" - ], - "summary": "Aggregate for the Product Visibility resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductVisibility", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductVisibility", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion": { - "post": { - "tags": [ - "Promotion" - ], - "summary": "Aggregate for the Promotion resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotion", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Promotion", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-discount": { - "post": { - "tags": [ - "Promotion Discount" - ], - "summary": "Aggregate for the Promotion Discount resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionDiscount", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionDiscount", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-discount-prices": { - "post": { - "tags": [ - "Promotion Discount Prices" - ], - "summary": "Aggregate for the Promotion Discount Prices resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionDiscountPrices", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionDiscountPrices", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-individual-code": { - "post": { - "tags": [ - "Promotion Individual Code" - ], - "summary": "Aggregate for the Promotion Individual Code resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionIndividualCode", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionIndividualCode", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-sales-channel": { - "post": { - "tags": [ - "Promotion Sales Channel" - ], - "summary": "Aggregate for the Promotion Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-setgroup": { - "post": { - "tags": [ - "Promotion Setgroup" - ], - "summary": "Aggregate for the Promotion Setgroup resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionSetgroup", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionSetgroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/property-group": { - "post": { - "tags": [ - "Property Group" - ], - "summary": "Aggregate for the Property Group resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePropertyGroup", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PropertyGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/property-group-option": { - "post": { - "tags": [ - "Property Group Option" - ], - "summary": "Aggregate for the Property Group Option resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePropertyGroupOption", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PropertyGroupOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/rule": { - "post": { - "tags": [ - "Rule" - ], - "summary": "Aggregate for the Rule resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateRule", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Rule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/rule-condition": { - "post": { - "tags": [ - "Rule Condition" - ], - "summary": "Aggregate for the Rule Condition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateRuleCondition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of RuleCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel": { - "post": { - "tags": [ - "Sales Channel" - ], - "summary": "Aggregate for the Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel-analytics": { - "post": { - "tags": [ - "Sales Channel Analytics" - ], - "summary": "Aggregate for the Sales Channel Analytics resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelAnalytics", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SalesChannelAnalytics", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel-domain": { - "post": { - "tags": [ - "Sales Channel Domain" - ], - "summary": "Aggregate for the Sales Channel Domain resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelDomain", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SalesChannelDomain", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel-type": { - "post": { - "tags": [ - "Sales Channel Type" - ], - "summary": "Aggregate for the Sales Channel Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SalesChannelType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelType" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/salutation": { - "post": { - "tags": [ - "Salutation" - ], - "summary": "Aggregate for the Salutation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalutation", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Salutation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/scheduled-task": { - "post": { - "tags": [ - "Scheduled Task" - ], - "summary": "Aggregate for the Scheduled Task resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateScheduledTask", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/script": { - "post": { - "tags": [ - "Script" - ], - "summary": "Aggregate for the Script resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateScript", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Script", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/seo-url": { - "post": { - "tags": [ - "Seo Url" - ], - "summary": "Aggregate for the Seo Url resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrl", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SeoUrl", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/seo-url-template": { - "post": { - "tags": [ - "Seo Url Template" - ], - "summary": "Aggregate for the Seo Url Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrlTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SeoUrlTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/shipping-method": { - "post": { - "tags": [ - "Shipping Method" - ], - "summary": "Aggregate for the Shipping Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethod", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ShippingMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/shipping-method-price": { - "post": { - "tags": [ - "Shipping Method Price" - ], - "summary": "Aggregate for the Shipping Method Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethodPrice", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ShippingMethodPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/snippet": { - "post": { - "tags": [ - "Snippet" - ], - "summary": "Aggregate for the Snippet resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/snippet-set": { - "post": { - "tags": [ - "Snippet Set" - ], - "summary": "Aggregate for the Snippet Set resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippetSet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SnippetSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine": { - "post": { - "tags": [ - "State Machine" - ], - "summary": "Aggregate for the State Machine resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachine", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachine", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine-history": { - "post": { - "tags": [ - "State Machine History" - ], - "summary": "Aggregate for the State Machine History resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineHistory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine-state": { - "post": { - "tags": [ - "State Machine State" - ], - "summary": "Aggregate for the State Machine State resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineState", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine-transition": { - "post": { - "tags": [ - "State Machine Transition" - ], - "summary": "Aggregate for the State Machine Transition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineTransition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineTransition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template": { - "get": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "List with basic information of Swag Customized Products Template resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateList", - "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 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/SwagCustomizedProductsTemplate" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template?limit=25" - }, - "last": { - "example": "/swag-customized-products-template?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "Create a new Swag Customized Products Template resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplate", - "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/SwagCustomizedProductsTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/swag-customized-products-template": { - "post": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "Search for the Swag Customized Products Template resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template/{id}": { - "get": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "Detailed information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "Delete a Swag Customized Products Template resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template", - "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" - ], - "summary": "Partially update information about a Swag Customized Products Template resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template", - "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 resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/swag-customized-products-template": { - "post": { - "tags": [ - "Swag Customized Products Template" - ], - "summary": "Aggregate for the Swag Customized Products Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplate", - "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 SwagCustomizedProductsTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-configuration": { - "get": { - "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "List with basic information of Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationList", - "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 Configuration 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/SwagCustomizedProductsTemplateConfiguration" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/swag-customized-products-template-configuration?limit=25" - }, - "last": { - "example": "/swag-customized-products-template-configuration?limit=25&page=11" - }, - "next": { - "example": "/swag-customized-products-template-configuration?limit=25&page=4" - }, - "prev": { - "example": "/swag-customized-products-template-configuration?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "Create a new Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfiguration", - "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/SwagCustomizedProductsTemplateConfiguration" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/swag-customized-products-template-configuration": { - "post": { - "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "Search for the Swag Customized Products Template Configuration resources.", - "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfiguration", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SwagCustomizedProductsTemplateConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-configuration/{id}": { - "get": { - "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "Delete a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", - "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 Configuration" - ], - "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", - "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfiguration", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration", - "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 Configuration resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/swag-customized-products-template-configuration": { - "post": { - "tags": [ - "Swag Customized Products Template Configuration" - ], - "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", - "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 SwagCustomizedProductsTemplateConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/swag-customized-products-template-configuration-share": { + "/swag-customized-products-template": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", + "summary": "List with basic information of Swag Customized Products Template resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", + "operationId": "getSwagCustomizedProductsTemplateList", "parameters": [ { "name": "limit", @@ -10783,7 +51,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Configuration Share resources.", + "description": "List of Swag Customized Products Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10802,7 +70,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } ] @@ -10816,16 +84,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-configuration-share?limit=25" + "example": "/swag-customized-products-template?limit=25" }, "last": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" + "example": "/swag-customized-products-template?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" + "example": "/swag-customized-products-template?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" + "example": "/swag-customized-products-template?limit=25&page=2" } } } @@ -10846,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -10861,11 +129,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "Create a new Swag Customized Products Template Configuration Share resources.", + "summary": "Create a new Swag Customized Products Template resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "createSwagCustomizedProductsTemplate", "parameters": [ { "name": "_response", @@ -10884,14 +152,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -10903,7 +171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -10918,7 +186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -10934,14 +202,14 @@ } } }, - "/search/swag-customized-products-template-configuration-share": { + "/search/swag-customized-products-template": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "Search for the Swag Customized Products Template Configuration Share resources.", + "summary": "Search for the Swag Customized Products Template resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "searchSwagCustomizedProductsTemplate", "requestBody": { "required": true, "content": { @@ -10954,7 +222,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -10968,7 +236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -10986,7 +254,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11003,19 +271,19 @@ } } }, - "/swag-customized-products-template-configuration-share/{id}": { + "/swag-customized-products-template/{id}": { "get": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Detailed information about a Swag Customized Products Template resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "getSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -11025,7 +293,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -11037,7 +305,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11052,7 +320,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11069,16 +337,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "Delete a Swag Customized Products Template Configuration Share resource.", + "summary": "Delete a Swag Customized Products Template resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "deleteSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -11109,16 +377,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", + "summary": "Partially update information about a Swag Customized Products Template resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "updateSwagCustomizedProductsTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_configuration_share", + "description": "Identifier for the swag_customized_products_template", "required": true, "schema": { "type": "string", @@ -11136,18 +404,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 resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", + "description": "Detail of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -11159,7 +427,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11174,7 +442,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11193,14 +461,14 @@ } } }, - "/aggregate/swag-customized-products-template-configuration-share": { + "/aggregate/swag-customized-products-template": { "post": { "tags": [ - "Swag Customized Products Template Configuration Share" + "Swag Customized Products Template" ], - "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", + "summary": "Aggregate for the Swag Customized Products Template resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", + "operationId": "aggregateSwagCustomizedProductsTemplate", "requestBody": { "required": true, "content": { @@ -11224,7 +492,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateConfigurationShare", + "description": "List of SwagCustomizedProductsTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -11238,7 +506,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11256,7 +524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplate" } } } @@ -11273,14 +541,14 @@ } } }, - "/swag-customized-products-template-exclusion": { + "/swag-customized-products-template-configuration": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", + "summary": "List with basic information of Swag Customized Products Template Configuration resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionList", + "operationId": "getSwagCustomizedProductsTemplateConfigurationList", "parameters": [ { "name": "limit", @@ -11309,7 +577,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion resources.", + "description": "List of Swag Customized Products Template Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11328,7 +596,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } ] @@ -11342,16 +610,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion?limit=25" + "example": "/swag-customized-products-template-configuration?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=11" + "example": "/swag-customized-products-template-configuration?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=4" + "example": "/swag-customized-products-template-configuration?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion?limit=25&page=2" + "example": "/swag-customized-products-template-configuration?limit=25&page=2" } } } @@ -11372,7 +640,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11387,11 +655,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "Create a new Swag Customized Products Template Exclusion resources.", + "summary": "Create a new Swag Customized Products Template Configuration resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusion", + "operationId": "createSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "_response", @@ -11410,14 +678,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -11429,7 +697,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11444,7 +712,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11460,14 +728,14 @@ } } }, - "/search/swag-customized-products-template-exclusion": { + "/search/swag-customized-products-template-configuration": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "Search for the Swag Customized Products Template Exclusion resources.", + "summary": "Search for the Swag Customized Products Template Configuration resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "operationId": "searchSwagCustomizedProductsTemplateConfiguration", "requestBody": { "required": true, "content": { @@ -11480,7 +748,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -11494,7 +762,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11512,7 +780,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11529,19 +797,19 @@ } } }, - "/swag-customized-products-template-exclusion/{id}": { + "/swag-customized-products-template-configuration/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", + "summary": "Detailed information about a Swag Customized Products Template Configuration resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusion", + "operationId": "getSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -11551,7 +819,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -11563,7 +831,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11578,7 +846,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11595,16 +863,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "Delete a Swag Customized Products Template Exclusion resource.", + "summary": "Delete a Swag Customized Products Template Configuration resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusion", + "operationId": "deleteSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -11635,16 +903,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "summary": "Partially update information about a Swag Customized Products Template Configuration resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusion", + "operationId": "updateSwagCustomizedProductsTemplateConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion", + "description": "Identifier for the swag_customized_products_template_configuration", "required": true, "schema": { "type": "string", @@ -11662,18 +930,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Exclusion resource.", + "description": "Partially update information about a Swag Customized Products Template Configuration resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusion", + "description": "Detail of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -11685,7 +953,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11700,7 +968,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11719,14 +987,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion": { + "/aggregate/swag-customized-products-template-configuration": { "post": { "tags": [ - "Swag Customized Products Template Exclusion" + "Swag Customized Products Template Configuration" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", + "summary": "Aggregate for the Swag Customized Products Template Configuration resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", + "operationId": "aggregateSwagCustomizedProductsTemplateConfiguration", "requestBody": { "required": true, "content": { @@ -11750,7 +1018,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusion", + "description": "List of SwagCustomizedProductsTemplateConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -11764,7 +1032,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11782,7 +1050,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfiguration" } } } @@ -11799,14 +1067,14 @@ } } }, - "/swag-customized-products-template-exclusion-condition": { + "/swag-customized-products-template-configuration-share": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", + "summary": "List with basic information of Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShareList", "parameters": [ { "name": "limit", @@ -11835,7 +1103,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Condition resources.", + "description": "List of Swag Customized Products Template Configuration Share resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11854,7 +1122,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } ] @@ -11868,16 +1136,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25" + "example": "/swag-customized-products-template-configuration-share?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" + "example": "/swag-customized-products-template-configuration-share?limit=25&page=2" } } } @@ -11898,7 +1166,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -11913,11 +1181,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", + "summary": "Create a new Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "createSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "_response", @@ -11936,14 +1204,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -11955,7 +1223,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -11970,7 +1238,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -11986,14 +1254,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-condition": { + "/search/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", "requestBody": { "required": true, "content": { @@ -12006,7 +1274,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -12020,7 +1288,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12038,7 +1306,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12055,19 +1323,19 @@ } } }, - "/swag-customized-products-template-exclusion-condition/{id}": { + "/swag-customized-products-template-configuration-share/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Detailed information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "getSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -12077,7 +1345,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -12089,7 +1357,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12104,7 +1372,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12121,16 +1389,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Delete a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "deleteSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -12161,16 +1429,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", + "summary": "Partially update information about a Swag Customized Products Template Configuration Share resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "updateSwagCustomizedProductsTemplateConfigurationShare", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_condition", + "description": "Identifier for the swag_customized_products_template_configuration_share", "required": true, "schema": { "type": "string", @@ -12188,18 +1456,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 Configuration Share resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", + "description": "Detail of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -12211,7 +1479,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12226,7 +1494,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12245,14 +1513,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-condition": { + "/aggregate/swag-customized-products-template-configuration-share": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Condition" + "Swag Customized Products Template Configuration Share" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", + "summary": "Aggregate for the Swag Customized Products Template Configuration Share resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", + "operationId": "aggregateSwagCustomizedProductsTemplateConfigurationShare", "requestBody": { "required": true, "content": { @@ -12276,7 +1544,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionCondition", + "description": "List of SwagCustomizedProductsTemplateConfigurationShare", "content": { "application/vnd.api+json": { "schema": { @@ -12290,7 +1558,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12308,7 +1576,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateConfigurationShare" } } } @@ -12325,14 +1593,14 @@ } } }, - "/swag-customized-products-template-exclusion-operator": { + "/swag-customized-products-template-exclusion": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", + "operationId": "getSwagCustomizedProductsTemplateExclusionList", "parameters": [ { "name": "limit", @@ -12361,7 +1629,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Exclusion Operator resources.", + "description": "List of Swag Customized Products Template Exclusion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12380,7 +1648,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } ] @@ -12394,16 +1662,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25" + "example": "/swag-customized-products-template-exclusion?limit=25" }, "last": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion?limit=25&page=2" } } } @@ -12424,7 +1692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12439,11 +1707,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", + "summary": "Create a new Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "createSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "_response", @@ -12462,14 +1730,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -12481,7 +1749,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12496,7 +1764,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12512,14 +1780,14 @@ } } }, - "/search/swag-customized-products-template-exclusion-operator": { + "/search/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "searchSwagCustomizedProductsTemplateExclusion", "requestBody": { "required": true, "content": { @@ -12532,7 +1800,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -12546,7 +1814,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12564,7 +1832,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12581,19 +1849,19 @@ } } }, - "/swag-customized-products-template-exclusion-operator/{id}": { + "/swag-customized-products-template-exclusion/{id}": { "get": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "getSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -12603,7 +1871,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -12615,7 +1883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12630,7 +1898,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12647,16 +1915,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Delete a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "deleteSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -12687,16 +1955,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "updateSwagCustomizedProductsTemplateExclusion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_exclusion_operator", + "description": "Identifier for the swag_customized_products_template_exclusion", "required": true, "schema": { "type": "string", @@ -12714,18 +1982,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 Exclusion resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", + "description": "Detail of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -12737,7 +2005,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12752,7 +2020,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12771,14 +2039,14 @@ } } }, - "/aggregate/swag-customized-products-template-exclusion-operator": { + "/aggregate/swag-customized-products-template-exclusion": { "post": { "tags": [ - "Swag Customized Products Template Exclusion Operator" + "Swag Customized Products Template Exclusion" ], - "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusion", "requestBody": { "required": true, "content": { @@ -12802,7 +2070,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateExclusionOperator", + "description": "List of SwagCustomizedProductsTemplateExclusion", "content": { "application/vnd.api+json": { "schema": { @@ -12816,7 +2084,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12834,7 +2102,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusion" } } } @@ -12851,14 +2119,14 @@ } } }, - "/swag-customized-products-template-option": { + "/swag-customized-products-template-exclusion-condition": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "List with basic information of Swag Customized Products Template Option resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionList", + "operationId": "getSwagCustomizedProductsTemplateExclusionConditionList", "parameters": [ { "name": "limit", @@ -12887,7 +2155,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option resources.", + "description": "List of Swag Customized Products Template Exclusion Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12906,7 +2174,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } ] @@ -12920,16 +2188,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option?limit=25" + "example": "/swag-customized-products-template-exclusion-condition?limit=25" }, "last": { - "example": "/swag-customized-products-template-option?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-condition?limit=25&page=2" } } } @@ -12950,7 +2218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -12965,11 +2233,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Create a new Swag Customized Products Template Option resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOption", + "operationId": "createSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "_response", @@ -12988,14 +2256,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -13007,7 +2275,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13022,7 +2290,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13038,14 +2306,14 @@ } } }, - "/search/swag-customized-products-template-option": { + "/search/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Search for the Swag Customized Products Template Option resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOption", + "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", "requestBody": { "required": true, "content": { @@ -13058,7 +2326,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -13072,7 +2340,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13090,7 +2358,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13107,19 +2375,19 @@ } } }, - "/swag-customized-products-template-option/{id}": { + "/swag-customized-products-template-exclusion-condition/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Detailed information about a Swag Customized Products Template Option resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOption", + "operationId": "getSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -13129,7 +2397,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -13141,7 +2409,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13156,7 +2424,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13173,16 +2441,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Delete a Swag Customized Products Template Option resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOption", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -13213,16 +2481,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Partially update information about a Swag Customized Products Template Option resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOption", + "operationId": "updateSwagCustomizedProductsTemplateExclusionCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option", + "description": "Identifier for the swag_customized_products_template_exclusion_condition", "required": true, "schema": { "type": "string", @@ -13240,18 +2508,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option resource.", + "description": "Partially update information about a Swag Customized Products Template Exclusion Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOption", + "description": "Detail of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -13263,7 +2531,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13278,7 +2546,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13297,14 +2565,14 @@ } } }, - "/aggregate/swag-customized-products-template-option": { + "/aggregate/swag-customized-products-template-exclusion-condition": { "post": { "tags": [ - "Swag Customized Products Template Option" + "Swag Customized Products Template Exclusion Condition" ], - "summary": "Aggregate for the Swag Customized Products Template Option resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Condition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOption", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionCondition", "requestBody": { "required": true, "content": { @@ -13328,7 +2596,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOption", + "description": "List of SwagCustomizedProductsTemplateExclusionCondition", "content": { "application/vnd.api+json": { "schema": { @@ -13342,7 +2610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13360,7 +2628,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionCondition" } } } @@ -13377,14 +2645,14 @@ } } }, - "/swag-customized-products-template-option-price": { + "/swag-customized-products-template-exclusion-operator": { "get": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "List with basic information of Swag Customized Products Template Option Price resources.", + "summary": "List with basic information of Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperatorList", "parameters": [ { "name": "limit", @@ -13413,7 +2681,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Price resources.", + "description": "List of Swag Customized Products Template Exclusion Operator resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13432,7 +2700,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } ] @@ -13446,16 +2714,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-price?limit=25" + "example": "/swag-customized-products-template-exclusion-operator?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-price?limit=25&page=11" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-price?limit=25&page=4" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-price?limit=25&page=2" + "example": "/swag-customized-products-template-exclusion-operator?limit=25&page=2" } } } @@ -13476,7 +2744,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13491,11 +2759,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Create a new Swag Customized Products Template Option Price resources.", + "summary": "Create a new Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionPrice", + "operationId": "createSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "_response", @@ -13514,14 +2782,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -13533,7 +2801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13548,7 +2816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13564,14 +2832,14 @@ } } }, - "/search/swag-customized-products-template-option-price": { + "/search/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Search for the Swag Customized Products Template Option Price resources.", + "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", + "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", "requestBody": { "required": true, "content": { @@ -13584,7 +2852,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -13598,7 +2866,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13616,7 +2884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13633,19 +2901,19 @@ } } }, - "/swag-customized-products-template-option-price/{id}": { + "/swag-customized-products-template-exclusion-operator/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", + "summary": "Detailed information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionPrice", + "operationId": "getSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -13655,7 +2923,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -13667,7 +2935,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13682,7 +2950,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13699,16 +2967,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Delete a Swag Customized Products Template Option Price resource.", + "summary": "Delete a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", + "operationId": "deleteSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -13739,16 +3007,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", + "summary": "Partially update information about a Swag Customized Products Template Exclusion Operator resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", + "operationId": "updateSwagCustomizedProductsTemplateExclusionOperator", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_price", + "description": "Identifier for the swag_customized_products_template_exclusion_operator", "required": true, "schema": { "type": "string", @@ -13766,18 +3034,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 Exclusion Operator resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", + "description": "Detail of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -13789,7 +3057,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13804,7 +3072,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13823,14 +3091,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-price": { + "/aggregate/swag-customized-products-template-exclusion-operator": { "post": { "tags": [ - "Swag Customized Products Template Option Price" + "Swag Customized Products Template Exclusion Operator" ], - "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", + "summary": "Aggregate for the Swag Customized Products Template Exclusion Operator resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", + "operationId": "aggregateSwagCustomizedProductsTemplateExclusionOperator", "requestBody": { "required": true, "content": { @@ -13854,7 +3122,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionPrice", + "description": "List of SwagCustomizedProductsTemplateExclusionOperator", "content": { "application/vnd.api+json": { "schema": { @@ -13868,7 +3136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13886,7 +3154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateExclusionOperator" } } } @@ -13903,14 +3171,14 @@ } } }, - "/swag-customized-products-template-option-value": { + "/swag-customized-products-template-option": { "get": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "List with basic information of Swag Customized Products Template Option Value resources.", + "summary": "List with basic information of Swag Customized Products Template Option resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValueList", + "operationId": "getSwagCustomizedProductsTemplateOptionList", "parameters": [ { "name": "limit", @@ -13939,7 +3207,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value resources.", + "description": "List of Swag Customized Products Template Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13958,7 +3226,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } ] @@ -13972,16 +3240,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-value?limit=25" + "example": "/swag-customized-products-template-option?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-value?limit=25&page=11" + "example": "/swag-customized-products-template-option?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-value?limit=25&page=4" + "example": "/swag-customized-products-template-option?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-value?limit=25&page=2" + "example": "/swag-customized-products-template-option?limit=25&page=2" } } } @@ -14002,7 +3270,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14017,11 +3285,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "Create a new Swag Customized Products Template Option Value resources.", + "summary": "Create a new Swag Customized Products Template Option resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValue", + "operationId": "createSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "_response", @@ -14040,14 +3308,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -14059,7 +3327,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14074,7 +3342,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14090,14 +3358,14 @@ } } }, - "/search/swag-customized-products-template-option-value": { + "/search/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "Search for the Swag Customized Products Template Option Value resources.", + "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "operationId": "searchSwagCustomizedProductsTemplateOption", "requestBody": { "required": true, "content": { @@ -14110,7 +3378,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -14124,7 +3392,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14142,7 +3410,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14159,19 +3427,19 @@ } } }, - "/swag-customized-products-template-option-value/{id}": { + "/swag-customized-products-template-option/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", + "summary": "Detailed information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValue", + "operationId": "getSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -14181,7 +3449,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -14193,7 +3461,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14208,7 +3476,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14225,16 +3493,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "Delete a Swag Customized Products Template Option Value resource.", + "summary": "Delete a Swag Customized Products Template Option resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", + "operationId": "deleteSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -14265,16 +3533,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", + "summary": "Partially update information about a Swag Customized Products Template Option resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValue", + "operationId": "updateSwagCustomizedProductsTemplateOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value", + "description": "Identifier for the swag_customized_products_template_option", "required": true, "schema": { "type": "string", @@ -14292,18 +3560,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 resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValue", + "description": "Detail of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -14315,7 +3583,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14330,7 +3598,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14349,14 +3617,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-value": { + "/aggregate/swag-customized-products-template-option": { "post": { "tags": [ - "Swag Customized Products Template Option Value" + "Swag Customized Products Template Option" ], - "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", + "summary": "Aggregate for the Swag Customized Products Template Option resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", + "operationId": "aggregateSwagCustomizedProductsTemplateOption", "requestBody": { "required": true, "content": { @@ -14380,7 +3648,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValue", + "description": "List of SwagCustomizedProductsTemplateOption", "content": { "application/vnd.api+json": { "schema": { @@ -14394,7 +3662,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14412,7 +3680,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOption" } } } @@ -14429,14 +3697,14 @@ } } }, - "/swag-customized-products-template-option-value-price": { + "/swag-customized-products-template-option-price": { "get": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "List with basic information of Swag Customized Products Template Option Value Price resources.", + "summary": "List with basic information of Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValuePriceList", + "operationId": "getSwagCustomizedProductsTemplateOptionPriceList", "parameters": [ { "name": "limit", @@ -14465,7 +3733,7 @@ ], "responses": { "200": { - "description": "List of Swag Customized Products Template Option Value Price resources.", + "description": "List of Swag Customized Products Template Option Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14484,7 +3752,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } ] @@ -14498,16 +3766,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-customized-products-template-option-value-price?limit=25" + "example": "/swag-customized-products-template-option-price?limit=25" }, "last": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=11" + "example": "/swag-customized-products-template-option-price?limit=25&page=11" }, "next": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=4" + "example": "/swag-customized-products-template-option-price?limit=25&page=4" }, "prev": { - "example": "/swag-customized-products-template-option-value-price?limit=25&page=2" + "example": "/swag-customized-products-template-option-price?limit=25&page=2" } } } @@ -14528,7 +3796,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14543,11 +3811,11 @@ }, "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "Create a new Swag Customized Products Template Option Value Price resources.", + "summary": "Create a new Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "createSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "createSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "_response", @@ -14566,14 +3834,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14585,7 +3853,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14600,7 +3868,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14616,14 +3884,14 @@ } } }, - "/search/swag-customized-products-template-option-value-price": { + "/search/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "Search for the Swag Customized Products Template Option Value Price resources.", + "summary": "Search for the Swag Customized Products Template Option Price resources.", "description": "", - "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "searchSwagCustomizedProductsTemplateOptionPrice", "requestBody": { "required": true, "content": { @@ -14636,7 +3904,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14650,7 +3918,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14668,7 +3936,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14685,19 +3953,19 @@ } } }, - "/swag-customized-products-template-option-value-price/{id}": { + "/swag-customized-products-template-option-price/{id}": { "get": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "Detailed information about a Swag Customized Products Template Option Value Price resource.", + "summary": "Detailed information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "getSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "getSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -14707,7 +3975,7 @@ ], "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14719,7 +3987,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14734,7 +4002,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14751,16 +4019,16 @@ }, "delete": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "Delete a Swag Customized Products Template Option Value Price resource.", + "summary": "Delete a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "deleteSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -14791,16 +4059,16 @@ }, "patch": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "summary": "Partially update information about a Swag Customized Products Template Option Price resource.", "description": "", - "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "updateSwagCustomizedProductsTemplateOptionPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_customized_products_template_option_value_price", + "description": "Identifier for the swag_customized_products_template_option_price", "required": true, "schema": { "type": "string", @@ -14818,18 +4086,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "description": "Partially update information about a Swag Customized Products Template Option Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } }, "responses": { "200": { - "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "Detail of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14841,7 +4109,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14856,7 +4124,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14875,14 +4143,14 @@ } } }, - "/aggregate/swag-customized-products-template-option-value-price": { + "/aggregate/swag-customized-products-template-option-price": { "post": { "tags": [ - "Swag Customized Products Template Option Value Price" + "Swag Customized Products Template Option Price" ], - "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionPrice", "requestBody": { "required": true, "content": { @@ -14906,7 +4174,7 @@ }, "responses": { "200": { - "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", + "description": "List of SwagCustomizedProductsTemplateOptionPrice", "content": { "application/vnd.api+json": { "schema": { @@ -14920,7 +4188,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14938,7 +4206,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionPrice" } } } @@ -14955,38 +4223,43 @@ } } }, - "/aggregate/system-config": { - "post": { + "/swag-customized-products-template-option-value": { + "get": { "tags": [ - "System Config" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the System Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSystemConfig", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Swag Customized Products Template Option Value resources.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValueList", + "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 SystemConfig", + "description": "List of Swag Customized Products Template Option Value resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14998,10 +4271,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-customized-products-template-option-value?limit=25" + }, + "last": { + "example": "/swag-customized-products-template-option-value?limit=25&page=11" + }, + "next": { + "example": "/swag-customized-products-template-option-value?limit=25&page=4" + }, + "prev": { + "example": "/swag-customized-products-template-option-value?limit=25&page=2" + } + } + } + ] } } } @@ -15018,7 +4322,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15026,47 +4330,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/tag": { + }, "post": { "tags": [ - "Tag" + "Swag Customized Products Template Option Value" + ], + "summary": "Create a new Swag Customized Products Template Option Value resources.", + "description": "", + "operationId": "createSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the Tag resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTag", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "List of Tag", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -15078,10 +4379,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15091,15 +4389,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15115,38 +4410,27 @@ } } }, - "/aggregate/tax": { + "/search/swag-customized-products-template-option-value": { "post": { "tags": [ - "Tax" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the Tax resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTax", + "summary": "Search for the Swag Customized Products Template Option Value resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOptionValue", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of Tax", + "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -15160,7 +4444,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15178,7 +4462,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15195,38 +4479,29 @@ } } }, - "/aggregate/tax-provider": { - "post": { + "/swag-customized-products-template-option-value/{id}": { + "get": { "tags": [ - "Tax Provider" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the Tax Provider resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxProvider", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Swag Customized Products Template Option Value resource.", + "description": "", + "operationId": "getSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of TaxProvider", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -15238,10 +4513,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15251,222 +4523,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/tax-rule": { - "post": { + }, + "delete": { "tags": [ - "Tax Rule" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the Tax Rule resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRule", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Delete a Swag Customized Products Template Option Value resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" } } - }, + ], "responses": { - "200": { - "description": "List of TaxRule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" - } - } - } - } - } - } + "204": { + "$ref": "#/components/responses/204" }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/tax-rule-type": { - "post": { + }, + "patch": { "tags": [ - "Tax Rule Type" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the Tax Rule Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRuleType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of TaxRuleType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" - } - } - } - } - } + "summary": "Partially update information about a Swag Customized Products Template Option Value resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateOptionValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_customized_products_template_option_value", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } } - } - } - }, - "/aggregate/theme": { - "post": { - "tags": [ - "Theme" ], - "summary": "Aggregate for the Theme resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTheme", "requestBody": { - "required": true, + "description": "Partially update information about a Swag Customized Products Template Option Value resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } }, "responses": { "200": { - "description": "List of Theme", + "description": "Detail of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -15478,10 +4635,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15491,15 +4645,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15509,20 +4660,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/unit": { + "/aggregate/swag-customized-products-template-option-value": { "post": { "tags": [ - "Unit" + "Swag Customized Products Template Option Value" ], - "summary": "Aggregate for the Unit resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Value resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUnit", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValue", "requestBody": { "required": true, "content": { @@ -15546,7 +4700,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of SwagCustomizedProductsTemplateOptionValue", "content": { "application/vnd.api+json": { "schema": { @@ -15560,7 +4714,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15578,7 +4732,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValue" } } } @@ -15595,38 +4749,43 @@ } } }, - "/aggregate/user": { - "post": { + "/swag-customized-products-template-option-value-price": { + "get": { "tags": [ - "User" + "Swag Customized Products Template Option Value Price" ], - "summary": "Aggregate for the User resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUser", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "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 User", + "description": "List of Swag Customized Products Template Option Value Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15638,10 +4797,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } + "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" + } + } + } + ] } } } @@ -15658,7 +4848,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15666,47 +4856,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/user-access-key": { + }, "post": { "tags": [ - "User Access Key" + "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" + ] + } + } ], - "summary": "Aggregate for the User Access Key resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserAccessKey", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -15718,10 +4905,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15731,15 +4915,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15755,38 +4936,27 @@ } } }, - "/aggregate/user-config": { + "/search/swag-customized-products-template-option-value-price": { "post": { "tags": [ - "User Config" + "Swag Customized Products Template Option Value Price" ], - "summary": "Aggregate for the User Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserConfig", + "summary": "Search for the Swag Customized Products Template Option Value Price resources.", + "description": "", + "operationId": "searchSwagCustomizedProductsTemplateOptionValuePrice", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -15800,7 +4970,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15818,7 +4988,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15835,38 +5005,29 @@ } } }, - "/aggregate/user-recovery": { - "post": { + "/swag-customized-products-template-option-value-price/{id}": { + "get": { "tags": [ - "User Recovery" + "Swag Customized Products Template Option Value Price" ], - "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" - ] - } + "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}$" } } - }, + ], "responses": { "200": { - "description": "List of UserRecovery", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -15878,10 +5039,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15891,62 +5049,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/webhook": { - "post": { + }, + "delete": { "tags": [ - "Webhook" + "Swag Customized Products Template Option Value Price" + ], + "summary": "Delete a Swag Customized Products Template Option Value Price resource.", + "description": "", + "operationId": "deleteSwagCustomizedProductsTemplateOptionValuePrice", + "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}$" + } + }, + { + "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 Value Price" + ], + "summary": "Partially update information about a Swag Customized Products Template Option Value Price resource.", + "description": "", + "operationId": "updateSwagCustomizedProductsTemplateOptionValuePrice", + "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}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } ], - "summary": "Aggregate for the Webhook resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhook", "requestBody": { - "required": true, + "description": "Partially update information about a Swag Customized Products Template Option Value Price resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } }, "responses": { "200": { - "description": "List of Webhook", + "description": "Detail of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -15958,10 +5161,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15971,15 +5171,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" - } + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -15989,20 +5186,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/webhook-event-log": { + "/aggregate/swag-customized-products-template-option-value-price": { "post": { "tags": [ - "Webhook Event Log" + "Swag Customized Products Template Option Value Price" ], - "summary": "Aggregate for the Webhook Event Log resources.", + "summary": "Aggregate for the Swag Customized Products Template Option Value Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhookEventLog", + "operationId": "aggregateSwagCustomizedProductsTemplateOptionValuePrice", "requestBody": { "required": true, "content": { @@ -16026,7 +5226,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of SwagCustomizedProductsTemplateOptionValuePrice", "content": { "application/vnd.api+json": { "schema": { @@ -16040,7 +5240,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -16058,7 +5258,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/SwagCustomizedProductsTemplateOptionValuePrice" } } } @@ -58271,28 +47471,64 @@ "field" ] }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" + "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." }, - "description": "Extensions data of event" + "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." + } } } } @@ -58534,64 +47770,28 @@ } ] }, - "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." + "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" } } } diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index 3f1dd99..d2017c5 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,126 +1,5 @@ { "paths": [ - "/aggregate/acl-role", - "/aggregate/app", - "/aggregate/app-action-button", - "/aggregate/app-administration-snippet", - "/aggregate/app-cms-block", - "/aggregate/app-flow-action", - "/aggregate/app-flow-event", - "/aggregate/app-payment-method", - "/aggregate/app-script-condition", - "/aggregate/app-shipping-method", - "/aggregate/app-template", - "/aggregate/category", - "/aggregate/cms-block", - "/aggregate/cms-page", - "/aggregate/cms-section", - "/aggregate/cms-slot", - "/aggregate/country", - "/aggregate/country-state", - "/aggregate/currency", - "/aggregate/currency-country-rounding", - "/aggregate/custom-entity", - "/aggregate/custom-field", - "/aggregate/custom-field-set", - "/aggregate/custom-field-set-relation", - "/aggregate/customer", - "/aggregate/customer-address", - "/aggregate/customer-group", - "/aggregate/customer-recovery", - "/aggregate/customer-wishlist", - "/aggregate/customer-wishlist-product", - "/aggregate/delivery-time", - "/aggregate/document", - "/aggregate/document-base-config", - "/aggregate/document-base-config-sales-channel", - "/aggregate/document-type", - "/aggregate/flow", - "/aggregate/flow-sequence", - "/aggregate/flow-template", - "/aggregate/import-export-file", - "/aggregate/import-export-log", - "/aggregate/import-export-profile", - "/aggregate/integration", - "/aggregate/landing-page", - "/aggregate/language", - "/aggregate/locale", - "/aggregate/log-entry", - "/aggregate/mail-header-footer", - "/aggregate/mail-template", - "/aggregate/mail-template-type", - "/aggregate/main-category", - "/aggregate/media", - "/aggregate/media-default-folder", - "/aggregate/media-folder", - "/aggregate/media-folder-configuration", - "/aggregate/media-thumbnail", - "/aggregate/media-thumbnail-size", - "/aggregate/newsletter-recipient", - "/aggregate/notification", - "/aggregate/number-range", - "/aggregate/number-range-sales-channel", - "/aggregate/number-range-state", - "/aggregate/number-range-type", - "/aggregate/order", - "/aggregate/order-address", - "/aggregate/order-customer", - "/aggregate/order-delivery", - "/aggregate/order-delivery-position", - "/aggregate/order-line-item", - "/aggregate/order-line-item-download", - "/aggregate/order-transaction", - "/aggregate/order-transaction-capture", - "/aggregate/order-transaction-capture-refund", - "/aggregate/order-transaction-capture-refund-position", - "/aggregate/payment-method", - "/aggregate/plugin", - "/aggregate/product", - "/aggregate/product-configurator-setting", - "/aggregate/product-cross-selling", - "/aggregate/product-cross-selling-assigned-products", - "/aggregate/product-download", - "/aggregate/product-export", - "/aggregate/product-feature-set", - "/aggregate/product-keyword-dictionary", - "/aggregate/product-manufacturer", - "/aggregate/product-media", - "/aggregate/product-price", - "/aggregate/product-review", - "/aggregate/product-search-config", - "/aggregate/product-search-config-field", - "/aggregate/product-search-keyword", - "/aggregate/product-sorting", - "/aggregate/product-stream", - "/aggregate/product-stream-filter", - "/aggregate/product-visibility", - "/aggregate/promotion", - "/aggregate/promotion-discount", - "/aggregate/promotion-discount-prices", - "/aggregate/promotion-individual-code", - "/aggregate/promotion-sales-channel", - "/aggregate/promotion-setgroup", - "/aggregate/property-group", - "/aggregate/property-group-option", - "/aggregate/rule", - "/aggregate/rule-condition", - "/aggregate/sales-channel", - "/aggregate/sales-channel-analytics", - "/aggregate/sales-channel-domain", - "/aggregate/sales-channel-type", - "/aggregate/salutation", - "/aggregate/scheduled-task", - "/aggregate/script", - "/aggregate/seo-url", - "/aggregate/seo-url-template", - "/aggregate/shipping-method", - "/aggregate/shipping-method-price", - "/aggregate/snippet", - "/aggregate/snippet-set", - "/aggregate/state-machine", - "/aggregate/state-machine-history", - "/aggregate/state-machine-state", - "/aggregate/state-machine-transition", "/aggregate/swag-customized-products-template", "/aggregate/swag-customized-products-template-configuration", "/aggregate/swag-customized-products-template-configuration-share", @@ -131,20 +10,6 @@ "/aggregate/swag-customized-products-template-option-price", "/aggregate/swag-customized-products-template-option-value", "/aggregate/swag-customized-products-template-option-value-price", - "/aggregate/system-config", - "/aggregate/tag", - "/aggregate/tax", - "/aggregate/tax-provider", - "/aggregate/tax-rule", - "/aggregate/tax-rule-type", - "/aggregate/theme", - "/aggregate/unit", - "/aggregate/user", - "/aggregate/user-access-key", - "/aggregate/user-config", - "/aggregate/user-recovery", - "/aggregate/webhook", - "/aggregate/webhook-event-log", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", From 13540d5a556134eec465aff0df8eef8093e64ea3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 20 Aug 2025 16:42:02 +0200 Subject: [PATCH 45/63] [create-pull-request] automated change (#378) Co-authored-by: shopwareBot --- adminapi.json | 14947 ++++++++++++++++++++++++---------------- adminapi.summary.json | 29 + 2 files changed, 8997 insertions(+), 5979 deletions(-) diff --git a/adminapi.json b/adminapi.json index 0cfcfdd..d348397 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.0.0" + "version": "6.7.1.2" }, "servers": [ { @@ -26315,14 +26315,14 @@ } } }, - "/media": { + "/measurement-display-unit": { "get": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "List with basic information of Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaList", + "summary": "List with basic information of Measurement Display Unit resources.", + "description": "Available since: 6.7.1.0", + "operationId": "getMeasurementDisplayUnitList", "parameters": [ { "name": "limit", @@ -26351,7 +26351,7 @@ ], "responses": { "200": { - "description": "List of Media resources.", + "description": "List of Measurement Display Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26370,7 +26370,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } ] @@ -26384,16 +26384,16 @@ "type": "object", "properties": { "first": { - "example": "/media?limit=25" + "example": "/measurement-display-unit?limit=25" }, "last": { - "example": "/media?limit=25&page=11" + "example": "/measurement-display-unit?limit=25&page=11" }, "next": { - "example": "/media?limit=25&page=4" + "example": "/measurement-display-unit?limit=25&page=4" }, "prev": { - "example": "/media?limit=25&page=2" + "example": "/measurement-display-unit?limit=25&page=2" } } } @@ -26414,7 +26414,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26429,11 +26429,11 @@ }, "post": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "Create a new Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMedia", + "summary": "Create a new Measurement Display Unit resources.", + "description": "Available since: 6.7.1.0", + "operationId": "createMeasurementDisplayUnit", "parameters": [ { "name": "_response", @@ -26452,14 +26452,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } }, "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { @@ -26471,7 +26471,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26486,7 +26486,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26502,14 +26502,14 @@ } } }, - "/search/media": { + "/search/measurement-display-unit": { "post": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "Search for the Media resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMedia", + "summary": "Search for the Measurement Display Unit resources.", + "description": "Available since: 6.7.1.0", + "operationId": "searchMeasurementDisplayUnit", "requestBody": { "required": true, "content": { @@ -26522,7 +26522,7 @@ }, "responses": { "200": { - "description": "List of Media", + "description": "List of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { @@ -26536,7 +26536,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26554,7 +26554,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26571,19 +26571,19 @@ } } }, - "/media/{id}": { + "/measurement-display-unit/{id}": { "get": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "Detailed information about a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMedia", + "summary": "Detailed information about a Measurement Display Unit resource.", + "description": "Available since: 6.7.1.0", + "operationId": "getMeasurementDisplayUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the measurement_display_unit", "required": true, "schema": { "type": "string", @@ -26593,7 +26593,7 @@ ], "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { @@ -26605,7 +26605,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26620,7 +26620,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26637,16 +26637,16 @@ }, "delete": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "Delete a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMedia", + "summary": "Delete a Measurement Display Unit resource.", + "description": "Available since: 6.7.1.0", + "operationId": "deleteMeasurementDisplayUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the measurement_display_unit", "required": true, "schema": { "type": "string", @@ -26677,16 +26677,16 @@ }, "patch": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "Partially update information about a Media resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMedia", + "summary": "Partially update information about a Measurement Display Unit resource.", + "description": "Available since: 6.7.1.0", + "operationId": "updateMeasurementDisplayUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media", + "description": "Identifier for the measurement_display_unit", "required": true, "schema": { "type": "string", @@ -26704,18 +26704,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media resource.", + "description": "Partially update information about a Measurement Display Unit resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } }, "responses": { "200": { - "description": "Detail of Media", + "description": "Detail of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { @@ -26727,7 +26727,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26742,7 +26742,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26761,14 +26761,14 @@ } } }, - "/aggregate/media": { + "/aggregate/measurement-display-unit": { "post": { "tags": [ - "Media" + "Measurement Display Unit" ], - "summary": "Aggregate for the Media resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMedia", + "summary": "Aggregate for the Measurement Display Unit resources.", + "description": "Available since: 6.7.1.0", + "operationId": "aggregateMeasurementDisplayUnit", "requestBody": { "required": true, "content": { @@ -26792,7 +26792,7 @@ }, "responses": { "200": { - "description": "List of Media", + "description": "List of MeasurementDisplayUnit", "content": { "application/vnd.api+json": { "schema": { @@ -26806,7 +26806,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26824,7 +26824,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } } @@ -26841,14 +26841,14 @@ } } }, - "/media-default-folder": { + "/measurement-system": { "get": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "List with basic information of Media Default Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolderList", + "summary": "List with basic information of Measurement System resources.", + "description": "Available since: 6.7.1.0", + "operationId": "getMeasurementSystemList", "parameters": [ { "name": "limit", @@ -26877,7 +26877,7 @@ ], "responses": { "200": { - "description": "List of Media Default Folder resources.", + "description": "List of Measurement System resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26896,7 +26896,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } ] @@ -26910,16 +26910,16 @@ "type": "object", "properties": { "first": { - "example": "/media-default-folder?limit=25" + "example": "/measurement-system?limit=25" }, "last": { - "example": "/media-default-folder?limit=25&page=11" + "example": "/measurement-system?limit=25&page=11" }, "next": { - "example": "/media-default-folder?limit=25&page=4" + "example": "/measurement-system?limit=25&page=4" }, "prev": { - "example": "/media-default-folder?limit=25&page=2" + "example": "/measurement-system?limit=25&page=2" } } } @@ -26940,7 +26940,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -26955,11 +26955,11 @@ }, "post": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "Create a new Media Default Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createMediaDefaultFolder", + "summary": "Create a new Measurement System resources.", + "description": "Available since: 6.7.1.0", + "operationId": "createMeasurementSystem", "parameters": [ { "name": "_response", @@ -26978,14 +26978,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } }, "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { @@ -26997,7 +26997,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27012,7 +27012,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27028,14 +27028,14 @@ } } }, - "/search/media-default-folder": { + "/search/measurement-system": { "post": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "Search for the Media Default Folder resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchMediaDefaultFolder", + "summary": "Search for the Measurement System resources.", + "description": "Available since: 6.7.1.0", + "operationId": "searchMeasurementSystem", "requestBody": { "required": true, "content": { @@ -27048,7 +27048,7 @@ }, "responses": { "200": { - "description": "List of MediaDefaultFolder", + "description": "List of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { @@ -27062,7 +27062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27080,7 +27080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27097,19 +27097,19 @@ } } }, - "/media-default-folder/{id}": { + "/measurement-system/{id}": { "get": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "Detailed information about a Media Default Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getMediaDefaultFolder", + "summary": "Detailed information about a Measurement System resource.", + "description": "Available since: 6.7.1.0", + "operationId": "getMeasurementSystem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the measurement_system", "required": true, "schema": { "type": "string", @@ -27119,7 +27119,7 @@ ], "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { @@ -27131,7 +27131,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27146,7 +27146,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27163,16 +27163,16 @@ }, "delete": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "Delete a Media Default Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaDefaultFolder", + "summary": "Delete a Measurement System resource.", + "description": "Available since: 6.7.1.0", + "operationId": "deleteMeasurementSystem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the measurement_system", "required": true, "schema": { "type": "string", @@ -27203,16 +27203,16 @@ }, "patch": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "Partially update information about a Media Default Folder resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateMediaDefaultFolder", + "summary": "Partially update information about a Measurement System resource.", + "description": "Available since: 6.7.1.0", + "operationId": "updateMeasurementSystem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_default_folder", + "description": "Identifier for the measurement_system", "required": true, "schema": { "type": "string", @@ -27230,18 +27230,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Default Folder resource.", + "description": "Partially update information about a Measurement System resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } }, "responses": { "200": { - "description": "Detail of MediaDefaultFolder", + "description": "Detail of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { @@ -27253,7 +27253,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27268,7 +27268,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27287,14 +27287,14 @@ } } }, - "/aggregate/media-default-folder": { + "/aggregate/measurement-system": { "post": { "tags": [ - "Media Default Folder" + "Measurement System" ], - "summary": "Aggregate for the Media Default Folder resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaDefaultFolder", + "summary": "Aggregate for the Measurement System resources.", + "description": "Available since: 6.7.1.0", + "operationId": "aggregateMeasurementSystem", "requestBody": { "required": true, "content": { @@ -27318,7 +27318,7 @@ }, "responses": { "200": { - "description": "List of MediaDefaultFolder", + "description": "List of MeasurementSystem", "content": { "application/vnd.api+json": { "schema": { @@ -27332,7 +27332,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27350,7 +27350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "$ref": "#/components/schemas/MeasurementSystem" } } } @@ -27367,14 +27367,14 @@ } } }, - "/media-folder": { + "/media": { "get": { "tags": [ - "Media Folder" + "Media" ], - "summary": "List with basic information of Media Folder resources.", + "summary": "List with basic information of Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderList", + "operationId": "getMediaList", "parameters": [ { "name": "limit", @@ -27403,7 +27403,7 @@ ], "responses": { "200": { - "description": "List of Media Folder resources.", + "description": "List of Media resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27422,7 +27422,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } ] @@ -27436,16 +27436,16 @@ "type": "object", "properties": { "first": { - "example": "/media-folder?limit=25" + "example": "/media?limit=25" }, "last": { - "example": "/media-folder?limit=25&page=11" + "example": "/media?limit=25&page=11" }, "next": { - "example": "/media-folder?limit=25&page=4" + "example": "/media?limit=25&page=4" }, "prev": { - "example": "/media-folder?limit=25&page=2" + "example": "/media?limit=25&page=2" } } } @@ -27466,7 +27466,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27481,11 +27481,11 @@ }, "post": { "tags": [ - "Media Folder" + "Media" ], - "summary": "Create a new Media Folder resources.", + "summary": "Create a new Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolder", + "operationId": "createMedia", "parameters": [ { "name": "_response", @@ -27504,14 +27504,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -27523,7 +27523,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27538,7 +27538,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27554,14 +27554,14 @@ } } }, - "/search/media-folder": { + "/search/media": { "post": { "tags": [ - "Media Folder" + "Media" ], - "summary": "Search for the Media Folder resources.", + "summary": "Search for the Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchMediaFolder", + "operationId": "searchMedia", "requestBody": { "required": true, "content": { @@ -27574,7 +27574,7 @@ }, "responses": { "200": { - "description": "List of MediaFolder", + "description": "List of Media", "content": { "application/vnd.api+json": { "schema": { @@ -27588,7 +27588,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27606,7 +27606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27623,19 +27623,19 @@ } } }, - "/media-folder/{id}": { + "/media/{id}": { "get": { "tags": [ - "Media Folder" + "Media" ], - "summary": "Detailed information about a Media Folder resource.", + "summary": "Detailed information about a Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolder", + "operationId": "getMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -27645,7 +27645,7 @@ ], "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -27657,7 +27657,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27672,7 +27672,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27689,16 +27689,16 @@ }, "delete": { "tags": [ - "Media Folder" + "Media" ], - "summary": "Delete a Media Folder resource.", + "summary": "Delete a Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolder", + "operationId": "deleteMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -27729,16 +27729,16 @@ }, "patch": { "tags": [ - "Media Folder" + "Media" ], - "summary": "Partially update information about a Media Folder resource.", + "summary": "Partially update information about a Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolder", + "operationId": "updateMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder", + "description": "Identifier for the media", "required": true, "schema": { "type": "string", @@ -27756,18 +27756,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Folder resource.", + "description": "Partially update information about a Media resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } }, "responses": { "200": { - "description": "Detail of MediaFolder", + "description": "Detail of Media", "content": { "application/vnd.api+json": { "schema": { @@ -27779,7 +27779,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27794,7 +27794,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27813,14 +27813,14 @@ } } }, - "/aggregate/media-folder": { + "/aggregate/media": { "post": { "tags": [ - "Media Folder" + "Media" ], - "summary": "Aggregate for the Media Folder resources.", + "summary": "Aggregate for the Media resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaFolder", + "operationId": "aggregateMedia", "requestBody": { "required": true, "content": { @@ -27844,7 +27844,7 @@ }, "responses": { "200": { - "description": "List of MediaFolder", + "description": "List of Media", "content": { "application/vnd.api+json": { "schema": { @@ -27858,7 +27858,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27876,7 +27876,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/Media" } } } @@ -27893,14 +27893,14 @@ } } }, - "/media-folder-configuration": { + "/media-default-folder": { "get": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "List with basic information of Media Folder Configuration resources.", + "summary": "List with basic information of Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfigurationList", + "operationId": "getMediaDefaultFolderList", "parameters": [ { "name": "limit", @@ -27929,7 +27929,7 @@ ], "responses": { "200": { - "description": "List of Media Folder Configuration resources.", + "description": "List of Media Default Folder resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27948,7 +27948,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } ] @@ -27962,16 +27962,16 @@ "type": "object", "properties": { "first": { - "example": "/media-folder-configuration?limit=25" + "example": "/media-default-folder?limit=25" }, "last": { - "example": "/media-folder-configuration?limit=25&page=11" + "example": "/media-default-folder?limit=25&page=11" }, "next": { - "example": "/media-folder-configuration?limit=25&page=4" + "example": "/media-default-folder?limit=25&page=4" }, "prev": { - "example": "/media-folder-configuration?limit=25&page=2" + "example": "/media-default-folder?limit=25&page=2" } } } @@ -27992,7 +27992,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28007,11 +28007,11 @@ }, "post": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "Create a new Media Folder Configuration resources.", + "summary": "Create a new Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaFolderConfiguration", + "operationId": "createMediaDefaultFolder", "parameters": [ { "name": "_response", @@ -28030,14 +28030,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28049,7 +28049,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28064,7 +28064,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28080,14 +28080,14 @@ } } }, - "/search/media-folder-configuration": { + "/search/media-default-folder": { "post": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "Search for the Media Folder Configuration resources.", + "summary": "Search for the Media Default Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchMediaFolderConfiguration", + "operationId": "searchMediaDefaultFolder", "requestBody": { "required": true, "content": { @@ -28100,7 +28100,7 @@ }, "responses": { "200": { - "description": "List of MediaFolderConfiguration", + "description": "List of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28114,7 +28114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28132,7 +28132,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28149,19 +28149,19 @@ } } }, - "/media-folder-configuration/{id}": { + "/media-default-folder/{id}": { "get": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "Detailed information about a Media Folder Configuration resource.", + "summary": "Detailed information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaFolderConfiguration", + "operationId": "getMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -28171,7 +28171,7 @@ ], "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28183,7 +28183,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28198,7 +28198,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28215,16 +28215,16 @@ }, "delete": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "Delete a Media Folder Configuration resource.", + "summary": "Delete a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaFolderConfiguration", + "operationId": "deleteMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -28255,16 +28255,16 @@ }, "patch": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "Partially update information about a Media Folder Configuration resource.", + "summary": "Partially update information about a Media Default Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaFolderConfiguration", + "operationId": "updateMediaDefaultFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_folder_configuration", + "description": "Identifier for the media_default_folder", "required": true, "schema": { "type": "string", @@ -28282,18 +28282,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Folder Configuration resource.", + "description": "Partially update information about a Media Default Folder resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaFolderConfiguration", + "description": "Detail of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28305,7 +28305,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28320,7 +28320,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28339,14 +28339,14 @@ } } }, - "/aggregate/media-folder-configuration": { + "/aggregate/media-default-folder": { "post": { "tags": [ - "Media Folder Configuration" + "Media Default Folder" ], - "summary": "Aggregate for the Media Folder Configuration resources.", + "summary": "Aggregate for the Media Default Folder resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaFolderConfiguration", + "operationId": "aggregateMediaDefaultFolder", "requestBody": { "required": true, "content": { @@ -28370,7 +28370,7 @@ }, "responses": { "200": { - "description": "List of MediaFolderConfiguration", + "description": "List of MediaDefaultFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28384,7 +28384,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28402,7 +28402,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MediaDefaultFolder" } } } @@ -28419,14 +28419,14 @@ } } }, - "/media-thumbnail": { + "/media-folder": { "get": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "List with basic information of Media Thumbnail resources.", + "summary": "List with basic information of Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailList", + "operationId": "getMediaFolderList", "parameters": [ { "name": "limit", @@ -28455,7 +28455,7 @@ ], "responses": { "200": { - "description": "List of Media Thumbnail resources.", + "description": "List of Media Folder resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28474,7 +28474,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } ] @@ -28488,16 +28488,16 @@ "type": "object", "properties": { "first": { - "example": "/media-thumbnail?limit=25" + "example": "/media-folder?limit=25" }, "last": { - "example": "/media-thumbnail?limit=25&page=11" + "example": "/media-folder?limit=25&page=11" }, "next": { - "example": "/media-thumbnail?limit=25&page=4" + "example": "/media-folder?limit=25&page=4" }, "prev": { - "example": "/media-thumbnail?limit=25&page=2" + "example": "/media-folder?limit=25&page=2" } } } @@ -28518,7 +28518,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28533,11 +28533,11 @@ }, "post": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "Create a new Media Thumbnail resources.", + "summary": "Create a new Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnail", + "operationId": "createMediaFolder", "parameters": [ { "name": "_response", @@ -28556,14 +28556,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28575,7 +28575,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28590,7 +28590,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28606,14 +28606,14 @@ } } }, - "/search/media-thumbnail": { + "/search/media-folder": { "post": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "Search for the Media Thumbnail resources.", + "summary": "Search for the Media Folder resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchMediaThumbnail", + "operationId": "searchMediaFolder", "requestBody": { "required": true, "content": { @@ -28626,7 +28626,7 @@ }, "responses": { "200": { - "description": "List of MediaThumbnail", + "description": "List of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28640,7 +28640,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28658,7 +28658,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28675,19 +28675,19 @@ } } }, - "/media-thumbnail/{id}": { + "/media-folder/{id}": { "get": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "Detailed information about a Media Thumbnail resource.", + "summary": "Detailed information about a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnail", + "operationId": "getMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -28697,7 +28697,7 @@ ], "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28709,7 +28709,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28724,7 +28724,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28741,16 +28741,16 @@ }, "delete": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "Delete a Media Thumbnail resource.", + "summary": "Delete a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnail", + "operationId": "deleteMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -28781,16 +28781,16 @@ }, "patch": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "Partially update information about a Media Thumbnail resource.", + "summary": "Partially update information about a Media Folder resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnail", + "operationId": "updateMediaFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail", + "description": "Identifier for the media_folder", "required": true, "schema": { "type": "string", @@ -28808,18 +28808,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Thumbnail resource.", + "description": "Partially update information about a Media Folder resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnail", + "description": "Detail of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28831,7 +28831,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28846,7 +28846,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28865,14 +28865,14 @@ } } }, - "/aggregate/media-thumbnail": { + "/aggregate/media-folder": { "post": { "tags": [ - "Media Thumbnail" + "Media Folder" ], - "summary": "Aggregate for the Media Thumbnail resources.", + "summary": "Aggregate for the Media Folder resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaThumbnail", + "operationId": "aggregateMediaFolder", "requestBody": { "required": true, "content": { @@ -28896,7 +28896,7 @@ }, "responses": { "200": { - "description": "List of MediaThumbnail", + "description": "List of MediaFolder", "content": { "application/vnd.api+json": { "schema": { @@ -28910,7 +28910,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28928,7 +28928,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "$ref": "#/components/schemas/MediaFolder" } } } @@ -28945,14 +28945,14 @@ } } }, - "/media-thumbnail-size": { + "/media-folder-configuration": { "get": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "List with basic information of Media Thumbnail Size resources.", + "summary": "List with basic information of Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSizeList", + "operationId": "getMediaFolderConfigurationList", "parameters": [ { "name": "limit", @@ -28981,7 +28981,7 @@ ], "responses": { "200": { - "description": "List of Media Thumbnail Size resources.", + "description": "List of Media Folder Configuration resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29000,7 +29000,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } ] @@ -29014,16 +29014,16 @@ "type": "object", "properties": { "first": { - "example": "/media-thumbnail-size?limit=25" + "example": "/media-folder-configuration?limit=25" }, "last": { - "example": "/media-thumbnail-size?limit=25&page=11" + "example": "/media-folder-configuration?limit=25&page=11" }, "next": { - "example": "/media-thumbnail-size?limit=25&page=4" + "example": "/media-folder-configuration?limit=25&page=4" }, "prev": { - "example": "/media-thumbnail-size?limit=25&page=2" + "example": "/media-folder-configuration?limit=25&page=2" } } } @@ -29044,7 +29044,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29059,11 +29059,11 @@ }, "post": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "Create a new Media Thumbnail Size resources.", + "summary": "Create a new Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "createMediaThumbnailSize", + "operationId": "createMediaFolderConfiguration", "parameters": [ { "name": "_response", @@ -29082,14 +29082,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -29101,7 +29101,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29116,7 +29116,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29132,14 +29132,14 @@ } } }, - "/search/media-thumbnail-size": { + "/search/media-folder-configuration": { "post": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "Search for the Media Thumbnail Size resources.", + "summary": "Search for the Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchMediaThumbnailSize", + "operationId": "searchMediaFolderConfiguration", "requestBody": { "required": true, "content": { @@ -29152,7 +29152,7 @@ }, "responses": { "200": { - "description": "List of MediaThumbnailSize", + "description": "List of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -29166,7 +29166,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29184,7 +29184,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29201,19 +29201,19 @@ } } }, - "/media-thumbnail-size/{id}": { + "/media-folder-configuration/{id}": { "get": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "Detailed information about a Media Thumbnail Size resource.", + "summary": "Detailed information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "getMediaThumbnailSize", + "operationId": "getMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -29223,7 +29223,7 @@ ], "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -29235,7 +29235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29250,7 +29250,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29267,16 +29267,16 @@ }, "delete": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "Delete a Media Thumbnail Size resource.", + "summary": "Delete a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteMediaThumbnailSize", + "operationId": "deleteMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -29307,16 +29307,16 @@ }, "patch": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "Partially update information about a Media Thumbnail Size resource.", + "summary": "Partially update information about a Media Folder Configuration resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateMediaThumbnailSize", + "operationId": "updateMediaFolderConfiguration", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_thumbnail_size", + "description": "Identifier for the media_folder_configuration", "required": true, "schema": { "type": "string", @@ -29334,18 +29334,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Thumbnail Size resource.", + "description": "Partially update information about a Media Folder Configuration resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } }, "responses": { "200": { - "description": "Detail of MediaThumbnailSize", + "description": "Detail of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -29357,7 +29357,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29372,7 +29372,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29391,14 +29391,14 @@ } } }, - "/aggregate/media-thumbnail-size": { + "/aggregate/media-folder-configuration": { "post": { "tags": [ - "Media Thumbnail Size" + "Media Folder Configuration" ], - "summary": "Aggregate for the Media Thumbnail Size resources.", + "summary": "Aggregate for the Media Folder Configuration resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaThumbnailSize", + "operationId": "aggregateMediaFolderConfiguration", "requestBody": { "required": true, "content": { @@ -29422,7 +29422,7 @@ }, "responses": { "200": { - "description": "List of MediaThumbnailSize", + "description": "List of MediaFolderConfiguration", "content": { "application/vnd.api+json": { "schema": { @@ -29436,7 +29436,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29454,7 +29454,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MediaFolderConfiguration" } } } @@ -29471,14 +29471,14 @@ } } }, - "/newsletter-recipient": { + "/media-thumbnail": { "get": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "List with basic information of Newsletter Recipient resources.", + "summary": "List with basic information of Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipientList", + "operationId": "getMediaThumbnailList", "parameters": [ { "name": "limit", @@ -29507,7 +29507,7 @@ ], "responses": { "200": { - "description": "List of Newsletter Recipient resources.", + "description": "List of Media Thumbnail resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29526,7 +29526,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } ] @@ -29540,16 +29540,16 @@ "type": "object", "properties": { "first": { - "example": "/newsletter-recipient?limit=25" + "example": "/media-thumbnail?limit=25" }, "last": { - "example": "/newsletter-recipient?limit=25&page=11" + "example": "/media-thumbnail?limit=25&page=11" }, "next": { - "example": "/newsletter-recipient?limit=25&page=4" + "example": "/media-thumbnail?limit=25&page=4" }, "prev": { - "example": "/newsletter-recipient?limit=25&page=2" + "example": "/media-thumbnail?limit=25&page=2" } } } @@ -29570,7 +29570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29585,11 +29585,11 @@ }, "post": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "Create a new Newsletter Recipient resources.", + "summary": "Create a new Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNewsletterRecipient", + "operationId": "createMediaThumbnail", "parameters": [ { "name": "_response", @@ -29608,14 +29608,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -29627,7 +29627,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29642,7 +29642,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29658,14 +29658,14 @@ } } }, - "/search/newsletter-recipient": { + "/search/media-thumbnail": { "post": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "Search for the Newsletter Recipient resources.", + "summary": "Search for the Media Thumbnail resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchNewsletterRecipient", + "operationId": "searchMediaThumbnail", "requestBody": { "required": true, "content": { @@ -29678,7 +29678,7 @@ }, "responses": { "200": { - "description": "List of NewsletterRecipient", + "description": "List of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -29692,7 +29692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29710,7 +29710,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29727,19 +29727,19 @@ } } }, - "/newsletter-recipient/{id}": { + "/media-thumbnail/{id}": { "get": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "Detailed information about a Newsletter Recipient resource.", + "summary": "Detailed information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNewsletterRecipient", + "operationId": "getMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -29749,7 +29749,7 @@ ], "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -29761,7 +29761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29776,7 +29776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29793,16 +29793,16 @@ }, "delete": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "Delete a Newsletter Recipient resource.", + "summary": "Delete a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNewsletterRecipient", + "operationId": "deleteMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -29833,16 +29833,16 @@ }, "patch": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "Partially update information about a Newsletter Recipient resource.", + "summary": "Partially update information about a Media Thumbnail resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNewsletterRecipient", + "operationId": "updateMediaThumbnail", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the newsletter_recipient", + "description": "Identifier for the media_thumbnail", "required": true, "schema": { "type": "string", @@ -29860,18 +29860,18 @@ } ], "requestBody": { - "description": "Partially update information about a Newsletter Recipient resource.", + "description": "Partially update information about a Media Thumbnail resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } }, "responses": { "200": { - "description": "Detail of NewsletterRecipient", + "description": "Detail of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -29883,7 +29883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29898,7 +29898,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29917,14 +29917,14 @@ } } }, - "/aggregate/newsletter-recipient": { + "/aggregate/media-thumbnail": { "post": { "tags": [ - "Newsletter Recipient" + "Media Thumbnail" ], - "summary": "Aggregate for the Newsletter Recipient resources.", + "summary": "Aggregate for the Media Thumbnail resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateNewsletterRecipient", + "operationId": "aggregateMediaThumbnail", "requestBody": { "required": true, "content": { @@ -29948,7 +29948,7 @@ }, "responses": { "200": { - "description": "List of NewsletterRecipient", + "description": "List of MediaThumbnail", "content": { "application/vnd.api+json": { "schema": { @@ -29962,7 +29962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29980,7 +29980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "$ref": "#/components/schemas/MediaThumbnail" } } } @@ -29997,14 +29997,14 @@ } } }, - "/notification": { + "/media-thumbnail-size": { "get": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "List with basic information of Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotificationList", + "summary": "List with basic information of Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaThumbnailSizeList", "parameters": [ { "name": "limit", @@ -30033,7 +30033,7 @@ ], "responses": { "200": { - "description": "List of Notification resources.", + "description": "List of Media Thumbnail Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30052,7 +30052,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } ] @@ -30066,16 +30066,16 @@ "type": "object", "properties": { "first": { - "example": "/notification?limit=25" + "example": "/media-thumbnail-size?limit=25" }, "last": { - "example": "/notification?limit=25&page=11" + "example": "/media-thumbnail-size?limit=25&page=11" }, "next": { - "example": "/notification?limit=25&page=4" + "example": "/media-thumbnail-size?limit=25&page=4" }, "prev": { - "example": "/notification?limit=25&page=2" + "example": "/media-thumbnail-size?limit=25&page=2" } } } @@ -30096,7 +30096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30111,11 +30111,11 @@ }, "post": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "Create a new Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createNotification", + "summary": "Create a new Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createMediaThumbnailSize", "parameters": [ { "name": "_response", @@ -30134,14 +30134,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -30153,7 +30153,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30168,7 +30168,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30184,14 +30184,14 @@ } } }, - "/search/notification": { + "/search/media-thumbnail-size": { "post": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "Search for the Notification resources.", - "description": "Available since: 6.4.7.0", - "operationId": "searchNotification", + "summary": "Search for the Media Thumbnail Size resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchMediaThumbnailSize", "requestBody": { "required": true, "content": { @@ -30204,7 +30204,7 @@ }, "responses": { "200": { - "description": "List of Notification", + "description": "List of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -30218,7 +30218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30236,7 +30236,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30253,19 +30253,19 @@ } } }, - "/notification/{id}": { + "/media-thumbnail-size/{id}": { "get": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "Detailed information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getNotification", + "summary": "Detailed information about a Media Thumbnail Size resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -30275,7 +30275,7 @@ ], "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -30287,7 +30287,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30302,7 +30302,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30319,16 +30319,16 @@ }, "delete": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "Delete a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteNotification", + "summary": "Delete a Media Thumbnail Size resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -30359,16 +30359,16 @@ }, "patch": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "Partially update information about a Notification resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateNotification", + "summary": "Partially update information about a Media Thumbnail Size resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateMediaThumbnailSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the notification", + "description": "Identifier for the media_thumbnail_size", "required": true, "schema": { "type": "string", @@ -30386,18 +30386,18 @@ } ], "requestBody": { - "description": "Partially update information about a Notification resource.", + "description": "Partially update information about a Media Thumbnail Size resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } }, "responses": { "200": { - "description": "Detail of Notification", + "description": "Detail of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -30409,7 +30409,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30424,7 +30424,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30443,14 +30443,14 @@ } } }, - "/aggregate/notification": { + "/aggregate/media-thumbnail-size": { "post": { "tags": [ - "Notification" + "Media Thumbnail Size" ], - "summary": "Aggregate for the Notification resources.", + "summary": "Aggregate for the Media Thumbnail Size resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateNotification", + "operationId": "aggregateMediaThumbnailSize", "requestBody": { "required": true, "content": { @@ -30474,7 +30474,7 @@ }, "responses": { "200": { - "description": "List of Notification", + "description": "List of MediaThumbnailSize", "content": { "application/vnd.api+json": { "schema": { @@ -30488,7 +30488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30506,7 +30506,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Notification" + "$ref": "#/components/schemas/MediaThumbnailSize" } } } @@ -30523,14 +30523,14 @@ } } }, - "/number-range": { + "/newsletter-recipient": { "get": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "List with basic information of Number Range resources.", + "summary": "List with basic information of Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeList", + "operationId": "getNewsletterRecipientList", "parameters": [ { "name": "limit", @@ -30559,7 +30559,7 @@ ], "responses": { "200": { - "description": "List of Number Range resources.", + "description": "List of Newsletter Recipient resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30578,7 +30578,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } ] @@ -30592,16 +30592,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range?limit=25" + "example": "/newsletter-recipient?limit=25" }, "last": { - "example": "/number-range?limit=25&page=11" + "example": "/newsletter-recipient?limit=25&page=11" }, "next": { - "example": "/number-range?limit=25&page=4" + "example": "/newsletter-recipient?limit=25&page=4" }, "prev": { - "example": "/number-range?limit=25&page=2" + "example": "/newsletter-recipient?limit=25&page=2" } } } @@ -30622,7 +30622,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30637,11 +30637,11 @@ }, "post": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "Create a new Number Range resources.", + "summary": "Create a new Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRange", + "operationId": "createNewsletterRecipient", "parameters": [ { "name": "_response", @@ -30660,14 +30660,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -30679,7 +30679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30694,7 +30694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30710,14 +30710,14 @@ } } }, - "/search/number-range": { + "/search/newsletter-recipient": { "post": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "Search for the Number Range resources.", + "summary": "Search for the Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRange", + "operationId": "searchNewsletterRecipient", "requestBody": { "required": true, "content": { @@ -30730,7 +30730,7 @@ }, "responses": { "200": { - "description": "List of NumberRange", + "description": "List of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -30744,7 +30744,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30762,7 +30762,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30779,19 +30779,19 @@ } } }, - "/number-range/{id}": { + "/newsletter-recipient/{id}": { "get": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "Detailed information about a Number Range resource.", + "summary": "Detailed information about a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRange", + "operationId": "getNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -30801,7 +30801,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -30813,7 +30813,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30828,7 +30828,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30845,16 +30845,16 @@ }, "delete": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "Delete a Number Range resource.", + "summary": "Delete a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRange", + "operationId": "deleteNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -30885,16 +30885,16 @@ }, "patch": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "Partially update information about a Number Range resource.", + "summary": "Partially update information about a Newsletter Recipient resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRange", + "operationId": "updateNewsletterRecipient", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range", + "description": "Identifier for the newsletter_recipient", "required": true, "schema": { "type": "string", @@ -30912,18 +30912,18 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range resource.", + "description": "Partially update information about a Newsletter Recipient resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } }, "responses": { "200": { - "description": "Detail of NumberRange", + "description": "Detail of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -30935,7 +30935,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30950,7 +30950,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -30969,14 +30969,14 @@ } } }, - "/aggregate/number-range": { + "/aggregate/newsletter-recipient": { "post": { "tags": [ - "Number Range" + "Newsletter Recipient" ], - "summary": "Aggregate for the Number Range resources.", + "summary": "Aggregate for the Newsletter Recipient resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRange", + "operationId": "aggregateNewsletterRecipient", "requestBody": { "required": true, "content": { @@ -31000,7 +31000,7 @@ }, "responses": { "200": { - "description": "List of NumberRange", + "description": "List of NewsletterRecipient", "content": { "application/vnd.api+json": { "schema": { @@ -31014,7 +31014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -31032,7 +31032,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRange" + "$ref": "#/components/schemas/NewsletterRecipient" } } } @@ -31049,14 +31049,14 @@ } } }, - "/number-range-sales-channel": { + "/notification": { "get": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "List with basic information of Number Range Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannelList", + "summary": "List with basic information of Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotificationList", "parameters": [ { "name": "limit", @@ -31085,7 +31085,7 @@ ], "responses": { "200": { - "description": "List of Number Range Sales Channel resources.", + "description": "List of Notification resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31104,7 +31104,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } ] @@ -31118,16 +31118,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-sales-channel?limit=25" + "example": "/notification?limit=25" }, "last": { - "example": "/number-range-sales-channel?limit=25&page=11" + "example": "/notification?limit=25&page=11" }, "next": { - "example": "/number-range-sales-channel?limit=25&page=4" + "example": "/notification?limit=25&page=4" }, "prev": { - "example": "/number-range-sales-channel?limit=25&page=2" + "example": "/notification?limit=25&page=2" } } } @@ -31148,7 +31148,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31163,11 +31163,11 @@ }, "post": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "Create a new Number Range Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeSalesChannel", + "summary": "Create a new Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createNotification", "parameters": [ { "name": "_response", @@ -31186,14 +31186,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -31205,7 +31205,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31220,7 +31220,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31236,14 +31236,14 @@ } } }, - "/search/number-range-sales-channel": { + "/search/notification": { "post": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "Search for the Number Range Sales Channel resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRangeSalesChannel", + "summary": "Search for the Notification resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchNotification", "requestBody": { "required": true, "content": { @@ -31256,7 +31256,7 @@ }, "responses": { "200": { - "description": "List of NumberRangeSalesChannel", + "description": "List of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -31270,7 +31270,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31288,7 +31288,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31305,19 +31305,19 @@ } } }, - "/number-range-sales-channel/{id}": { + "/notification/{id}": { "get": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "Detailed information about a Number Range Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeSalesChannel", + "summary": "Detailed information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "getNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -31327,7 +31327,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -31339,7 +31339,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31354,7 +31354,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31371,16 +31371,16 @@ }, "delete": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "Delete a Number Range Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeSalesChannel", + "summary": "Delete a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -31411,16 +31411,16 @@ }, "patch": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "Partially update information about a Number Range Sales Channel resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeSalesChannel", + "summary": "Partially update information about a Notification resource.", + "description": "Available since: 6.4.7.0", + "operationId": "updateNotification", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_sales_channel", + "description": "Identifier for the notification", "required": true, "schema": { "type": "string", @@ -31438,18 +31438,18 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range Sales Channel resource.", + "description": "Partially update information about a Notification resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeSalesChannel", + "description": "Detail of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -31461,7 +31461,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31476,7 +31476,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31495,14 +31495,14 @@ } } }, - "/aggregate/number-range-sales-channel": { + "/aggregate/notification": { "post": { "tags": [ - "Number Range Sales Channel" + "Notification" ], - "summary": "Aggregate for the Number Range Sales Channel resources.", + "summary": "Aggregate for the Notification resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeSalesChannel", + "operationId": "aggregateNotification", "requestBody": { "required": true, "content": { @@ -31526,7 +31526,7 @@ }, "responses": { "200": { - "description": "List of NumberRangeSalesChannel", + "description": "List of Notification", "content": { "application/vnd.api+json": { "schema": { @@ -31540,7 +31540,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31558,7 +31558,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "$ref": "#/components/schemas/Notification" } } } @@ -31575,14 +31575,14 @@ } } }, - "/number-range-state": { + "/number-range": { "get": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "List with basic information of Number Range State resources.", + "summary": "List with basic information of Number Range resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeStateList", + "operationId": "getNumberRangeList", "parameters": [ { "name": "limit", @@ -31611,7 +31611,7 @@ ], "responses": { "200": { - "description": "List of Number Range State resources.", + "description": "List of Number Range resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31630,7 +31630,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } ] @@ -31644,16 +31644,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-state?limit=25" + "example": "/number-range?limit=25" }, "last": { - "example": "/number-range-state?limit=25&page=11" + "example": "/number-range?limit=25&page=11" }, "next": { - "example": "/number-range-state?limit=25&page=4" + "example": "/number-range?limit=25&page=4" }, "prev": { - "example": "/number-range-state?limit=25&page=2" + "example": "/number-range?limit=25&page=2" } } } @@ -31674,7 +31674,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31689,11 +31689,11 @@ }, "post": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "Create a new Number Range State resources.", + "summary": "Create a new Number Range resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeState", + "operationId": "createNumberRange", "parameters": [ { "name": "_response", @@ -31712,14 +31712,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -31731,7 +31731,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31746,7 +31746,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31762,14 +31762,14 @@ } } }, - "/search/number-range-state": { + "/search/number-range": { "post": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "Search for the Number Range State resources.", + "summary": "Search for the Number Range resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRangeState", + "operationId": "searchNumberRange", "requestBody": { "required": true, "content": { @@ -31782,7 +31782,7 @@ }, "responses": { "200": { - "description": "List of NumberRangeState", + "description": "List of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -31796,7 +31796,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31814,7 +31814,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31831,19 +31831,19 @@ } } }, - "/number-range-state/{id}": { + "/number-range/{id}": { "get": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "Detailed information about a Number Range State resource.", + "summary": "Detailed information about a Number Range resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeState", + "operationId": "getNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -31853,7 +31853,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -31865,7 +31865,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31880,7 +31880,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -31897,16 +31897,16 @@ }, "delete": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "Delete a Number Range State resource.", + "summary": "Delete a Number Range resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeState", + "operationId": "deleteNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -31937,16 +31937,16 @@ }, "patch": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "Partially update information about a Number Range State resource.", + "summary": "Partially update information about a Number Range resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeState", + "operationId": "updateNumberRange", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_state", + "description": "Identifier for the number_range", "required": true, "schema": { "type": "string", @@ -31964,18 +31964,18 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range State resource.", + "description": "Partially update information about a Number Range resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeState", + "description": "Detail of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -31987,7 +31987,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -32002,7 +32002,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -32021,14 +32021,14 @@ } } }, - "/aggregate/number-range-state": { + "/aggregate/number-range": { "post": { "tags": [ - "Number Range State" + "Number Range" ], - "summary": "Aggregate for the Number Range State resources.", + "summary": "Aggregate for the Number Range resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeState", + "operationId": "aggregateNumberRange", "requestBody": { "required": true, "content": { @@ -32052,7 +32052,7 @@ }, "responses": { "200": { - "description": "List of NumberRangeState", + "description": "List of NumberRange", "content": { "application/vnd.api+json": { "schema": { @@ -32066,7 +32066,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -32084,7 +32084,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeState" + "$ref": "#/components/schemas/NumberRange" } } } @@ -32101,14 +32101,14 @@ } } }, - "/number-range-type": { + "/number-range-sales-channel": { "get": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "List with basic information of Number Range Type resources.", + "summary": "List with basic information of Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeTypeList", + "operationId": "getNumberRangeSalesChannelList", "parameters": [ { "name": "limit", @@ -32137,7 +32137,7 @@ ], "responses": { "200": { - "description": "List of Number Range Type resources.", + "description": "List of Number Range Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32156,7 +32156,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } ] @@ -32170,16 +32170,16 @@ "type": "object", "properties": { "first": { - "example": "/number-range-type?limit=25" + "example": "/number-range-sales-channel?limit=25" }, "last": { - "example": "/number-range-type?limit=25&page=11" + "example": "/number-range-sales-channel?limit=25&page=11" }, "next": { - "example": "/number-range-type?limit=25&page=4" + "example": "/number-range-sales-channel?limit=25&page=4" }, "prev": { - "example": "/number-range-type?limit=25&page=2" + "example": "/number-range-sales-channel?limit=25&page=2" } } } @@ -32200,7 +32200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32215,11 +32215,11 @@ }, "post": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "Create a new Number Range Type resources.", + "summary": "Create a new Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createNumberRangeType", + "operationId": "createNumberRangeSalesChannel", "parameters": [ { "name": "_response", @@ -32238,14 +32238,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -32257,7 +32257,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32272,7 +32272,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32288,14 +32288,14 @@ } } }, - "/search/number-range-type": { + "/search/number-range-sales-channel": { "post": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "Search for the Number Range Type resources.", + "summary": "Search for the Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchNumberRangeType", + "operationId": "searchNumberRangeSalesChannel", "requestBody": { "required": true, "content": { @@ -32308,7 +32308,7 @@ }, "responses": { "200": { - "description": "List of NumberRangeType", + "description": "List of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -32322,7 +32322,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32340,7 +32340,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32357,19 +32357,19 @@ } } }, - "/number-range-type/{id}": { + "/number-range-sales-channel/{id}": { "get": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "Detailed information about a Number Range Type resource.", + "summary": "Detailed information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getNumberRangeType", + "operationId": "getNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -32379,7 +32379,7 @@ ], "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -32391,7 +32391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32406,7 +32406,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32423,16 +32423,16 @@ }, "delete": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "Delete a Number Range Type resource.", + "summary": "Delete a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteNumberRangeType", + "operationId": "deleteNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -32463,16 +32463,16 @@ }, "patch": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "Partially update information about a Number Range Type resource.", + "summary": "Partially update information about a Number Range Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateNumberRangeType", + "operationId": "updateNumberRangeSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the number_range_type", + "description": "Identifier for the number_range_sales_channel", "required": true, "schema": { "type": "string", @@ -32490,18 +32490,18 @@ } ], "requestBody": { - "description": "Partially update information about a Number Range Type resource.", + "description": "Partially update information about a Number Range Sales Channel resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of NumberRangeType", + "description": "Detail of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -32513,7 +32513,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32528,7 +32528,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32547,14 +32547,14 @@ } } }, - "/aggregate/number-range-type": { + "/aggregate/number-range-sales-channel": { "post": { "tags": [ - "Number Range Type" + "Number Range Sales Channel" ], - "summary": "Aggregate for the Number Range Type resources.", + "summary": "Aggregate for the Number Range Sales Channel resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeType", + "operationId": "aggregateNumberRangeSalesChannel", "requestBody": { "required": true, "content": { @@ -32578,7 +32578,7 @@ }, "responses": { "200": { - "description": "List of NumberRangeType", + "description": "List of NumberRangeSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -32592,7 +32592,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32610,7 +32610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/NumberRangeType" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } } @@ -32627,14 +32627,14 @@ } } }, - "/order": { + "/number-range-state": { "get": { "tags": [ - "Order" + "Number Range State" ], - "summary": "List with basic information of Order resources.", + "summary": "List with basic information of Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderList", + "operationId": "getNumberRangeStateList", "parameters": [ { "name": "limit", @@ -32663,7 +32663,7 @@ ], "responses": { "200": { - "description": "List of Order resources.", + "description": "List of Number Range State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32682,7 +32682,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } ] @@ -32696,16 +32696,16 @@ "type": "object", "properties": { "first": { - "example": "/order?limit=25" + "example": "/number-range-state?limit=25" }, "last": { - "example": "/order?limit=25&page=11" + "example": "/number-range-state?limit=25&page=11" }, "next": { - "example": "/order?limit=25&page=4" + "example": "/number-range-state?limit=25&page=4" }, "prev": { - "example": "/order?limit=25&page=2" + "example": "/number-range-state?limit=25&page=2" } } } @@ -32726,7 +32726,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32741,11 +32741,11 @@ }, "post": { "tags": [ - "Order" + "Number Range State" ], - "summary": "Create a new Order resources.", + "summary": "Create a new Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrder", + "operationId": "createNumberRangeState", "parameters": [ { "name": "_response", @@ -32764,14 +32764,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -32783,7 +32783,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32798,7 +32798,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32814,14 +32814,14 @@ } } }, - "/search/order": { + "/search/number-range-state": { "post": { "tags": [ - "Order" + "Number Range State" ], - "summary": "Search for the Order resources.", + "summary": "Search for the Number Range State resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrder", + "operationId": "searchNumberRangeState", "requestBody": { "required": true, "content": { @@ -32834,7 +32834,7 @@ }, "responses": { "200": { - "description": "List of Order", + "description": "List of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -32848,7 +32848,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32866,7 +32866,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32883,19 +32883,19 @@ } } }, - "/order/{id}": { + "/number-range-state/{id}": { "get": { "tags": [ - "Order" + "Number Range State" ], - "summary": "Detailed information about a Order resource.", + "summary": "Detailed information about a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrder", + "operationId": "getNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -32905,7 +32905,7 @@ ], "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -32917,7 +32917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32932,7 +32932,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -32949,16 +32949,16 @@ }, "delete": { "tags": [ - "Order" + "Number Range State" ], - "summary": "Delete a Order resource.", + "summary": "Delete a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrder", + "operationId": "deleteNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -32989,16 +32989,16 @@ }, "patch": { "tags": [ - "Order" + "Number Range State" ], - "summary": "Partially update information about a Order resource.", + "summary": "Partially update information about a Number Range State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrder", + "operationId": "updateNumberRangeState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order", + "description": "Identifier for the number_range_state", "required": true, "schema": { "type": "string", @@ -33016,18 +33016,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order resource.", + "description": "Partially update information about a Number Range State resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } }, "responses": { "200": { - "description": "Detail of Order", + "description": "Detail of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -33039,7 +33039,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -33054,7 +33054,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -33073,14 +33073,14 @@ } } }, - "/aggregate/order": { + "/aggregate/number-range-state": { "post": { "tags": [ - "Order" + "Number Range State" ], - "summary": "Aggregate for the Order resources.", + "summary": "Aggregate for the Number Range State resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrder", + "operationId": "aggregateNumberRangeState", "requestBody": { "required": true, "content": { @@ -33104,7 +33104,7 @@ }, "responses": { "200": { - "description": "List of Order", + "description": "List of NumberRangeState", "content": { "application/vnd.api+json": { "schema": { @@ -33118,7 +33118,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -33136,7 +33136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Order" + "$ref": "#/components/schemas/NumberRangeState" } } } @@ -33153,14 +33153,14 @@ } } }, - "/order-address": { + "/number-range-type": { "get": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "List with basic information of Order Address resources.", + "summary": "List with basic information of Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddressList", + "operationId": "getNumberRangeTypeList", "parameters": [ { "name": "limit", @@ -33189,7 +33189,7 @@ ], "responses": { "200": { - "description": "List of Order Address resources.", + "description": "List of Number Range Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33208,7 +33208,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } ] @@ -33222,16 +33222,16 @@ "type": "object", "properties": { "first": { - "example": "/order-address?limit=25" + "example": "/number-range-type?limit=25" }, "last": { - "example": "/order-address?limit=25&page=11" + "example": "/number-range-type?limit=25&page=11" }, "next": { - "example": "/order-address?limit=25&page=4" + "example": "/number-range-type?limit=25&page=4" }, "prev": { - "example": "/order-address?limit=25&page=2" + "example": "/number-range-type?limit=25&page=2" } } } @@ -33252,7 +33252,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33267,11 +33267,11 @@ }, "post": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "Create a new Order Address resources.", + "summary": "Create a new Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderAddress", + "operationId": "createNumberRangeType", "parameters": [ { "name": "_response", @@ -33290,14 +33290,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -33309,7 +33309,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33324,7 +33324,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33340,14 +33340,14 @@ } } }, - "/search/order-address": { + "/search/number-range-type": { "post": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "Search for the Order Address resources.", + "summary": "Search for the Number Range Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrderAddress", + "operationId": "searchNumberRangeType", "requestBody": { "required": true, "content": { @@ -33360,7 +33360,7 @@ }, "responses": { "200": { - "description": "List of OrderAddress", + "description": "List of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -33374,7 +33374,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33392,7 +33392,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33409,19 +33409,19 @@ } } }, - "/order-address/{id}": { + "/number-range-type/{id}": { "get": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "Detailed information about a Order Address resource.", + "summary": "Detailed information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderAddress", + "operationId": "getNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -33431,7 +33431,7 @@ ], "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -33443,7 +33443,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33458,7 +33458,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33475,16 +33475,16 @@ }, "delete": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "Delete a Order Address resource.", + "summary": "Delete a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderAddress", + "operationId": "deleteNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -33515,16 +33515,16 @@ }, "patch": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "Partially update information about a Order Address resource.", + "summary": "Partially update information about a Number Range Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderAddress", + "operationId": "updateNumberRangeType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_address", + "description": "Identifier for the number_range_type", "required": true, "schema": { "type": "string", @@ -33542,18 +33542,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Address resource.", + "description": "Partially update information about a Number Range Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } }, "responses": { "200": { - "description": "Detail of OrderAddress", + "description": "Detail of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -33565,7 +33565,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33580,7 +33580,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33599,14 +33599,14 @@ } } }, - "/aggregate/order-address": { + "/aggregate/number-range-type": { "post": { "tags": [ - "Order Address" + "Number Range Type" ], - "summary": "Aggregate for the Order Address resources.", + "summary": "Aggregate for the Number Range Type resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderAddress", + "operationId": "aggregateNumberRangeType", "requestBody": { "required": true, "content": { @@ -33630,7 +33630,7 @@ }, "responses": { "200": { - "description": "List of OrderAddress", + "description": "List of NumberRangeType", "content": { "application/vnd.api+json": { "schema": { @@ -33644,7 +33644,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33662,7 +33662,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/NumberRangeType" } } } @@ -33679,14 +33679,14 @@ } } }, - "/order-customer": { + "/order": { "get": { "tags": [ - "Order Customer" + "Order" ], - "summary": "List with basic information of Order Customer resources.", + "summary": "List with basic information of Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomerList", + "operationId": "getOrderList", "parameters": [ { "name": "limit", @@ -33715,7 +33715,7 @@ ], "responses": { "200": { - "description": "List of Order Customer resources.", + "description": "List of Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33734,7 +33734,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } ] @@ -33748,16 +33748,16 @@ "type": "object", "properties": { "first": { - "example": "/order-customer?limit=25" + "example": "/order?limit=25" }, "last": { - "example": "/order-customer?limit=25&page=11" + "example": "/order?limit=25&page=11" }, "next": { - "example": "/order-customer?limit=25&page=4" + "example": "/order?limit=25&page=4" }, "prev": { - "example": "/order-customer?limit=25&page=2" + "example": "/order?limit=25&page=2" } } } @@ -33778,7 +33778,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -33793,11 +33793,11 @@ }, "post": { "tags": [ - "Order Customer" + "Order" ], - "summary": "Create a new Order Customer resources.", + "summary": "Create a new Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderCustomer", + "operationId": "createOrder", "parameters": [ { "name": "_response", @@ -33816,14 +33816,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -33835,7 +33835,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -33850,7 +33850,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -33866,14 +33866,14 @@ } } }, - "/search/order-customer": { + "/search/order": { "post": { "tags": [ - "Order Customer" + "Order" ], - "summary": "Search for the Order Customer resources.", + "summary": "Search for the Order resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrderCustomer", + "operationId": "searchOrder", "requestBody": { "required": true, "content": { @@ -33886,7 +33886,7 @@ }, "responses": { "200": { - "description": "List of OrderCustomer", + "description": "List of Order", "content": { "application/vnd.api+json": { "schema": { @@ -33900,7 +33900,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -33918,7 +33918,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -33935,19 +33935,19 @@ } } }, - "/order-customer/{id}": { + "/order/{id}": { "get": { "tags": [ - "Order Customer" + "Order" ], - "summary": "Detailed information about a Order Customer resource.", + "summary": "Detailed information about a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderCustomer", + "operationId": "getOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -33957,7 +33957,7 @@ ], "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -33969,7 +33969,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -33984,7 +33984,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -34001,16 +34001,16 @@ }, "delete": { "tags": [ - "Order Customer" + "Order" ], - "summary": "Delete a Order Customer resource.", + "summary": "Delete a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderCustomer", + "operationId": "deleteOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -34041,16 +34041,16 @@ }, "patch": { "tags": [ - "Order Customer" + "Order" ], - "summary": "Partially update information about a Order Customer resource.", + "summary": "Partially update information about a Order resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderCustomer", + "operationId": "updateOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_customer", + "description": "Identifier for the order", "required": true, "schema": { "type": "string", @@ -34068,18 +34068,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Customer resource.", + "description": "Partially update information about a Order resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } }, "responses": { "200": { - "description": "Detail of OrderCustomer", + "description": "Detail of Order", "content": { "application/vnd.api+json": { "schema": { @@ -34091,7 +34091,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -34106,7 +34106,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -34125,14 +34125,14 @@ } } }, - "/aggregate/order-customer": { + "/aggregate/order": { "post": { "tags": [ - "Order Customer" + "Order" ], - "summary": "Aggregate for the Order Customer resources.", + "summary": "Aggregate for the Order resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderCustomer", + "operationId": "aggregateOrder", "requestBody": { "required": true, "content": { @@ -34156,7 +34156,7 @@ }, "responses": { "200": { - "description": "List of OrderCustomer", + "description": "List of Order", "content": { "application/vnd.api+json": { "schema": { @@ -34170,7 +34170,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -34188,7 +34188,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/Order" } } } @@ -34205,14 +34205,14 @@ } } }, - "/order-delivery": { + "/order-address": { "get": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "List with basic information of Order Delivery resources.", + "summary": "List with basic information of Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryList", + "operationId": "getOrderAddressList", "parameters": [ { "name": "limit", @@ -34241,7 +34241,7 @@ ], "responses": { "200": { - "description": "List of Order Delivery resources.", + "description": "List of Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34260,7 +34260,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } ] @@ -34274,16 +34274,16 @@ "type": "object", "properties": { "first": { - "example": "/order-delivery?limit=25" + "example": "/order-address?limit=25" }, "last": { - "example": "/order-delivery?limit=25&page=11" + "example": "/order-address?limit=25&page=11" }, "next": { - "example": "/order-delivery?limit=25&page=4" + "example": "/order-address?limit=25&page=4" }, "prev": { - "example": "/order-delivery?limit=25&page=2" + "example": "/order-address?limit=25&page=2" } } } @@ -34304,7 +34304,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34319,11 +34319,11 @@ }, "post": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "Create a new Order Delivery resources.", + "summary": "Create a new Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderDelivery", + "operationId": "createOrderAddress", "parameters": [ { "name": "_response", @@ -34342,14 +34342,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34361,7 +34361,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34376,7 +34376,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34392,14 +34392,14 @@ } } }, - "/search/order-delivery": { + "/search/order-address": { "post": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "Search for the Order Delivery resources.", + "summary": "Search for the Order Address resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrderDelivery", + "operationId": "searchOrderAddress", "requestBody": { "required": true, "content": { @@ -34412,7 +34412,7 @@ }, "responses": { "200": { - "description": "List of OrderDelivery", + "description": "List of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34426,7 +34426,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34444,7 +34444,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34461,19 +34461,19 @@ } } }, - "/order-delivery/{id}": { + "/order-address/{id}": { "get": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "Detailed information about a Order Delivery resource.", + "summary": "Detailed information about a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDelivery", + "operationId": "getOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -34483,7 +34483,7 @@ ], "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34495,7 +34495,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34510,7 +34510,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34527,16 +34527,16 @@ }, "delete": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "Delete a Order Delivery resource.", + "summary": "Delete a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDelivery", + "operationId": "deleteOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -34567,16 +34567,16 @@ }, "patch": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "Partially update information about a Order Delivery resource.", + "summary": "Partially update information about a Order Address resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDelivery", + "operationId": "updateOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery", + "description": "Identifier for the order_address", "required": true, "schema": { "type": "string", @@ -34594,18 +34594,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Delivery resource.", + "description": "Partially update information about a Order Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } }, "responses": { "200": { - "description": "Detail of OrderDelivery", + "description": "Detail of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34617,7 +34617,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34632,7 +34632,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34651,14 +34651,14 @@ } } }, - "/aggregate/order-delivery": { + "/aggregate/order-address": { "post": { "tags": [ - "Order Delivery" + "Order Address" ], - "summary": "Aggregate for the Order Delivery resources.", + "summary": "Aggregate for the Order Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderDelivery", + "operationId": "aggregateOrderAddress", "requestBody": { "required": true, "content": { @@ -34682,7 +34682,7 @@ }, "responses": { "200": { - "description": "List of OrderDelivery", + "description": "List of OrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34696,7 +34696,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34714,7 +34714,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderAddress" } } } @@ -34731,14 +34731,14 @@ } } }, - "/order-delivery-position": { + "/order-customer": { "get": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "List with basic information of Order Delivery Position resources.", + "summary": "List with basic information of Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPositionList", + "operationId": "getOrderCustomerList", "parameters": [ { "name": "limit", @@ -34767,7 +34767,7 @@ ], "responses": { "200": { - "description": "List of Order Delivery Position resources.", + "description": "List of Order Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34786,7 +34786,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } ] @@ -34800,16 +34800,16 @@ "type": "object", "properties": { "first": { - "example": "/order-delivery-position?limit=25" + "example": "/order-customer?limit=25" }, "last": { - "example": "/order-delivery-position?limit=25&page=11" + "example": "/order-customer?limit=25&page=11" }, "next": { - "example": "/order-delivery-position?limit=25&page=4" + "example": "/order-customer?limit=25&page=4" }, "prev": { - "example": "/order-delivery-position?limit=25&page=2" + "example": "/order-customer?limit=25&page=2" } } } @@ -34830,7 +34830,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -34845,11 +34845,11 @@ }, "post": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "Create a new Order Delivery Position resources.", + "summary": "Create a new Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderDeliveryPosition", + "operationId": "createOrderCustomer", "parameters": [ { "name": "_response", @@ -34868,14 +34868,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34887,7 +34887,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -34902,7 +34902,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -34918,14 +34918,14 @@ } } }, - "/search/order-delivery-position": { + "/search/order-customer": { "post": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "Search for the Order Delivery Position resources.", + "summary": "Search for the Order Customer resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrderDeliveryPosition", + "operationId": "searchOrderCustomer", "requestBody": { "required": true, "content": { @@ -34938,7 +34938,7 @@ }, "responses": { "200": { - "description": "List of OrderDeliveryPosition", + "description": "List of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34952,7 +34952,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -34970,7 +34970,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -34987,19 +34987,19 @@ } } }, - "/order-delivery-position/{id}": { + "/order-customer/{id}": { "get": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "Detailed information about a Order Delivery Position resource.", + "summary": "Detailed information about a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderDeliveryPosition", + "operationId": "getOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -35009,7 +35009,7 @@ ], "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -35021,7 +35021,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -35036,7 +35036,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -35053,16 +35053,16 @@ }, "delete": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "Delete a Order Delivery Position resource.", + "summary": "Delete a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderDeliveryPosition", + "operationId": "deleteOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -35093,16 +35093,16 @@ }, "patch": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "Partially update information about a Order Delivery Position resource.", + "summary": "Partially update information about a Order Customer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderDeliveryPosition", + "operationId": "updateOrderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_delivery_position", + "description": "Identifier for the order_customer", "required": true, "schema": { "type": "string", @@ -35120,18 +35120,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Delivery Position resource.", + "description": "Partially update information about a Order Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } }, "responses": { "200": { - "description": "Detail of OrderDeliveryPosition", + "description": "Detail of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -35143,7 +35143,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -35158,7 +35158,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -35177,14 +35177,14 @@ } } }, - "/aggregate/order-delivery-position": { + "/aggregate/order-customer": { "post": { "tags": [ - "Order Delivery Position" + "Order Customer" ], - "summary": "Aggregate for the Order Delivery Position resources.", + "summary": "Aggregate for the Order Customer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderDeliveryPosition", + "operationId": "aggregateOrderCustomer", "requestBody": { "required": true, "content": { @@ -35208,7 +35208,7 @@ }, "responses": { "200": { - "description": "List of OrderDeliveryPosition", + "description": "List of OrderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -35222,7 +35222,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -35240,7 +35240,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderCustomer" } } } @@ -35257,14 +35257,14 @@ } } }, - "/order-line-item": { + "/order-delivery": { "get": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "List with basic information of Order Line Item resources.", + "summary": "List with basic information of Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItemList", + "operationId": "getOrderDeliveryList", "parameters": [ { "name": "limit", @@ -35293,7 +35293,7 @@ ], "responses": { "200": { - "description": "List of Order Line Item resources.", + "description": "List of Order Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35312,7 +35312,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } ] @@ -35326,16 +35326,16 @@ "type": "object", "properties": { "first": { - "example": "/order-line-item?limit=25" + "example": "/order-delivery?limit=25" }, "last": { - "example": "/order-line-item?limit=25&page=11" + "example": "/order-delivery?limit=25&page=11" }, "next": { - "example": "/order-line-item?limit=25&page=4" + "example": "/order-delivery?limit=25&page=4" }, "prev": { - "example": "/order-line-item?limit=25&page=2" + "example": "/order-delivery?limit=25&page=2" } } } @@ -35356,7 +35356,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35371,11 +35371,11 @@ }, "post": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "Create a new Order Line Item resources.", + "summary": "Create a new Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderLineItem", + "operationId": "createOrderDelivery", "parameters": [ { "name": "_response", @@ -35394,14 +35394,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -35413,7 +35413,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35428,7 +35428,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35444,14 +35444,14 @@ } } }, - "/search/order-line-item": { + "/search/order-delivery": { "post": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "Search for the Order Line Item resources.", + "summary": "Search for the Order Delivery resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrderLineItem", + "operationId": "searchOrderDelivery", "requestBody": { "required": true, "content": { @@ -35464,7 +35464,7 @@ }, "responses": { "200": { - "description": "List of OrderLineItem", + "description": "List of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -35478,7 +35478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35496,7 +35496,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35513,19 +35513,19 @@ } } }, - "/order-line-item/{id}": { + "/order-delivery/{id}": { "get": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "Detailed information about a Order Line Item resource.", + "summary": "Detailed information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderLineItem", + "operationId": "getOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -35535,7 +35535,7 @@ ], "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -35547,7 +35547,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35562,7 +35562,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35579,16 +35579,16 @@ }, "delete": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "Delete a Order Line Item resource.", + "summary": "Delete a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderLineItem", + "operationId": "deleteOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -35619,16 +35619,16 @@ }, "patch": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "Partially update information about a Order Line Item resource.", + "summary": "Partially update information about a Order Delivery resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderLineItem", + "operationId": "updateOrderDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item", + "description": "Identifier for the order_delivery", "required": true, "schema": { "type": "string", @@ -35646,18 +35646,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Line Item resource.", + "description": "Partially update information about a Order Delivery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItem", + "description": "Detail of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -35669,7 +35669,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35684,7 +35684,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35703,14 +35703,14 @@ } } }, - "/aggregate/order-line-item": { + "/aggregate/order-delivery": { "post": { "tags": [ - "Order Line Item" + "Order Delivery" ], - "summary": "Aggregate for the Order Line Item resources.", + "summary": "Aggregate for the Order Delivery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderLineItem", + "operationId": "aggregateOrderDelivery", "requestBody": { "required": true, "content": { @@ -35734,7 +35734,7 @@ }, "responses": { "200": { - "description": "List of OrderLineItem", + "description": "List of OrderDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -35748,7 +35748,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35766,7 +35766,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/OrderDelivery" } } } @@ -35783,14 +35783,14 @@ } } }, - "/order-line-item-download": { + "/order-delivery-position": { "get": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "List with basic information of Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownloadList", + "summary": "List with basic information of Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderDeliveryPositionList", "parameters": [ { "name": "limit", @@ -35819,7 +35819,7 @@ ], "responses": { "200": { - "description": "List of Order Line Item Download resources.", + "description": "List of Order Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35838,7 +35838,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } ] @@ -35852,16 +35852,16 @@ "type": "object", "properties": { "first": { - "example": "/order-line-item-download?limit=25" + "example": "/order-delivery-position?limit=25" }, "last": { - "example": "/order-line-item-download?limit=25&page=11" + "example": "/order-delivery-position?limit=25&page=11" }, "next": { - "example": "/order-line-item-download?limit=25&page=4" + "example": "/order-delivery-position?limit=25&page=4" }, "prev": { - "example": "/order-line-item-download?limit=25&page=2" + "example": "/order-delivery-position?limit=25&page=2" } } } @@ -35882,7 +35882,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -35897,11 +35897,11 @@ }, "post": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "Create a new Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createOrderLineItemDownload", + "summary": "Create a new Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderDeliveryPosition", "parameters": [ { "name": "_response", @@ -35920,14 +35920,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -35939,7 +35939,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -35954,7 +35954,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -35970,14 +35970,14 @@ } } }, - "/search/order-line-item-download": { + "/search/order-delivery-position": { "post": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "Search for the Order Line Item Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "searchOrderLineItemDownload", + "summary": "Search for the Order Delivery Position resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderDeliveryPosition", "requestBody": { "required": true, "content": { @@ -35990,7 +35990,7 @@ }, "responses": { "200": { - "description": "List of OrderLineItemDownload", + "description": "List of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -36004,7 +36004,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36022,7 +36022,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36039,19 +36039,19 @@ } } }, - "/order-line-item-download/{id}": { + "/order-delivery-position/{id}": { "get": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "Detailed information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getOrderLineItemDownload", + "summary": "Detailed information about a Order Delivery Position resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -36061,7 +36061,7 @@ ], "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -36073,7 +36073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36088,7 +36088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36105,16 +36105,16 @@ }, "delete": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "Delete a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteOrderLineItemDownload", + "summary": "Delete a Order Delivery Position resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -36145,16 +36145,16 @@ }, "patch": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "Partially update information about a Order Line Item Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateOrderLineItemDownload", + "summary": "Partially update information about a Order Delivery Position resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_line_item_download", + "description": "Identifier for the order_delivery_position", "required": true, "schema": { "type": "string", @@ -36172,18 +36172,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Line Item Download resource.", + "description": "Partially update information about a Order Delivery Position resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of OrderLineItemDownload", + "description": "Detail of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -36195,7 +36195,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36210,7 +36210,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36229,14 +36229,14 @@ } } }, - "/aggregate/order-line-item-download": { + "/aggregate/order-delivery-position": { "post": { "tags": [ - "Order Line Item Download" + "Order Delivery Position" ], - "summary": "Aggregate for the Order Line Item Download resources.", + "summary": "Aggregate for the Order Delivery Position resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderLineItemDownload", + "operationId": "aggregateOrderDeliveryPosition", "requestBody": { "required": true, "content": { @@ -36260,7 +36260,7 @@ }, "responses": { "200": { - "description": "List of OrderLineItemDownload", + "description": "List of OrderDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -36274,7 +36274,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36292,7 +36292,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderDeliveryPosition" } } } @@ -36309,14 +36309,14 @@ } } }, - "/order-transaction": { + "/order-line-item": { "get": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "List with basic information of Order Transaction resources.", + "summary": "List with basic information of Order Line Item resources.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransactionList", + "operationId": "getOrderLineItemList", "parameters": [ { "name": "limit", @@ -36345,7 +36345,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction resources.", + "description": "List of Order Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36364,7 +36364,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } ] @@ -36378,16 +36378,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction?limit=25" + "example": "/order-line-item?limit=25" }, "last": { - "example": "/order-transaction?limit=25&page=11" + "example": "/order-line-item?limit=25&page=11" }, "next": { - "example": "/order-transaction?limit=25&page=4" + "example": "/order-line-item?limit=25&page=4" }, "prev": { - "example": "/order-transaction?limit=25&page=2" + "example": "/order-line-item?limit=25&page=2" } } } @@ -36408,7 +36408,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36423,11 +36423,11 @@ }, "post": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "Create a new Order Transaction resources.", + "summary": "Create a new Order Line Item resources.", "description": "Available since: 6.0.0.0", - "operationId": "createOrderTransaction", + "operationId": "createOrderLineItem", "parameters": [ { "name": "_response", @@ -36446,14 +36446,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -36465,7 +36465,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36480,7 +36480,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36496,14 +36496,14 @@ } } }, - "/search/order-transaction": { + "/search/order-line-item": { "post": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "Search for the Order Transaction resources.", + "summary": "Search for the Order Line Item resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchOrderTransaction", + "operationId": "searchOrderLineItem", "requestBody": { "required": true, "content": { @@ -36516,7 +36516,7 @@ }, "responses": { "200": { - "description": "List of OrderTransaction", + "description": "List of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -36530,7 +36530,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36548,7 +36548,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36565,19 +36565,19 @@ } } }, - "/order-transaction/{id}": { + "/order-line-item/{id}": { "get": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "Detailed information about a Order Transaction resource.", + "summary": "Detailed information about a Order Line Item resource.", "description": "Available since: 6.0.0.0", - "operationId": "getOrderTransaction", + "operationId": "getOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -36587,7 +36587,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -36599,7 +36599,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36614,7 +36614,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36631,16 +36631,16 @@ }, "delete": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "Delete a Order Transaction resource.", + "summary": "Delete a Order Line Item resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteOrderTransaction", + "operationId": "deleteOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -36671,16 +36671,16 @@ }, "patch": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "Partially update information about a Order Transaction resource.", + "summary": "Partially update information about a Order Line Item resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateOrderTransaction", + "operationId": "updateOrderLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction", + "description": "Identifier for the order_line_item", "required": true, "schema": { "type": "string", @@ -36698,18 +36698,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction resource.", + "description": "Partially update information about a Order Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderTransaction", + "description": "Detail of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -36721,7 +36721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36736,7 +36736,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36755,14 +36755,14 @@ } } }, - "/aggregate/order-transaction": { + "/aggregate/order-line-item": { "post": { "tags": [ - "Order Transaction" + "Order Line Item" ], - "summary": "Aggregate for the Order Transaction resources.", + "summary": "Aggregate for the Order Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransaction", + "operationId": "aggregateOrderLineItem", "requestBody": { "required": true, "content": { @@ -36786,7 +36786,7 @@ }, "responses": { "200": { - "description": "List of OrderTransaction", + "description": "List of OrderLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -36800,7 +36800,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36818,7 +36818,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderLineItem" } } } @@ -36835,14 +36835,14 @@ } } }, - "/order-transaction-capture": { + "/order-line-item-download": { "get": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "List with basic information of Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureList", + "summary": "List with basic information of Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownloadList", "parameters": [ { "name": "limit", @@ -36871,7 +36871,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture resources.", + "description": "List of Order Line Item Download resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36890,7 +36890,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } ] @@ -36904,16 +36904,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture?limit=25" + "example": "/order-line-item-download?limit=25" }, "last": { - "example": "/order-transaction-capture?limit=25&page=11" + "example": "/order-line-item-download?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture?limit=25&page=4" + "example": "/order-line-item-download?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture?limit=25&page=2" + "example": "/order-line-item-download?limit=25&page=2" } } } @@ -36934,7 +36934,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -36949,11 +36949,11 @@ }, "post": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "Create a new Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCapture", + "summary": "Create a new Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createOrderLineItemDownload", "parameters": [ { "name": "_response", @@ -36972,14 +36972,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -36991,7 +36991,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37006,7 +37006,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37022,14 +37022,14 @@ } } }, - "/search/order-transaction-capture": { + "/search/order-line-item-download": { "post": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "Search for the Order Transaction Capture resources.", - "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCapture", + "summary": "Search for the Order Line Item Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "searchOrderLineItemDownload", "requestBody": { "required": true, "content": { @@ -37042,7 +37042,7 @@ }, "responses": { "200": { - "description": "List of OrderTransactionCapture", + "description": "List of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -37056,7 +37056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37074,7 +37074,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37091,19 +37091,19 @@ } } }, - "/order-transaction-capture/{id}": { + "/order-line-item-download/{id}": { "get": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "Detailed information about a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCapture", + "summary": "Detailed information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -37113,7 +37113,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -37125,7 +37125,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37140,7 +37140,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37157,16 +37157,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "Delete a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCapture", + "summary": "Delete a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -37197,16 +37197,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "Partially update information about a Order Transaction Capture resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCapture", + "summary": "Partially update information about a Order Line Item Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateOrderLineItemDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture", + "description": "Identifier for the order_line_item_download", "required": true, "schema": { "type": "string", @@ -37224,18 +37224,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture resource.", + "description": "Partially update information about a Order Line Item Download resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCapture", + "description": "Detail of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -37247,7 +37247,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37262,7 +37262,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37281,14 +37281,14 @@ } } }, - "/aggregate/order-transaction-capture": { + "/aggregate/order-line-item-download": { "post": { "tags": [ - "Order Transaction Capture" + "Order Line Item Download" ], - "summary": "Aggregate for the Order Transaction Capture resources.", + "summary": "Aggregate for the Order Line Item Download resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCapture", + "operationId": "aggregateOrderLineItemDownload", "requestBody": { "required": true, "content": { @@ -37312,7 +37312,7 @@ }, "responses": { "200": { - "description": "List of OrderTransactionCapture", + "description": "List of OrderLineItemDownload", "content": { "application/vnd.api+json": { "schema": { @@ -37326,7 +37326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37344,7 +37344,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItemDownload" } } } @@ -37361,14 +37361,14 @@ } } }, - "/order-transaction-capture-refund": { + "/order-transaction": { "get": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "List with basic information of Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundList", + "summary": "List with basic information of Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransactionList", "parameters": [ { "name": "limit", @@ -37397,7 +37397,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture Refund resources.", + "description": "List of Order Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37416,7 +37416,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } ] @@ -37430,16 +37430,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture-refund?limit=25" + "example": "/order-transaction?limit=25" }, "last": { - "example": "/order-transaction-capture-refund?limit=25&page=11" + "example": "/order-transaction?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture-refund?limit=25&page=4" + "example": "/order-transaction?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture-refund?limit=25&page=2" + "example": "/order-transaction?limit=25&page=2" } } } @@ -37460,7 +37460,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37475,11 +37475,11 @@ }, "post": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "Create a new Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefund", + "summary": "Create a new Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createOrderTransaction", "parameters": [ { "name": "_response", @@ -37498,14 +37498,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -37517,7 +37517,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37532,7 +37532,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37548,14 +37548,14 @@ } } }, - "/search/order-transaction-capture-refund": { + "/search/order-transaction": { "post": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "Search for the Order Transaction Capture Refund resources.", - "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCaptureRefund", + "summary": "Search for the Order Transaction resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchOrderTransaction", "requestBody": { "required": true, "content": { @@ -37568,7 +37568,7 @@ }, "responses": { "200": { - "description": "List of OrderTransactionCaptureRefund", + "description": "List of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -37582,7 +37582,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37600,7 +37600,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37617,19 +37617,19 @@ } } }, - "/order-transaction-capture-refund/{id}": { + "/order-transaction/{id}": { "get": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "Detailed information about a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefund", + "summary": "Detailed information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -37639,7 +37639,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -37651,7 +37651,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37666,7 +37666,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37683,16 +37683,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "Delete a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefund", + "summary": "Delete a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -37723,16 +37723,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "Partially update information about a Order Transaction Capture Refund resource.", - "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefund", + "summary": "Partially update information about a Order Transaction resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateOrderTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund", + "description": "Identifier for the order_transaction", "required": true, "schema": { "type": "string", @@ -37750,18 +37750,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture Refund resource.", + "description": "Partially update information about a Order Transaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefund", + "description": "Detail of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -37773,7 +37773,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37788,7 +37788,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37807,14 +37807,14 @@ } } }, - "/aggregate/order-transaction-capture-refund": { + "/aggregate/order-transaction": { "post": { "tags": [ - "Order Transaction Capture Refund" + "Order Transaction" ], - "summary": "Aggregate for the Order Transaction Capture Refund resources.", + "summary": "Aggregate for the Order Transaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCaptureRefund", + "operationId": "aggregateOrderTransaction", "requestBody": { "required": true, "content": { @@ -37838,7 +37838,7 @@ }, "responses": { "200": { - "description": "List of OrderTransactionCaptureRefund", + "description": "List of OrderTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -37852,7 +37852,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37870,7 +37870,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "$ref": "#/components/schemas/OrderTransaction" } } } @@ -37887,14 +37887,14 @@ } } }, - "/order-transaction-capture-refund-position": { + "/order-transaction-capture": { "get": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "List with basic information of Order Transaction Capture Refund Position resources.", + "summary": "List with basic information of Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPositionList", + "operationId": "getOrderTransactionCaptureList", "parameters": [ { "name": "limit", @@ -37923,7 +37923,7 @@ ], "responses": { "200": { - "description": "List of Order Transaction Capture Refund Position resources.", + "description": "List of Order Transaction Capture resources.", "content": { "application/vnd.api+json": { "schema": { @@ -37942,7 +37942,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } ] @@ -37956,16 +37956,16 @@ "type": "object", "properties": { "first": { - "example": "/order-transaction-capture-refund-position?limit=25" + "example": "/order-transaction-capture?limit=25" }, "last": { - "example": "/order-transaction-capture-refund-position?limit=25&page=11" + "example": "/order-transaction-capture?limit=25&page=11" }, "next": { - "example": "/order-transaction-capture-refund-position?limit=25&page=4" + "example": "/order-transaction-capture?limit=25&page=4" }, "prev": { - "example": "/order-transaction-capture-refund-position?limit=25&page=2" + "example": "/order-transaction-capture?limit=25&page=2" } } } @@ -37986,7 +37986,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38001,11 +38001,11 @@ }, "post": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "Create a new Order Transaction Capture Refund Position resources.", + "summary": "Create a new Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", - "operationId": "createOrderTransactionCaptureRefundPosition", + "operationId": "createOrderTransactionCapture", "parameters": [ { "name": "_response", @@ -38024,14 +38024,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -38043,7 +38043,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38058,7 +38058,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38074,14 +38074,14 @@ } } }, - "/search/order-transaction-capture-refund-position": { + "/search/order-transaction-capture": { "post": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "Search for the Order Transaction Capture Refund Position resources.", + "summary": "Search for the Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", - "operationId": "searchOrderTransactionCaptureRefundPosition", + "operationId": "searchOrderTransactionCapture", "requestBody": { "required": true, "content": { @@ -38094,7 +38094,7 @@ }, "responses": { "200": { - "description": "List of OrderTransactionCaptureRefundPosition", + "description": "List of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -38108,7 +38108,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38126,7 +38126,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38143,19 +38143,19 @@ } } }, - "/order-transaction-capture-refund-position/{id}": { + "/order-transaction-capture/{id}": { "get": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", + "summary": "Detailed information about a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", - "operationId": "getOrderTransactionCaptureRefundPosition", + "operationId": "getOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -38165,7 +38165,7 @@ ], "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -38177,7 +38177,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38192,7 +38192,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38209,16 +38209,16 @@ }, "delete": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "Delete a Order Transaction Capture Refund Position resource.", + "summary": "Delete a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", - "operationId": "deleteOrderTransactionCaptureRefundPosition", + "operationId": "deleteOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -38249,16 +38249,16 @@ }, "patch": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", + "summary": "Partially update information about a Order Transaction Capture resource.", "description": "Available since: 6.4.12.0", - "operationId": "updateOrderTransactionCaptureRefundPosition", + "operationId": "updateOrderTransactionCapture", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_transaction_capture_refund_position", + "description": "Identifier for the order_transaction_capture", "required": true, "schema": { "type": "string", @@ -38276,18 +38276,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Transaction Capture Refund Position resource.", + "description": "Partially update information about a Order Transaction Capture resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } }, "responses": { "200": { - "description": "Detail of OrderTransactionCaptureRefundPosition", + "description": "Detail of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -38299,7 +38299,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38314,7 +38314,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38333,14 +38333,14 @@ } } }, - "/aggregate/order-transaction-capture-refund-position": { + "/aggregate/order-transaction-capture": { "post": { "tags": [ - "Order Transaction Capture Refund Position" + "Order Transaction Capture" ], - "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", + "summary": "Aggregate for the Order Transaction Capture resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCaptureRefundPosition", + "operationId": "aggregateOrderTransactionCapture", "requestBody": { "required": true, "content": { @@ -38364,7 +38364,7 @@ }, "responses": { "200": { - "description": "List of OrderTransactionCaptureRefundPosition", + "description": "List of OrderTransactionCapture", "content": { "application/vnd.api+json": { "schema": { @@ -38378,7 +38378,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38396,7 +38396,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderTransactionCapture" } } } @@ -38413,14 +38413,14 @@ } } }, - "/payment-method": { + "/order-transaction-capture-refund": { "get": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "List with basic information of Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethodList", + "summary": "List with basic information of Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundList", "parameters": [ { "name": "limit", @@ -38449,7 +38449,7 @@ ], "responses": { "200": { - "description": "List of Payment Method resources.", + "description": "List of Order Transaction Capture Refund resources.", "content": { "application/vnd.api+json": { "schema": { @@ -38468,7 +38468,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } ] @@ -38482,16 +38482,16 @@ "type": "object", "properties": { "first": { - "example": "/payment-method?limit=25" + "example": "/order-transaction-capture-refund?limit=25" }, "last": { - "example": "/payment-method?limit=25&page=11" + "example": "/order-transaction-capture-refund?limit=25&page=11" }, "next": { - "example": "/payment-method?limit=25&page=4" + "example": "/order-transaction-capture-refund?limit=25&page=4" }, "prev": { - "example": "/payment-method?limit=25&page=2" + "example": "/order-transaction-capture-refund?limit=25&page=2" } } } @@ -38512,7 +38512,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38527,11 +38527,11 @@ }, "post": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "Create a new Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPaymentMethod", + "summary": "Create a new Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCaptureRefund", "parameters": [ { "name": "_response", @@ -38550,14 +38550,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -38569,7 +38569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38584,7 +38584,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38600,14 +38600,14 @@ } } }, - "/search/payment-method": { + "/search/order-transaction-capture-refund": { "post": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "Search for the Payment Method resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPaymentMethod", + "summary": "Search for the Order Transaction Capture Refund resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefund", "requestBody": { "required": true, "content": { @@ -38620,7 +38620,7 @@ }, "responses": { "200": { - "description": "List of PaymentMethod", + "description": "List of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -38634,7 +38634,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38652,7 +38652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38669,19 +38669,19 @@ } } }, - "/payment-method/{id}": { + "/order-transaction-capture-refund/{id}": { "get": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "Detailed information about a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPaymentMethod", + "summary": "Detailed information about a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -38691,7 +38691,7 @@ ], "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -38703,7 +38703,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38718,7 +38718,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38735,16 +38735,16 @@ }, "delete": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "Delete a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePaymentMethod", + "summary": "Delete a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -38775,16 +38775,16 @@ }, "patch": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "Partially update information about a Payment Method resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePaymentMethod", + "summary": "Partially update information about a Order Transaction Capture Refund resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCaptureRefund", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the payment_method", + "description": "Identifier for the order_transaction_capture_refund", "required": true, "schema": { "type": "string", @@ -38802,18 +38802,18 @@ } ], "requestBody": { - "description": "Partially update information about a Payment Method resource.", + "description": "Partially update information about a Order Transaction Capture Refund resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } }, "responses": { "200": { - "description": "Detail of PaymentMethod", + "description": "Detail of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -38825,7 +38825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38840,7 +38840,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38859,14 +38859,14 @@ } } }, - "/aggregate/payment-method": { + "/aggregate/order-transaction-capture-refund": { "post": { "tags": [ - "Payment Method" + "Order Transaction Capture Refund" ], - "summary": "Aggregate for the Payment Method resources.", + "summary": "Aggregate for the Order Transaction Capture Refund resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePaymentMethod", + "operationId": "aggregateOrderTransactionCaptureRefund", "requestBody": { "required": true, "content": { @@ -38890,7 +38890,7 @@ }, "responses": { "200": { - "description": "List of PaymentMethod", + "description": "List of OrderTransactionCaptureRefund", "content": { "application/vnd.api+json": { "schema": { @@ -38904,7 +38904,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38922,7 +38922,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderTransactionCaptureRefund" } } } @@ -38939,14 +38939,14 @@ } } }, - "/plugin": { + "/order-transaction-capture-refund-position": { "get": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "List with basic information of Plugin resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getPluginList", + "summary": "List with basic information of Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundPositionList", "parameters": [ { "name": "limit", @@ -38975,7 +38975,7 @@ ], "responses": { "200": { - "description": "List of Plugin resources.", + "description": "List of Order Transaction Capture Refund Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -38994,7 +38994,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } ] @@ -39008,16 +39008,16 @@ "type": "object", "properties": { "first": { - "example": "/plugin?limit=25" + "example": "/order-transaction-capture-refund-position?limit=25" }, "last": { - "example": "/plugin?limit=25&page=11" + "example": "/order-transaction-capture-refund-position?limit=25&page=11" }, "next": { - "example": "/plugin?limit=25&page=4" + "example": "/order-transaction-capture-refund-position?limit=25&page=4" }, "prev": { - "example": "/plugin?limit=25&page=2" + "example": "/order-transaction-capture-refund-position?limit=25&page=2" } } } @@ -39038,7 +39038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39053,11 +39053,11 @@ }, "post": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "Create a new Plugin resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createPlugin", + "summary": "Create a new Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "createOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "_response", @@ -39076,14 +39076,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -39095,7 +39095,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39110,7 +39110,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39126,14 +39126,14 @@ } } }, - "/search/plugin": { + "/search/order-transaction-capture-refund-position": { "post": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "Search for the Plugin resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchPlugin", + "summary": "Search for the Order Transaction Capture Refund Position resources.", + "description": "Available since: 6.4.12.0", + "operationId": "searchOrderTransactionCaptureRefundPosition", "requestBody": { "required": true, "content": { @@ -39146,7 +39146,7 @@ }, "responses": { "200": { - "description": "List of Plugin", + "description": "List of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -39160,7 +39160,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39178,7 +39178,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39195,19 +39195,19 @@ } } }, - "/plugin/{id}": { + "/order-transaction-capture-refund-position/{id}": { "get": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "Detailed information about a Plugin resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getPlugin", + "summary": "Detailed information about a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "getOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -39217,7 +39217,7 @@ ], "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -39229,7 +39229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39244,7 +39244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39261,16 +39261,16 @@ }, "delete": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "Delete a Plugin resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deletePlugin", + "summary": "Delete a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "deleteOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -39301,16 +39301,16 @@ }, "patch": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "Partially update information about a Plugin resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updatePlugin", + "summary": "Partially update information about a Order Transaction Capture Refund Position resource.", + "description": "Available since: 6.4.12.0", + "operationId": "updateOrderTransactionCaptureRefundPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the plugin", + "description": "Identifier for the order_transaction_capture_refund_position", "required": true, "schema": { "type": "string", @@ -39328,18 +39328,18 @@ } ], "requestBody": { - "description": "Partially update information about a Plugin resource.", + "description": "Partially update information about a Order Transaction Capture Refund Position resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } }, "responses": { "200": { - "description": "Detail of Plugin", + "description": "Detail of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -39351,7 +39351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39366,7 +39366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39385,14 +39385,14 @@ } } }, - "/aggregate/plugin": { + "/aggregate/order-transaction-capture-refund-position": { "post": { "tags": [ - "Plugin" + "Order Transaction Capture Refund Position" ], - "summary": "Aggregate for the Plugin resources.", + "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePlugin", + "operationId": "aggregateOrderTransactionCaptureRefundPosition", "requestBody": { "required": true, "content": { @@ -39416,7 +39416,7 @@ }, "responses": { "200": { - "description": "List of Plugin", + "description": "List of OrderTransactionCaptureRefundPosition", "content": { "application/vnd.api+json": { "schema": { @@ -39430,7 +39430,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39448,7 +39448,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Plugin" + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" } } } @@ -39465,14 +39465,14 @@ } } }, - "/product": { + "/payment-method": { "get": { "tags": [ - "Product" + "Payment Method" ], - "summary": "List with basic information of Product resources.", + "summary": "List with basic information of Payment Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductList", + "operationId": "getPaymentMethodList", "parameters": [ { "name": "limit", @@ -39501,7 +39501,7 @@ ], "responses": { "200": { - "description": "List of Product resources.", + "description": "List of Payment Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -39520,7 +39520,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } ] @@ -39534,16 +39534,16 @@ "type": "object", "properties": { "first": { - "example": "/product?limit=25" + "example": "/payment-method?limit=25" }, "last": { - "example": "/product?limit=25&page=11" + "example": "/payment-method?limit=25&page=11" }, "next": { - "example": "/product?limit=25&page=4" + "example": "/payment-method?limit=25&page=4" }, "prev": { - "example": "/product?limit=25&page=2" + "example": "/payment-method?limit=25&page=2" } } } @@ -39564,7 +39564,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39579,11 +39579,11 @@ }, "post": { "tags": [ - "Product" + "Payment Method" ], - "summary": "Create a new Product resources.", + "summary": "Create a new Payment Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProduct", + "operationId": "createPaymentMethod", "parameters": [ { "name": "_response", @@ -39602,14 +39602,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -39621,7 +39621,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39636,7 +39636,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39652,14 +39652,14 @@ } } }, - "/search/product": { + "/search/payment-method": { "post": { "tags": [ - "Product" + "Payment Method" ], - "summary": "Search for the Product resources.", + "summary": "Search for the Payment Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProduct", + "operationId": "searchPaymentMethod", "requestBody": { "required": true, "content": { @@ -39672,7 +39672,7 @@ }, "responses": { "200": { - "description": "List of Product", + "description": "List of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -39686,7 +39686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39704,7 +39704,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39721,19 +39721,19 @@ } } }, - "/product/{id}": { + "/payment-method/{id}": { "get": { "tags": [ - "Product" + "Payment Method" ], - "summary": "Detailed information about a Product resource.", + "summary": "Detailed information about a Payment Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProduct", + "operationId": "getPaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -39743,7 +39743,7 @@ ], "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -39755,7 +39755,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39770,7 +39770,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39787,16 +39787,16 @@ }, "delete": { "tags": [ - "Product" + "Payment Method" ], - "summary": "Delete a Product resource.", + "summary": "Delete a Payment Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProduct", + "operationId": "deletePaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -39827,16 +39827,16 @@ }, "patch": { "tags": [ - "Product" + "Payment Method" ], - "summary": "Partially update information about a Product resource.", + "summary": "Partially update information about a Payment Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProduct", + "operationId": "updatePaymentMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product", + "description": "Identifier for the payment_method", "required": true, "schema": { "type": "string", @@ -39854,18 +39854,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product resource.", + "description": "Partially update information about a Payment Method resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } }, "responses": { "200": { - "description": "Detail of Product", + "description": "Detail of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -39877,7 +39877,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39892,7 +39892,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39911,14 +39911,14 @@ } } }, - "/aggregate/product": { + "/aggregate/payment-method": { "post": { "tags": [ - "Product" + "Payment Method" ], - "summary": "Aggregate for the Product resources.", + "summary": "Aggregate for the Payment Method resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProduct", + "operationId": "aggregatePaymentMethod", "requestBody": { "required": true, "content": { @@ -39942,7 +39942,7 @@ }, "responses": { "200": { - "description": "List of Product", + "description": "List of PaymentMethod", "content": { "application/vnd.api+json": { "schema": { @@ -39956,7 +39956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39974,7 +39974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PaymentMethod" } } } @@ -39991,14 +39991,14 @@ } } }, - "/product-configurator-setting": { + "/plugin": { "get": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "List with basic information of Product Configurator Setting resources.", + "summary": "List with basic information of Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSettingList", + "operationId": "getPluginList", "parameters": [ { "name": "limit", @@ -40027,7 +40027,7 @@ ], "responses": { "200": { - "description": "List of Product Configurator Setting resources.", + "description": "List of Plugin resources.", "content": { "application/vnd.api+json": { "schema": { @@ -40046,7 +40046,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } ] @@ -40060,16 +40060,16 @@ "type": "object", "properties": { "first": { - "example": "/product-configurator-setting?limit=25" + "example": "/plugin?limit=25" }, "last": { - "example": "/product-configurator-setting?limit=25&page=11" + "example": "/plugin?limit=25&page=11" }, "next": { - "example": "/product-configurator-setting?limit=25&page=4" + "example": "/plugin?limit=25&page=4" }, "prev": { - "example": "/product-configurator-setting?limit=25&page=2" + "example": "/plugin?limit=25&page=2" } } } @@ -40090,7 +40090,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40105,11 +40105,11 @@ }, "post": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "Create a new Product Configurator Setting resources.", + "summary": "Create a new Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductConfiguratorSetting", + "operationId": "createPlugin", "parameters": [ { "name": "_response", @@ -40128,14 +40128,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -40147,7 +40147,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40162,7 +40162,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40178,14 +40178,14 @@ } } }, - "/search/product-configurator-setting": { + "/search/plugin": { "post": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "Search for the Product Configurator Setting resources.", + "summary": "Search for the Plugin resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProductConfiguratorSetting", + "operationId": "searchPlugin", "requestBody": { "required": true, "content": { @@ -40198,7 +40198,7 @@ }, "responses": { "200": { - "description": "List of ProductConfiguratorSetting", + "description": "List of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -40212,7 +40212,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40230,7 +40230,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40247,19 +40247,19 @@ } } }, - "/product-configurator-setting/{id}": { + "/plugin/{id}": { "get": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "Detailed information about a Product Configurator Setting resource.", + "summary": "Detailed information about a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductConfiguratorSetting", + "operationId": "getPlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -40269,7 +40269,7 @@ ], "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -40281,7 +40281,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40296,7 +40296,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40313,16 +40313,16 @@ }, "delete": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "Delete a Product Configurator Setting resource.", + "summary": "Delete a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductConfiguratorSetting", + "operationId": "deletePlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -40353,16 +40353,16 @@ }, "patch": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "Partially update information about a Product Configurator Setting resource.", + "summary": "Partially update information about a Plugin resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductConfiguratorSetting", + "operationId": "updatePlugin", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_configurator_setting", + "description": "Identifier for the plugin", "required": true, "schema": { "type": "string", @@ -40380,18 +40380,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Configurator Setting resource.", + "description": "Partially update information about a Plugin resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } }, "responses": { "200": { - "description": "Detail of ProductConfiguratorSetting", + "description": "Detail of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -40403,7 +40403,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40418,7 +40418,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40437,14 +40437,14 @@ } } }, - "/aggregate/product-configurator-setting": { + "/aggregate/plugin": { "post": { "tags": [ - "Product Configurator Setting" + "Plugin" ], - "summary": "Aggregate for the Product Configurator Setting resources.", + "summary": "Aggregate for the Plugin resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductConfiguratorSetting", + "operationId": "aggregatePlugin", "requestBody": { "required": true, "content": { @@ -40468,7 +40468,7 @@ }, "responses": { "200": { - "description": "List of ProductConfiguratorSetting", + "description": "List of Plugin", "content": { "application/vnd.api+json": { "schema": { @@ -40482,7 +40482,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40500,7 +40500,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/Plugin" } } } @@ -40517,14 +40517,14 @@ } } }, - "/product-cross-selling": { + "/product": { "get": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "List with basic information of Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSellingList", + "summary": "List with basic information of Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductList", "parameters": [ { "name": "limit", @@ -40553,7 +40553,7 @@ ], "responses": { "200": { - "description": "List of Product Cross Selling resources.", + "description": "List of Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -40572,7 +40572,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } ] @@ -40586,16 +40586,16 @@ "type": "object", "properties": { "first": { - "example": "/product-cross-selling?limit=25" + "example": "/product?limit=25" }, "last": { - "example": "/product-cross-selling?limit=25&page=11" + "example": "/product?limit=25&page=11" }, "next": { - "example": "/product-cross-selling?limit=25&page=4" + "example": "/product?limit=25&page=4" }, "prev": { - "example": "/product-cross-selling?limit=25&page=2" + "example": "/product?limit=25&page=2" } } } @@ -40616,7 +40616,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40631,11 +40631,11 @@ }, "post": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "Create a new Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductCrossSelling", + "summary": "Create a new Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProduct", "parameters": [ { "name": "_response", @@ -40654,14 +40654,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -40673,7 +40673,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40688,7 +40688,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40704,14 +40704,14 @@ } } }, - "/search/product-cross-selling": { + "/search/product": { "post": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "Search for the Product Cross Selling resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchProductCrossSelling", + "summary": "Search for the Product resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProduct", "requestBody": { "required": true, "content": { @@ -40724,7 +40724,7 @@ }, "responses": { "200": { - "description": "List of ProductCrossSelling", + "description": "List of Product", "content": { "application/vnd.api+json": { "schema": { @@ -40738,7 +40738,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40756,7 +40756,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40773,19 +40773,19 @@ } } }, - "/product-cross-selling/{id}": { + "/product/{id}": { "get": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "Detailed information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductCrossSelling", + "summary": "Detailed information about a Product resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -40795,7 +40795,7 @@ ], "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -40807,7 +40807,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40822,7 +40822,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40839,16 +40839,16 @@ }, "delete": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "Delete a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductCrossSelling", + "summary": "Delete a Product resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -40879,16 +40879,16 @@ }, "patch": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "Partially update information about a Product Cross Selling resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductCrossSelling", + "summary": "Partially update information about a Product resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling", + "description": "Identifier for the product", "required": true, "schema": { "type": "string", @@ -40906,18 +40906,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Cross Selling resource.", + "description": "Partially update information about a Product resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSelling", + "description": "Detail of Product", "content": { "application/vnd.api+json": { "schema": { @@ -40929,7 +40929,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40944,7 +40944,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -40963,14 +40963,14 @@ } } }, - "/aggregate/product-cross-selling": { + "/aggregate/product": { "post": { "tags": [ - "Product Cross Selling" + "Product" ], - "summary": "Aggregate for the Product Cross Selling resources.", + "summary": "Aggregate for the Product resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductCrossSelling", + "operationId": "aggregateProduct", "requestBody": { "required": true, "content": { @@ -40994,7 +40994,7 @@ }, "responses": { "200": { - "description": "List of ProductCrossSelling", + "description": "List of Product", "content": { "application/vnd.api+json": { "schema": { @@ -41008,7 +41008,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -41026,7 +41026,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + "$ref": "#/components/schemas/Product" } } } @@ -41043,14 +41043,14 @@ } } }, - "/product-cross-selling-assigned-products": { + "/product-configurator-setting": { "get": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "List with basic information of Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProductsList", + "summary": "List with basic information of Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductConfiguratorSettingList", "parameters": [ { "name": "limit", @@ -41079,7 +41079,7 @@ ], "responses": { "200": { - "description": "List of Product Cross Selling Assigned Products resources.", + "description": "List of Product Configurator Setting resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41098,7 +41098,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } ] @@ -41112,16 +41112,16 @@ "type": "object", "properties": { "first": { - "example": "/product-cross-selling-assigned-products?limit=25" + "example": "/product-configurator-setting?limit=25" }, "last": { - "example": "/product-cross-selling-assigned-products?limit=25&page=11" + "example": "/product-configurator-setting?limit=25&page=11" }, "next": { - "example": "/product-cross-selling-assigned-products?limit=25&page=4" + "example": "/product-configurator-setting?limit=25&page=4" }, "prev": { - "example": "/product-cross-selling-assigned-products?limit=25&page=2" + "example": "/product-configurator-setting?limit=25&page=2" } } } @@ -41142,7 +41142,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41157,11 +41157,11 @@ }, "post": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "Create a new Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createProductCrossSellingAssignedProducts", + "summary": "Create a new Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductConfiguratorSetting", "parameters": [ { "name": "_response", @@ -41180,14 +41180,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -41199,7 +41199,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41214,7 +41214,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41230,14 +41230,14 @@ } } }, - "/search/product-cross-selling-assigned-products": { + "/search/product-configurator-setting": { "post": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "Search for the Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.2.0.0", - "operationId": "searchProductCrossSellingAssignedProducts", + "summary": "Search for the Product Configurator Setting resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductConfiguratorSetting", "requestBody": { "required": true, "content": { @@ -41250,7 +41250,7 @@ }, "responses": { "200": { - "description": "List of ProductCrossSellingAssignedProducts", + "description": "List of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -41264,7 +41264,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41282,7 +41282,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41299,19 +41299,19 @@ } } }, - "/product-cross-selling-assigned-products/{id}": { + "/product-configurator-setting/{id}": { "get": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getProductCrossSellingAssignedProducts", + "summary": "Detailed information about a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -41321,7 +41321,7 @@ ], "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -41333,7 +41333,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41348,7 +41348,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41365,16 +41365,16 @@ }, "delete": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "Delete a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteProductCrossSellingAssignedProducts", + "summary": "Delete a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -41405,16 +41405,16 @@ }, "patch": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateProductCrossSellingAssignedProducts", + "summary": "Partially update information about a Product Configurator Setting resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductConfiguratorSetting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_cross_selling_assigned_products", + "description": "Identifier for the product_configurator_setting", "required": true, "schema": { "type": "string", @@ -41432,18 +41432,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Partially update information about a Product Configurator Setting resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } }, "responses": { "200": { - "description": "Detail of ProductCrossSellingAssignedProducts", + "description": "Detail of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -41455,7 +41455,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41470,7 +41470,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41489,14 +41489,14 @@ } } }, - "/aggregate/product-cross-selling-assigned-products": { + "/aggregate/product-configurator-setting": { "post": { "tags": [ - "Product Cross Selling Assigned Products" + "Product Configurator Setting" ], - "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", + "summary": "Aggregate for the Product Configurator Setting resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductCrossSellingAssignedProducts", + "operationId": "aggregateProductConfiguratorSetting", "requestBody": { "required": true, "content": { @@ -41520,7 +41520,7 @@ }, "responses": { "200": { - "description": "List of ProductCrossSellingAssignedProducts", + "description": "List of ProductConfiguratorSetting", "content": { "application/vnd.api+json": { "schema": { @@ -41534,7 +41534,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41552,7 +41552,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + "$ref": "#/components/schemas/ProductConfiguratorSetting" } } } @@ -41569,14 +41569,14 @@ } } }, - "/product-download": { + "/product-cross-selling": { "get": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "List with basic information of Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownloadList", + "summary": "List with basic information of Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSellingList", "parameters": [ { "name": "limit", @@ -41605,7 +41605,7 @@ ], "responses": { "200": { - "description": "List of Product Download resources.", + "description": "List of Product Cross Selling resources.", "content": { "application/vnd.api+json": { "schema": { @@ -41624,7 +41624,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } ] @@ -41638,16 +41638,16 @@ "type": "object", "properties": { "first": { - "example": "/product-download?limit=25" + "example": "/product-cross-selling?limit=25" }, "last": { - "example": "/product-download?limit=25&page=11" + "example": "/product-cross-selling?limit=25&page=11" }, "next": { - "example": "/product-download?limit=25&page=4" + "example": "/product-cross-selling?limit=25&page=4" }, "prev": { - "example": "/product-download?limit=25&page=2" + "example": "/product-cross-selling?limit=25&page=2" } } } @@ -41668,7 +41668,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41683,11 +41683,11 @@ }, "post": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "Create a new Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "createProductDownload", + "summary": "Create a new Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductCrossSelling", "parameters": [ { "name": "_response", @@ -41706,14 +41706,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -41725,7 +41725,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41740,7 +41740,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41756,14 +41756,14 @@ } } }, - "/search/product-download": { + "/search/product-cross-selling": { "post": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "Search for the Product Download resources.", - "description": "Available since: 6.4.19.0", - "operationId": "searchProductDownload", + "summary": "Search for the Product Cross Selling resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchProductCrossSelling", "requestBody": { "required": true, "content": { @@ -41776,7 +41776,7 @@ }, "responses": { "200": { - "description": "List of ProductDownload", + "description": "List of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -41790,7 +41790,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41808,7 +41808,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41825,19 +41825,19 @@ } } }, - "/product-download/{id}": { + "/product-cross-selling/{id}": { "get": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "Detailed information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "getProductDownload", + "summary": "Detailed information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -41847,7 +41847,7 @@ ], "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -41859,7 +41859,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41874,7 +41874,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41891,16 +41891,16 @@ }, "delete": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "Delete a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "deleteProductDownload", + "summary": "Delete a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -41931,16 +41931,16 @@ }, "patch": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "Partially update information about a Product Download resource.", - "description": "Available since: 6.4.19.0", - "operationId": "updateProductDownload", + "summary": "Partially update information about a Product Cross Selling resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductCrossSelling", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_download", + "description": "Identifier for the product_cross_selling", "required": true, "schema": { "type": "string", @@ -41958,18 +41958,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Download resource.", + "description": "Partially update information about a Product Cross Selling resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } }, "responses": { "200": { - "description": "Detail of ProductDownload", + "description": "Detail of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -41981,7 +41981,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -41996,7 +41996,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -42015,14 +42015,14 @@ } } }, - "/aggregate/product-download": { + "/aggregate/product-cross-selling": { "post": { "tags": [ - "Product Download" + "Product Cross Selling" ], - "summary": "Aggregate for the Product Download resources.", + "summary": "Aggregate for the Product Cross Selling resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductDownload", + "operationId": "aggregateProductCrossSelling", "requestBody": { "required": true, "content": { @@ -42046,7 +42046,7 @@ }, "responses": { "200": { - "description": "List of ProductDownload", + "description": "List of ProductCrossSelling", "content": { "application/vnd.api+json": { "schema": { @@ -42060,7 +42060,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -42078,7 +42078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductDownload" + "$ref": "#/components/schemas/ProductCrossSelling" } } } @@ -42095,14 +42095,14 @@ } } }, - "/product-export": { + "/product-cross-selling-assigned-products": { "get": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "List with basic information of Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExportList", + "summary": "List with basic information of Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProductsList", "parameters": [ { "name": "limit", @@ -42131,7 +42131,7 @@ ], "responses": { "200": { - "description": "List of Product Export resources.", + "description": "List of Product Cross Selling Assigned Products resources.", "content": { "application/vnd.api+json": { "schema": { @@ -42150,7 +42150,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } ] @@ -42164,16 +42164,16 @@ "type": "object", "properties": { "first": { - "example": "/product-export?limit=25" + "example": "/product-cross-selling-assigned-products?limit=25" }, "last": { - "example": "/product-export?limit=25&page=11" + "example": "/product-cross-selling-assigned-products?limit=25&page=11" }, "next": { - "example": "/product-export?limit=25&page=4" + "example": "/product-cross-selling-assigned-products?limit=25&page=4" }, "prev": { - "example": "/product-export?limit=25&page=2" + "example": "/product-cross-selling-assigned-products?limit=25&page=2" } } } @@ -42194,7 +42194,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42209,11 +42209,11 @@ }, "post": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "Create a new Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createProductExport", + "summary": "Create a new Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createProductCrossSellingAssignedProducts", "parameters": [ { "name": "_response", @@ -42232,14 +42232,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -42251,7 +42251,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42266,7 +42266,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42282,14 +42282,14 @@ } } }, - "/search/product-export": { + "/search/product-cross-selling-assigned-products": { "post": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "Search for the Product Export resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchProductExport", + "summary": "Search for the Product Cross Selling Assigned Products resources.", + "description": "Available since: 6.2.0.0", + "operationId": "searchProductCrossSellingAssignedProducts", "requestBody": { "required": true, "content": { @@ -42302,7 +42302,7 @@ }, "responses": { "200": { - "description": "List of ProductExport", + "description": "List of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -42316,7 +42316,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42334,7 +42334,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42351,19 +42351,19 @@ } } }, - "/product-export/{id}": { + "/product-cross-selling-assigned-products/{id}": { "get": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "Detailed information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getProductExport", + "summary": "Detailed information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -42373,7 +42373,7 @@ ], "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -42385,7 +42385,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42400,7 +42400,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42417,16 +42417,16 @@ }, "delete": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "Delete a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteProductExport", + "summary": "Delete a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -42457,16 +42457,16 @@ }, "patch": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "Partially update information about a Product Export resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateProductExport", + "summary": "Partially update information about a Product Cross Selling Assigned Products resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateProductCrossSellingAssignedProducts", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_export", + "description": "Identifier for the product_cross_selling_assigned_products", "required": true, "schema": { "type": "string", @@ -42484,18 +42484,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Export resource.", + "description": "Partially update information about a Product Cross Selling Assigned Products resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } }, "responses": { "200": { - "description": "Detail of ProductExport", + "description": "Detail of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -42507,7 +42507,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42522,7 +42522,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42541,14 +42541,14 @@ } } }, - "/aggregate/product-export": { + "/aggregate/product-cross-selling-assigned-products": { "post": { "tags": [ - "Product Export" + "Product Cross Selling Assigned Products" ], - "summary": "Aggregate for the Product Export resources.", + "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductExport", + "operationId": "aggregateProductCrossSellingAssignedProducts", "requestBody": { "required": true, "content": { @@ -42572,7 +42572,7 @@ }, "responses": { "200": { - "description": "List of ProductExport", + "description": "List of ProductCrossSellingAssignedProducts", "content": { "application/vnd.api+json": { "schema": { @@ -42586,7 +42586,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42604,7 +42604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" } } } @@ -42621,14 +42621,14 @@ } } }, - "/product-feature-set": { + "/product-download": { "get": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "List with basic information of Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSetList", + "summary": "List with basic information of Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownloadList", "parameters": [ { "name": "limit", @@ -42657,7 +42657,7 @@ ], "responses": { "200": { - "description": "List of Product Feature Set resources.", + "description": "List of Product Download resources.", "content": { "application/vnd.api+json": { "schema": { @@ -42676,7 +42676,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } ] @@ -42690,16 +42690,16 @@ "type": "object", "properties": { "first": { - "example": "/product-feature-set?limit=25" + "example": "/product-download?limit=25" }, "last": { - "example": "/product-feature-set?limit=25&page=11" + "example": "/product-download?limit=25&page=11" }, "next": { - "example": "/product-feature-set?limit=25&page=4" + "example": "/product-download?limit=25&page=4" }, "prev": { - "example": "/product-feature-set?limit=25&page=2" + "example": "/product-download?limit=25&page=2" } } } @@ -42720,7 +42720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42735,11 +42735,11 @@ }, "post": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "Create a new Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "createProductFeatureSet", + "summary": "Create a new Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "createProductDownload", "parameters": [ { "name": "_response", @@ -42758,14 +42758,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -42777,7 +42777,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42792,7 +42792,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42808,14 +42808,14 @@ } } }, - "/search/product-feature-set": { + "/search/product-download": { "post": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "Search for the Product Feature Set resources.", - "description": "Available since: 6.3.0.0", - "operationId": "searchProductFeatureSet", + "summary": "Search for the Product Download resources.", + "description": "Available since: 6.4.19.0", + "operationId": "searchProductDownload", "requestBody": { "required": true, "content": { @@ -42828,7 +42828,7 @@ }, "responses": { "200": { - "description": "List of ProductFeatureSet", + "description": "List of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -42842,7 +42842,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42860,7 +42860,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42877,19 +42877,19 @@ } } }, - "/product-feature-set/{id}": { + "/product-download/{id}": { "get": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "Detailed information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "getProductFeatureSet", + "summary": "Detailed information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "getProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -42899,7 +42899,7 @@ ], "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -42911,7 +42911,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42926,7 +42926,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -42943,16 +42943,16 @@ }, "delete": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "Delete a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "deleteProductFeatureSet", + "summary": "Delete a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "deleteProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -42983,16 +42983,16 @@ }, "patch": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "Partially update information about a Product Feature Set resource.", - "description": "Available since: 6.3.0.0", - "operationId": "updateProductFeatureSet", + "summary": "Partially update information about a Product Download resource.", + "description": "Available since: 6.4.19.0", + "operationId": "updateProductDownload", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_feature_set", + "description": "Identifier for the product_download", "required": true, "schema": { "type": "string", @@ -43010,18 +43010,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Feature Set resource.", + "description": "Partially update information about a Product Download resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } }, "responses": { "200": { - "description": "Detail of ProductFeatureSet", + "description": "Detail of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -43033,7 +43033,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -43048,7 +43048,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -43067,14 +43067,14 @@ } } }, - "/aggregate/product-feature-set": { + "/aggregate/product-download": { "post": { "tags": [ - "Product Feature Set" + "Product Download" ], - "summary": "Aggregate for the Product Feature Set resources.", + "summary": "Aggregate for the Product Download resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductFeatureSet", + "operationId": "aggregateProductDownload", "requestBody": { "required": true, "content": { @@ -43098,7 +43098,7 @@ }, "responses": { "200": { - "description": "List of ProductFeatureSet", + "description": "List of ProductDownload", "content": { "application/vnd.api+json": { "schema": { @@ -43112,7 +43112,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -43130,7 +43130,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "$ref": "#/components/schemas/ProductDownload" } } } @@ -43147,14 +43147,14 @@ } } }, - "/product-keyword-dictionary": { + "/product-export": { "get": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "List with basic information of Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionaryList", + "summary": "List with basic information of Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExportList", "parameters": [ { "name": "limit", @@ -43183,7 +43183,7 @@ ], "responses": { "200": { - "description": "List of Product Keyword Dictionary resources.", + "description": "List of Product Export resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43202,7 +43202,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } ] @@ -43216,16 +43216,16 @@ "type": "object", "properties": { "first": { - "example": "/product-keyword-dictionary?limit=25" + "example": "/product-export?limit=25" }, "last": { - "example": "/product-keyword-dictionary?limit=25&page=11" + "example": "/product-export?limit=25&page=11" }, "next": { - "example": "/product-keyword-dictionary?limit=25&page=4" + "example": "/product-export?limit=25&page=4" }, "prev": { - "example": "/product-keyword-dictionary?limit=25&page=2" + "example": "/product-export?limit=25&page=2" } } } @@ -43246,7 +43246,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43261,11 +43261,11 @@ }, "post": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "Create a new Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductKeywordDictionary", + "summary": "Create a new Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createProductExport", "parameters": [ { "name": "_response", @@ -43284,14 +43284,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -43303,7 +43303,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43318,7 +43318,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43334,14 +43334,14 @@ } } }, - "/search/product-keyword-dictionary": { + "/search/product-export": { "post": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "Search for the Product Keyword Dictionary resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductKeywordDictionary", + "summary": "Search for the Product Export resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchProductExport", "requestBody": { "required": true, "content": { @@ -43354,7 +43354,7 @@ }, "responses": { "200": { - "description": "List of ProductKeywordDictionary", + "description": "List of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -43368,7 +43368,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43386,7 +43386,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43403,19 +43403,19 @@ } } }, - "/product-keyword-dictionary/{id}": { + "/product-export/{id}": { "get": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "Detailed information about a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductKeywordDictionary", + "summary": "Detailed information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "getProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -43425,7 +43425,7 @@ ], "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -43437,7 +43437,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43452,7 +43452,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43469,16 +43469,16 @@ }, "delete": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "Delete a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductKeywordDictionary", + "summary": "Delete a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -43509,16 +43509,16 @@ }, "patch": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "Partially update information about a Product Keyword Dictionary resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductKeywordDictionary", + "summary": "Partially update information about a Product Export resource.", + "description": "Available since: 6.1.0.0", + "operationId": "updateProductExport", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_keyword_dictionary", + "description": "Identifier for the product_export", "required": true, "schema": { "type": "string", @@ -43536,18 +43536,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Keyword Dictionary resource.", + "description": "Partially update information about a Product Export resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } }, "responses": { "200": { - "description": "Detail of ProductKeywordDictionary", + "description": "Detail of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -43559,7 +43559,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43574,7 +43574,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43593,14 +43593,14 @@ } } }, - "/aggregate/product-keyword-dictionary": { + "/aggregate/product-export": { "post": { "tags": [ - "Product Keyword Dictionary" + "Product Export" ], - "summary": "Aggregate for the Product Keyword Dictionary resources.", + "summary": "Aggregate for the Product Export resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductKeywordDictionary", + "operationId": "aggregateProductExport", "requestBody": { "required": true, "content": { @@ -43624,7 +43624,7 @@ }, "responses": { "200": { - "description": "List of ProductKeywordDictionary", + "description": "List of ProductExport", "content": { "application/vnd.api+json": { "schema": { @@ -43638,7 +43638,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43656,7 +43656,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "$ref": "#/components/schemas/ProductExport" } } } @@ -43673,14 +43673,14 @@ } } }, - "/product-manufacturer": { + "/product-feature-set": { "get": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "List with basic information of Product Manufacturer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturerList", + "summary": "List with basic information of Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSetList", "parameters": [ { "name": "limit", @@ -43709,7 +43709,7 @@ ], "responses": { "200": { - "description": "List of Product Manufacturer resources.", + "description": "List of Product Feature Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -43728,7 +43728,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } ] @@ -43742,16 +43742,16 @@ "type": "object", "properties": { "first": { - "example": "/product-manufacturer?limit=25" + "example": "/product-feature-set?limit=25" }, "last": { - "example": "/product-manufacturer?limit=25&page=11" + "example": "/product-feature-set?limit=25&page=11" }, "next": { - "example": "/product-manufacturer?limit=25&page=4" + "example": "/product-feature-set?limit=25&page=4" }, "prev": { - "example": "/product-manufacturer?limit=25&page=2" + "example": "/product-feature-set?limit=25&page=2" } } } @@ -43772,7 +43772,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43787,11 +43787,11 @@ }, "post": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "Create a new Product Manufacturer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductManufacturer", + "summary": "Create a new Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "createProductFeatureSet", "parameters": [ { "name": "_response", @@ -43810,14 +43810,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -43829,7 +43829,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43844,7 +43844,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43860,14 +43860,14 @@ } } }, - "/search/product-manufacturer": { + "/search/product-feature-set": { "post": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "Search for the Product Manufacturer resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductManufacturer", + "summary": "Search for the Product Feature Set resources.", + "description": "Available since: 6.3.0.0", + "operationId": "searchProductFeatureSet", "requestBody": { "required": true, "content": { @@ -43880,7 +43880,7 @@ }, "responses": { "200": { - "description": "List of ProductManufacturer", + "description": "List of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -43894,7 +43894,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43912,7 +43912,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43929,19 +43929,19 @@ } } }, - "/product-manufacturer/{id}": { + "/product-feature-set/{id}": { "get": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "Detailed information about a Product Manufacturer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductManufacturer", + "summary": "Detailed information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "getProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -43951,7 +43951,7 @@ ], "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -43963,7 +43963,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43978,7 +43978,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -43995,16 +43995,16 @@ }, "delete": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "Delete a Product Manufacturer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductManufacturer", + "summary": "Delete a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "deleteProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -44035,16 +44035,16 @@ }, "patch": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "Partially update information about a Product Manufacturer resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductManufacturer", + "summary": "Partially update information about a Product Feature Set resource.", + "description": "Available since: 6.3.0.0", + "operationId": "updateProductFeatureSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_manufacturer", + "description": "Identifier for the product_feature_set", "required": true, "schema": { "type": "string", @@ -44062,18 +44062,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Manufacturer resource.", + "description": "Partially update information about a Product Feature Set resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } }, "responses": { "200": { - "description": "Detail of ProductManufacturer", + "description": "Detail of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -44085,7 +44085,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -44100,7 +44100,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -44119,14 +44119,14 @@ } } }, - "/aggregate/product-manufacturer": { + "/aggregate/product-feature-set": { "post": { "tags": [ - "Product Manufacturer" + "Product Feature Set" ], - "summary": "Aggregate for the Product Manufacturer resources.", + "summary": "Aggregate for the Product Feature Set resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductManufacturer", + "operationId": "aggregateProductFeatureSet", "requestBody": { "required": true, "content": { @@ -44150,7 +44150,7 @@ }, "responses": { "200": { - "description": "List of ProductManufacturer", + "description": "List of ProductFeatureSet", "content": { "application/vnd.api+json": { "schema": { @@ -44164,7 +44164,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -44182,7 +44182,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductFeatureSet" } } } @@ -44199,14 +44199,14 @@ } } }, - "/product-media": { + "/product-keyword-dictionary": { "get": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "List with basic information of Product Media resources.", + "summary": "List with basic information of Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductMediaList", + "operationId": "getProductKeywordDictionaryList", "parameters": [ { "name": "limit", @@ -44235,7 +44235,7 @@ ], "responses": { "200": { - "description": "List of Product Media resources.", + "description": "List of Product Keyword Dictionary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44254,7 +44254,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } ] @@ -44268,16 +44268,16 @@ "type": "object", "properties": { "first": { - "example": "/product-media?limit=25" + "example": "/product-keyword-dictionary?limit=25" }, "last": { - "example": "/product-media?limit=25&page=11" + "example": "/product-keyword-dictionary?limit=25&page=11" }, "next": { - "example": "/product-media?limit=25&page=4" + "example": "/product-keyword-dictionary?limit=25&page=4" }, "prev": { - "example": "/product-media?limit=25&page=2" + "example": "/product-keyword-dictionary?limit=25&page=2" } } } @@ -44298,7 +44298,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44313,11 +44313,11 @@ }, "post": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "Create a new Product Media resources.", + "summary": "Create a new Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductMedia", + "operationId": "createProductKeywordDictionary", "parameters": [ { "name": "_response", @@ -44336,14 +44336,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -44355,7 +44355,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44370,7 +44370,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44386,14 +44386,14 @@ } } }, - "/search/product-media": { + "/search/product-keyword-dictionary": { "post": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "Search for the Product Media resources.", + "summary": "Search for the Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProductMedia", + "operationId": "searchProductKeywordDictionary", "requestBody": { "required": true, "content": { @@ -44406,7 +44406,7 @@ }, "responses": { "200": { - "description": "List of ProductMedia", + "description": "List of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -44420,7 +44420,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44438,7 +44438,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44455,19 +44455,19 @@ } } }, - "/product-media/{id}": { + "/product-keyword-dictionary/{id}": { "get": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "Detailed information about a Product Media resource.", + "summary": "Detailed information about a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductMedia", + "operationId": "getProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -44477,7 +44477,7 @@ ], "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -44489,7 +44489,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44504,7 +44504,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44521,16 +44521,16 @@ }, "delete": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "Delete a Product Media resource.", + "summary": "Delete a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductMedia", + "operationId": "deleteProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -44561,16 +44561,16 @@ }, "patch": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "Partially update information about a Product Media resource.", + "summary": "Partially update information about a Product Keyword Dictionary resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductMedia", + "operationId": "updateProductKeywordDictionary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_media", + "description": "Identifier for the product_keyword_dictionary", "required": true, "schema": { "type": "string", @@ -44588,18 +44588,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Media resource.", + "description": "Partially update information about a Product Keyword Dictionary resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } }, "responses": { "200": { - "description": "Detail of ProductMedia", + "description": "Detail of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -44611,7 +44611,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44626,7 +44626,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44645,14 +44645,14 @@ } } }, - "/aggregate/product-media": { + "/aggregate/product-keyword-dictionary": { "post": { "tags": [ - "Product Media" + "Product Keyword Dictionary" ], - "summary": "Aggregate for the Product Media resources.", + "summary": "Aggregate for the Product Keyword Dictionary resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductMedia", + "operationId": "aggregateProductKeywordDictionary", "requestBody": { "required": true, "content": { @@ -44676,7 +44676,7 @@ }, "responses": { "200": { - "description": "List of ProductMedia", + "description": "List of ProductKeywordDictionary", "content": { "application/vnd.api+json": { "schema": { @@ -44690,7 +44690,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44708,7 +44708,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductKeywordDictionary" } } } @@ -44725,14 +44725,14 @@ } } }, - "/product-price": { + "/product-manufacturer": { "get": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "List with basic information of Product Price resources.", + "summary": "List with basic information of Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductPriceList", + "operationId": "getProductManufacturerList", "parameters": [ { "name": "limit", @@ -44761,7 +44761,7 @@ ], "responses": { "200": { - "description": "List of Product Price resources.", + "description": "List of Product Manufacturer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -44780,7 +44780,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } ] @@ -44794,16 +44794,16 @@ "type": "object", "properties": { "first": { - "example": "/product-price?limit=25" + "example": "/product-manufacturer?limit=25" }, "last": { - "example": "/product-price?limit=25&page=11" + "example": "/product-manufacturer?limit=25&page=11" }, "next": { - "example": "/product-price?limit=25&page=4" + "example": "/product-manufacturer?limit=25&page=4" }, "prev": { - "example": "/product-price?limit=25&page=2" + "example": "/product-manufacturer?limit=25&page=2" } } } @@ -44824,7 +44824,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -44839,11 +44839,11 @@ }, "post": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "Create a new Product Price resources.", + "summary": "Create a new Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductPrice", + "operationId": "createProductManufacturer", "parameters": [ { "name": "_response", @@ -44862,14 +44862,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -44881,7 +44881,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -44896,7 +44896,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -44912,14 +44912,14 @@ } } }, - "/search/product-price": { + "/search/product-manufacturer": { "post": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "Search for the Product Price resources.", + "summary": "Search for the Product Manufacturer resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProductPrice", + "operationId": "searchProductManufacturer", "requestBody": { "required": true, "content": { @@ -44932,7 +44932,7 @@ }, "responses": { "200": { - "description": "List of ProductPrice", + "description": "List of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -44946,7 +44946,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -44964,7 +44964,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -44981,19 +44981,19 @@ } } }, - "/product-price/{id}": { + "/product-manufacturer/{id}": { "get": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "Detailed information about a Product Price resource.", + "summary": "Detailed information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductPrice", + "operationId": "getProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -45003,7 +45003,7 @@ ], "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -45015,7 +45015,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -45030,7 +45030,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -45047,16 +45047,16 @@ }, "delete": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "Delete a Product Price resource.", + "summary": "Delete a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductPrice", + "operationId": "deleteProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -45087,16 +45087,16 @@ }, "patch": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "Partially update information about a Product Price resource.", + "summary": "Partially update information about a Product Manufacturer resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductPrice", + "operationId": "updateProductManufacturer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_price", + "description": "Identifier for the product_manufacturer", "required": true, "schema": { "type": "string", @@ -45114,18 +45114,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Price resource.", + "description": "Partially update information about a Product Manufacturer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } }, "responses": { "200": { - "description": "Detail of ProductPrice", + "description": "Detail of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -45137,7 +45137,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -45152,7 +45152,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -45171,14 +45171,14 @@ } } }, - "/aggregate/product-price": { + "/aggregate/product-manufacturer": { "post": { "tags": [ - "Product Price" + "Product Manufacturer" ], - "summary": "Aggregate for the Product Price resources.", + "summary": "Aggregate for the Product Manufacturer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductPrice", + "operationId": "aggregateProductManufacturer", "requestBody": { "required": true, "content": { @@ -45202,7 +45202,7 @@ }, "responses": { "200": { - "description": "List of ProductPrice", + "description": "List of ProductManufacturer", "content": { "application/vnd.api+json": { "schema": { @@ -45216,7 +45216,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -45234,7 +45234,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductPrice" + "$ref": "#/components/schemas/ProductManufacturer" } } } @@ -45251,14 +45251,14 @@ } } }, - "/product-review": { + "/product-media": { "get": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "List with basic information of Product Review resources.", + "summary": "List with basic information of Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductReviewList", + "operationId": "getProductMediaList", "parameters": [ { "name": "limit", @@ -45287,7 +45287,7 @@ ], "responses": { "200": { - "description": "List of Product Review resources.", + "description": "List of Product Media resources.", "content": { "application/vnd.api+json": { "schema": { @@ -45306,7 +45306,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } ] @@ -45320,16 +45320,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review?limit=25" + "example": "/product-media?limit=25" }, "last": { - "example": "/product-review?limit=25&page=11" + "example": "/product-media?limit=25&page=11" }, "next": { - "example": "/product-review?limit=25&page=4" + "example": "/product-media?limit=25&page=4" }, "prev": { - "example": "/product-review?limit=25&page=2" + "example": "/product-media?limit=25&page=2" } } } @@ -45350,7 +45350,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45365,11 +45365,11 @@ }, "post": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "Create a new Product Review resources.", + "summary": "Create a new Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductReview", + "operationId": "createProductMedia", "parameters": [ { "name": "_response", @@ -45388,14 +45388,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -45407,7 +45407,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45422,7 +45422,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45438,14 +45438,14 @@ } } }, - "/search/product-review": { + "/search/product-media": { "post": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "Search for the Product Review resources.", + "summary": "Search for the Product Media resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProductReview", + "operationId": "searchProductMedia", "requestBody": { "required": true, "content": { @@ -45458,7 +45458,7 @@ }, "responses": { "200": { - "description": "List of ProductReview", + "description": "List of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -45472,7 +45472,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45490,7 +45490,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45507,19 +45507,19 @@ } } }, - "/product-review/{id}": { + "/product-media/{id}": { "get": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "Detailed information about a Product Review resource.", + "summary": "Detailed information about a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductReview", + "operationId": "getProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -45529,7 +45529,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -45541,7 +45541,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45556,7 +45556,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45573,16 +45573,16 @@ }, "delete": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "Delete a Product Review resource.", + "summary": "Delete a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductReview", + "operationId": "deleteProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -45613,16 +45613,16 @@ }, "patch": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "Partially update information about a Product Review resource.", + "summary": "Partially update information about a Product Media resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductReview", + "operationId": "updateProductMedia", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review", + "description": "Identifier for the product_media", "required": true, "schema": { "type": "string", @@ -45640,18 +45640,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review resource.", + "description": "Partially update information about a Product Media resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } }, "responses": { "200": { - "description": "Detail of ProductReview", + "description": "Detail of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -45663,7 +45663,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45678,7 +45678,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45697,14 +45697,14 @@ } } }, - "/aggregate/product-review": { + "/aggregate/product-media": { "post": { "tags": [ - "Product Review" + "Product Media" ], - "summary": "Aggregate for the Product Review resources.", + "summary": "Aggregate for the Product Media resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReview", + "operationId": "aggregateProductMedia", "requestBody": { "required": true, "content": { @@ -45728,7 +45728,7 @@ }, "responses": { "200": { - "description": "List of ProductReview", + "description": "List of ProductMedia", "content": { "application/vnd.api+json": { "schema": { @@ -45742,7 +45742,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45760,7 +45760,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReview" + "$ref": "#/components/schemas/ProductMedia" } } } @@ -45777,14 +45777,14 @@ } } }, - "/product-search-config": { + "/product-price": { "get": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "List with basic information of Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigList", + "summary": "List with basic information of Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductPriceList", "parameters": [ { "name": "limit", @@ -45813,7 +45813,7 @@ ], "responses": { "200": { - "description": "List of Product Search Config resources.", + "description": "List of Product Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -45832,7 +45832,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } ] @@ -45846,16 +45846,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-config?limit=25" + "example": "/product-price?limit=25" }, "last": { - "example": "/product-search-config?limit=25&page=11" + "example": "/product-price?limit=25&page=11" }, "next": { - "example": "/product-search-config?limit=25&page=4" + "example": "/product-price?limit=25&page=4" }, "prev": { - "example": "/product-search-config?limit=25&page=2" + "example": "/product-price?limit=25&page=2" } } } @@ -45876,7 +45876,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -45891,11 +45891,11 @@ }, "post": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "Create a new Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfig", + "summary": "Create a new Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductPrice", "parameters": [ { "name": "_response", @@ -45914,14 +45914,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -45933,7 +45933,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -45948,7 +45948,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -45964,14 +45964,14 @@ } } }, - "/search/product-search-config": { + "/search/product-price": { "post": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "Search for the Product Search Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchProductSearchConfig", + "summary": "Search for the Product Price resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductPrice", "requestBody": { "required": true, "content": { @@ -45984,7 +45984,7 @@ }, "responses": { "200": { - "description": "List of ProductSearchConfig", + "description": "List of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -45998,7 +45998,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46016,7 +46016,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46033,19 +46033,19 @@ } } }, - "/product-search-config/{id}": { + "/product-price/{id}": { "get": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "Detailed information about a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfig", + "summary": "Detailed information about a Product Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -46055,7 +46055,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -46067,7 +46067,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46082,7 +46082,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46099,16 +46099,16 @@ }, "delete": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "Delete a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfig", + "summary": "Delete a Product Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -46139,16 +46139,16 @@ }, "patch": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "Partially update information about a Product Search Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfig", + "summary": "Partially update information about a Product Price resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config", + "description": "Identifier for the product_price", "required": true, "schema": { "type": "string", @@ -46166,18 +46166,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Config resource.", + "description": "Partially update information about a Product Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfig", + "description": "Detail of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -46189,7 +46189,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46204,7 +46204,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46223,14 +46223,14 @@ } } }, - "/aggregate/product-search-config": { + "/aggregate/product-price": { "post": { "tags": [ - "Product Search Config" + "Product Price" ], - "summary": "Aggregate for the Product Search Config resources.", + "summary": "Aggregate for the Product Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchConfig", + "operationId": "aggregateProductPrice", "requestBody": { "required": true, "content": { @@ -46254,7 +46254,7 @@ }, "responses": { "200": { - "description": "List of ProductSearchConfig", + "description": "List of ProductPrice", "content": { "application/vnd.api+json": { "schema": { @@ -46268,7 +46268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46286,7 +46286,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfig" + "$ref": "#/components/schemas/ProductPrice" } } } @@ -46303,14 +46303,14 @@ } } }, - "/product-search-config-field": { + "/product-review": { "get": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "List with basic information of Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigFieldList", + "summary": "List with basic information of Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductReviewList", "parameters": [ { "name": "limit", @@ -46339,7 +46339,7 @@ ], "responses": { "200": { - "description": "List of Product Search Config Field resources.", + "description": "List of Product Review resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46358,7 +46358,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } ] @@ -46372,16 +46372,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-config-field?limit=25" + "example": "/product-review?limit=25" }, "last": { - "example": "/product-search-config-field?limit=25&page=11" + "example": "/product-review?limit=25&page=11" }, "next": { - "example": "/product-search-config-field?limit=25&page=4" + "example": "/product-review?limit=25&page=4" }, "prev": { - "example": "/product-search-config-field?limit=25&page=2" + "example": "/product-review?limit=25&page=2" } } } @@ -46402,7 +46402,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46417,11 +46417,11 @@ }, "post": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "Create a new Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createProductSearchConfigField", + "summary": "Create a new Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createProductReview", "parameters": [ { "name": "_response", @@ -46440,14 +46440,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -46459,7 +46459,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46474,7 +46474,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46490,14 +46490,14 @@ } } }, - "/search/product-search-config-field": { + "/search/product-review": { "post": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "Search for the Product Search Config Field resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchProductSearchConfigField", + "summary": "Search for the Product Review resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchProductReview", "requestBody": { "required": true, "content": { @@ -46510,7 +46510,7 @@ }, "responses": { "200": { - "description": "List of ProductSearchConfigField", + "description": "List of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -46524,7 +46524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46542,7 +46542,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46559,19 +46559,19 @@ } } }, - "/product-search-config-field/{id}": { + "/product-review/{id}": { "get": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "Detailed information about a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getProductSearchConfigField", + "summary": "Detailed information about a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -46581,7 +46581,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -46593,7 +46593,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46608,7 +46608,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46625,16 +46625,16 @@ }, "delete": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "Delete a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteProductSearchConfigField", + "summary": "Delete a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -46665,16 +46665,16 @@ }, "patch": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "Partially update information about a Product Search Config Field resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateProductSearchConfigField", + "summary": "Partially update information about a Product Review resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateProductReview", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_config_field", + "description": "Identifier for the product_review", "required": true, "schema": { "type": "string", @@ -46692,18 +46692,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Config Field resource.", + "description": "Partially update information about a Product Review resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchConfigField", + "description": "Detail of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -46715,7 +46715,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46730,7 +46730,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46749,14 +46749,14 @@ } } }, - "/aggregate/product-search-config-field": { + "/aggregate/product-review": { "post": { "tags": [ - "Product Search Config Field" + "Product Review" ], - "summary": "Aggregate for the Product Search Config Field resources.", + "summary": "Aggregate for the Product Review resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchConfigField", + "operationId": "aggregateProductReview", "requestBody": { "required": true, "content": { @@ -46780,7 +46780,7 @@ }, "responses": { "200": { - "description": "List of ProductSearchConfigField", + "description": "List of ProductReview", "content": { "application/vnd.api+json": { "schema": { @@ -46794,7 +46794,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46812,7 +46812,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "$ref": "#/components/schemas/ProductReview" } } } @@ -46829,14 +46829,14 @@ } } }, - "/product-search-keyword": { + "/product-search-config": { "get": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "List with basic information of Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeywordList", + "summary": "List with basic information of Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigList", "parameters": [ { "name": "limit", @@ -46865,7 +46865,7 @@ ], "responses": { "200": { - "description": "List of Product Search Keyword resources.", + "description": "List of Product Search Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -46884,7 +46884,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } ] @@ -46898,16 +46898,16 @@ "type": "object", "properties": { "first": { - "example": "/product-search-keyword?limit=25" + "example": "/product-search-config?limit=25" }, "last": { - "example": "/product-search-keyword?limit=25&page=11" + "example": "/product-search-config?limit=25&page=11" }, "next": { - "example": "/product-search-keyword?limit=25&page=4" + "example": "/product-search-config?limit=25&page=4" }, "prev": { - "example": "/product-search-keyword?limit=25&page=2" + "example": "/product-search-config?limit=25&page=2" } } } @@ -46928,7 +46928,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -46943,11 +46943,11 @@ }, "post": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "Create a new Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductSearchKeyword", + "summary": "Create a new Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createProductSearchConfig", "parameters": [ { "name": "_response", @@ -46966,14 +46966,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -46985,7 +46985,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47000,7 +47000,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47016,14 +47016,14 @@ } } }, - "/search/product-search-keyword": { + "/search/product-search-config": { "post": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "Search for the Product Search Keyword resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductSearchKeyword", + "summary": "Search for the Product Search Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchProductSearchConfig", "requestBody": { "required": true, "content": { @@ -47036,7 +47036,7 @@ }, "responses": { "200": { - "description": "List of ProductSearchKeyword", + "description": "List of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47050,7 +47050,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47068,7 +47068,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47085,19 +47085,19 @@ } } }, - "/product-search-keyword/{id}": { + "/product-search-config/{id}": { "get": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "Detailed information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductSearchKeyword", + "summary": "Detailed information about a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -47107,7 +47107,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47119,7 +47119,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47134,7 +47134,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47151,16 +47151,16 @@ }, "delete": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "Delete a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductSearchKeyword", + "summary": "Delete a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -47191,16 +47191,16 @@ }, "patch": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "Partially update information about a Product Search Keyword resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductSearchKeyword", + "summary": "Partially update information about a Product Search Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateProductSearchConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_search_keyword", + "description": "Identifier for the product_search_config", "required": true, "schema": { "type": "string", @@ -47218,18 +47218,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Search Keyword resource.", + "description": "Partially update information about a Product Search Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } }, "responses": { "200": { - "description": "Detail of ProductSearchKeyword", + "description": "Detail of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47241,7 +47241,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47256,7 +47256,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47275,14 +47275,14 @@ } } }, - "/aggregate/product-search-keyword": { + "/aggregate/product-search-config": { "post": { "tags": [ - "Product Search Keyword" + "Product Search Config" ], - "summary": "Aggregate for the Product Search Keyword resources.", + "summary": "Aggregate for the Product Search Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchKeyword", + "operationId": "aggregateProductSearchConfig", "requestBody": { "required": true, "content": { @@ -47306,7 +47306,7 @@ }, "responses": { "200": { - "description": "List of ProductSearchKeyword", + "description": "List of ProductSearchConfig", "content": { "application/vnd.api+json": { "schema": { @@ -47320,7 +47320,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47338,7 +47338,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "$ref": "#/components/schemas/ProductSearchConfig" } } } @@ -47355,14 +47355,14 @@ } } }, - "/product-sorting": { + "/product-search-config-field": { "get": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "List with basic information of Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSortingList", + "summary": "List with basic information of Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigFieldList", "parameters": [ { "name": "limit", @@ -47391,7 +47391,7 @@ ], "responses": { "200": { - "description": "List of Product Sorting resources.", + "description": "List of Product Search Config Field resources.", "content": { "application/vnd.api+json": { "schema": { @@ -47410,7 +47410,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } ] @@ -47424,16 +47424,16 @@ "type": "object", "properties": { "first": { - "example": "/product-sorting?limit=25" + "example": "/product-search-config-field?limit=25" }, "last": { - "example": "/product-sorting?limit=25&page=11" + "example": "/product-search-config-field?limit=25&page=11" }, "next": { - "example": "/product-sorting?limit=25&page=4" + "example": "/product-search-config-field?limit=25&page=4" }, "prev": { - "example": "/product-sorting?limit=25&page=2" + "example": "/product-search-config-field?limit=25&page=2" } } } @@ -47454,7 +47454,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47469,11 +47469,11 @@ }, "post": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "Create a new Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "createProductSorting", + "summary": "Create a new Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createProductSearchConfigField", "parameters": [ { "name": "_response", @@ -47492,14 +47492,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -47511,7 +47511,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47526,7 +47526,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47542,14 +47542,14 @@ } } }, - "/search/product-sorting": { + "/search/product-search-config-field": { "post": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "Search for the Product Sorting resources.", - "description": "Available since: 6.3.2.0", - "operationId": "searchProductSorting", + "summary": "Search for the Product Search Config Field resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchProductSearchConfigField", "requestBody": { "required": true, "content": { @@ -47562,7 +47562,7 @@ }, "responses": { "200": { - "description": "List of ProductSorting", + "description": "List of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -47576,7 +47576,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47594,7 +47594,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47611,19 +47611,19 @@ } } }, - "/product-sorting/{id}": { + "/product-search-config-field/{id}": { "get": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "Detailed information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "getProductSorting", + "summary": "Detailed information about a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "getProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -47633,7 +47633,7 @@ ], "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -47645,7 +47645,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47660,7 +47660,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47677,16 +47677,16 @@ }, "delete": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "Delete a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "deleteProductSorting", + "summary": "Delete a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -47717,16 +47717,16 @@ }, "patch": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "Partially update information about a Product Sorting resource.", - "description": "Available since: 6.3.2.0", - "operationId": "updateProductSorting", + "summary": "Partially update information about a Product Search Config Field resource.", + "description": "Available since: 6.3.5.0", + "operationId": "updateProductSearchConfigField", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_sorting", + "description": "Identifier for the product_search_config_field", "required": true, "schema": { "type": "string", @@ -47744,18 +47744,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Sorting resource.", + "description": "Partially update information about a Product Search Config Field resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } }, "responses": { "200": { - "description": "Detail of ProductSorting", + "description": "Detail of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -47767,7 +47767,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47782,7 +47782,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47801,14 +47801,14 @@ } } }, - "/aggregate/product-sorting": { + "/aggregate/product-search-config-field": { "post": { "tags": [ - "Product Sorting" + "Product Search Config Field" ], - "summary": "Aggregate for the Product Sorting resources.", + "summary": "Aggregate for the Product Search Config Field resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSorting", + "operationId": "aggregateProductSearchConfigField", "requestBody": { "required": true, "content": { @@ -47832,7 +47832,7 @@ }, "responses": { "200": { - "description": "List of ProductSorting", + "description": "List of ProductSearchConfigField", "content": { "application/vnd.api+json": { "schema": { @@ -47846,7 +47846,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47864,7 +47864,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductSorting" + "$ref": "#/components/schemas/ProductSearchConfigField" } } } @@ -47881,14 +47881,14 @@ } } }, - "/product-stream": { + "/product-search-keyword": { "get": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "List with basic information of Product Stream resources.", + "summary": "List with basic information of Product Search Keyword resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamList", + "operationId": "getProductSearchKeywordList", "parameters": [ { "name": "limit", @@ -47917,7 +47917,7 @@ ], "responses": { "200": { - "description": "List of Product Stream resources.", + "description": "List of Product Search Keyword resources.", "content": { "application/vnd.api+json": { "schema": { @@ -47936,7 +47936,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } ] @@ -47950,16 +47950,16 @@ "type": "object", "properties": { "first": { - "example": "/product-stream?limit=25" + "example": "/product-search-keyword?limit=25" }, "last": { - "example": "/product-stream?limit=25&page=11" + "example": "/product-search-keyword?limit=25&page=11" }, "next": { - "example": "/product-stream?limit=25&page=4" + "example": "/product-search-keyword?limit=25&page=4" }, "prev": { - "example": "/product-stream?limit=25&page=2" + "example": "/product-search-keyword?limit=25&page=2" } } } @@ -47980,7 +47980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -47995,11 +47995,11 @@ }, "post": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "Create a new Product Stream resources.", + "summary": "Create a new Product Search Keyword resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductStream", + "operationId": "createProductSearchKeyword", "parameters": [ { "name": "_response", @@ -48018,14 +48018,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -48037,7 +48037,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48052,7 +48052,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48068,14 +48068,14 @@ } } }, - "/search/product-stream": { + "/search/product-search-keyword": { "post": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "Search for the Product Stream resources.", + "summary": "Search for the Product Search Keyword resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProductStream", + "operationId": "searchProductSearchKeyword", "requestBody": { "required": true, "content": { @@ -48088,7 +48088,7 @@ }, "responses": { "200": { - "description": "List of ProductStream", + "description": "List of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -48102,7 +48102,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48120,7 +48120,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48137,19 +48137,19 @@ } } }, - "/product-stream/{id}": { + "/product-search-keyword/{id}": { "get": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "Detailed information about a Product Stream resource.", + "summary": "Detailed information about a Product Search Keyword resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductStream", + "operationId": "getProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -48159,7 +48159,7 @@ ], "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -48171,7 +48171,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48186,7 +48186,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48203,16 +48203,16 @@ }, "delete": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "Delete a Product Stream resource.", + "summary": "Delete a Product Search Keyword resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStream", + "operationId": "deleteProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -48243,16 +48243,16 @@ }, "patch": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "Partially update information about a Product Stream resource.", + "summary": "Partially update information about a Product Search Keyword resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductStream", + "operationId": "updateProductSearchKeyword", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream", + "description": "Identifier for the product_search_keyword", "required": true, "schema": { "type": "string", @@ -48270,18 +48270,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Stream resource.", + "description": "Partially update information about a Product Search Keyword resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } }, "responses": { "200": { - "description": "Detail of ProductStream", + "description": "Detail of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -48293,7 +48293,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48308,7 +48308,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48327,14 +48327,14 @@ } } }, - "/aggregate/product-stream": { + "/aggregate/product-search-keyword": { "post": { "tags": [ - "Product Stream" + "Product Search Keyword" ], - "summary": "Aggregate for the Product Stream resources.", + "summary": "Aggregate for the Product Search Keyword resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductStream", + "operationId": "aggregateProductSearchKeyword", "requestBody": { "required": true, "content": { @@ -48358,7 +48358,7 @@ }, "responses": { "200": { - "description": "List of ProductStream", + "description": "List of ProductSearchKeyword", "content": { "application/vnd.api+json": { "schema": { @@ -48372,7 +48372,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48390,7 +48390,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStream" + "$ref": "#/components/schemas/ProductSearchKeyword" } } } @@ -48407,14 +48407,14 @@ } } }, - "/product-stream-filter": { + "/product-sorting": { "get": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "List with basic information of Product Stream Filter resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilterList", + "summary": "List with basic information of Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSortingList", "parameters": [ { "name": "limit", @@ -48443,7 +48443,7 @@ ], "responses": { "200": { - "description": "List of Product Stream Filter resources.", + "description": "List of Product Sorting resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48462,7 +48462,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } ] @@ -48476,16 +48476,16 @@ "type": "object", "properties": { "first": { - "example": "/product-stream-filter?limit=25" + "example": "/product-sorting?limit=25" }, "last": { - "example": "/product-stream-filter?limit=25&page=11" + "example": "/product-sorting?limit=25&page=11" }, "next": { - "example": "/product-stream-filter?limit=25&page=4" + "example": "/product-sorting?limit=25&page=4" }, "prev": { - "example": "/product-stream-filter?limit=25&page=2" + "example": "/product-sorting?limit=25&page=2" } } } @@ -48506,7 +48506,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48521,11 +48521,11 @@ }, "post": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "Create a new Product Stream Filter resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createProductStreamFilter", + "summary": "Create a new Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "createProductSorting", "parameters": [ { "name": "_response", @@ -48544,14 +48544,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -48563,7 +48563,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48578,7 +48578,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48594,14 +48594,14 @@ } } }, - "/search/product-stream-filter": { + "/search/product-sorting": { "post": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "Search for the Product Stream Filter resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchProductStreamFilter", + "summary": "Search for the Product Sorting resources.", + "description": "Available since: 6.3.2.0", + "operationId": "searchProductSorting", "requestBody": { "required": true, "content": { @@ -48614,7 +48614,7 @@ }, "responses": { "200": { - "description": "List of ProductStreamFilter", + "description": "List of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -48628,7 +48628,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48646,7 +48646,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48663,19 +48663,19 @@ } } }, - "/product-stream-filter/{id}": { + "/product-sorting/{id}": { "get": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "Detailed information about a Product Stream Filter resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getProductStreamFilter", + "summary": "Detailed information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "getProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -48685,7 +48685,7 @@ ], "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -48697,7 +48697,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48712,7 +48712,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48729,16 +48729,16 @@ }, "delete": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "Delete a Product Stream Filter resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteProductStreamFilter", + "summary": "Delete a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "deleteProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -48769,16 +48769,16 @@ }, "patch": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "Partially update information about a Product Stream Filter resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateProductStreamFilter", + "summary": "Partially update information about a Product Sorting resource.", + "description": "Available since: 6.3.2.0", + "operationId": "updateProductSorting", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_stream_filter", + "description": "Identifier for the product_sorting", "required": true, "schema": { "type": "string", @@ -48796,18 +48796,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Stream Filter resource.", + "description": "Partially update information about a Product Sorting resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } }, "responses": { "200": { - "description": "Detail of ProductStreamFilter", + "description": "Detail of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -48819,7 +48819,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48834,7 +48834,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48853,14 +48853,14 @@ } } }, - "/aggregate/product-stream-filter": { + "/aggregate/product-sorting": { "post": { "tags": [ - "Product Stream Filter" + "Product Sorting" ], - "summary": "Aggregate for the Product Stream Filter resources.", + "summary": "Aggregate for the Product Sorting resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductStreamFilter", + "operationId": "aggregateProductSorting", "requestBody": { "required": true, "content": { @@ -48884,7 +48884,7 @@ }, "responses": { "200": { - "description": "List of ProductStreamFilter", + "description": "List of ProductSorting", "content": { "application/vnd.api+json": { "schema": { @@ -48898,7 +48898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48916,7 +48916,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductSorting" } } } @@ -48933,14 +48933,14 @@ } } }, - "/product-visibility": { + "/product-stream": { "get": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "List with basic information of Product Visibility resources.", + "summary": "List with basic information of Product Stream resources.", "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibilityList", + "operationId": "getProductStreamList", "parameters": [ { "name": "limit", @@ -48969,7 +48969,7 @@ ], "responses": { "200": { - "description": "List of Product Visibility resources.", + "description": "List of Product Stream resources.", "content": { "application/vnd.api+json": { "schema": { @@ -48988,7 +48988,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } ] @@ -49002,16 +49002,16 @@ "type": "object", "properties": { "first": { - "example": "/product-visibility?limit=25" + "example": "/product-stream?limit=25" }, "last": { - "example": "/product-visibility?limit=25&page=11" + "example": "/product-stream?limit=25&page=11" }, "next": { - "example": "/product-visibility?limit=25&page=4" + "example": "/product-stream?limit=25&page=4" }, "prev": { - "example": "/product-visibility?limit=25&page=2" + "example": "/product-stream?limit=25&page=2" } } } @@ -49032,7 +49032,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49047,11 +49047,11 @@ }, "post": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "Create a new Product Visibility resources.", + "summary": "Create a new Product Stream resources.", "description": "Available since: 6.0.0.0", - "operationId": "createProductVisibility", + "operationId": "createProductStream", "parameters": [ { "name": "_response", @@ -49070,14 +49070,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -49089,7 +49089,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49104,7 +49104,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49120,14 +49120,14 @@ } } }, - "/search/product-visibility": { + "/search/product-stream": { "post": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "Search for the Product Visibility resources.", + "summary": "Search for the Product Stream resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchProductVisibility", + "operationId": "searchProductStream", "requestBody": { "required": true, "content": { @@ -49140,7 +49140,7 @@ }, "responses": { "200": { - "description": "List of ProductVisibility", + "description": "List of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -49154,7 +49154,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49172,7 +49172,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49189,19 +49189,19 @@ } } }, - "/product-visibility/{id}": { + "/product-stream/{id}": { "get": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "Detailed information about a Product Visibility resource.", + "summary": "Detailed information about a Product Stream resource.", "description": "Available since: 6.0.0.0", - "operationId": "getProductVisibility", + "operationId": "getProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -49211,7 +49211,7 @@ ], "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -49223,7 +49223,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49238,7 +49238,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49255,16 +49255,16 @@ }, "delete": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "Delete a Product Visibility resource.", + "summary": "Delete a Product Stream resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteProductVisibility", + "operationId": "deleteProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -49295,16 +49295,16 @@ }, "patch": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "Partially update information about a Product Visibility resource.", + "summary": "Partially update information about a Product Stream resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateProductVisibility", + "operationId": "updateProductStream", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_visibility", + "description": "Identifier for the product_stream", "required": true, "schema": { "type": "string", @@ -49322,18 +49322,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Visibility resource.", + "description": "Partially update information about a Product Stream resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } }, "responses": { "200": { - "description": "Detail of ProductVisibility", + "description": "Detail of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -49345,7 +49345,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49360,7 +49360,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49379,14 +49379,14 @@ } } }, - "/aggregate/product-visibility": { + "/aggregate/product-stream": { "post": { "tags": [ - "Product Visibility" + "Product Stream" ], - "summary": "Aggregate for the Product Visibility resources.", + "summary": "Aggregate for the Product Stream resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductVisibility", + "operationId": "aggregateProductStream", "requestBody": { "required": true, "content": { @@ -49410,7 +49410,7 @@ }, "responses": { "200": { - "description": "List of ProductVisibility", + "description": "List of ProductStream", "content": { "application/vnd.api+json": { "schema": { @@ -49424,7 +49424,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49442,7 +49442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductVisibility" + "$ref": "#/components/schemas/ProductStream" } } } @@ -49459,14 +49459,14 @@ } } }, - "/promotion": { + "/product-stream-filter": { "get": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "List with basic information of Promotion resources.", + "summary": "List with basic information of Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionList", + "operationId": "getProductStreamFilterList", "parameters": [ { "name": "limit", @@ -49495,7 +49495,7 @@ ], "responses": { "200": { - "description": "List of Promotion resources.", + "description": "List of Product Stream Filter resources.", "content": { "application/vnd.api+json": { "schema": { @@ -49514,7 +49514,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } ] @@ -49528,16 +49528,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion?limit=25" + "example": "/product-stream-filter?limit=25" }, "last": { - "example": "/promotion?limit=25&page=11" + "example": "/product-stream-filter?limit=25&page=11" }, "next": { - "example": "/promotion?limit=25&page=4" + "example": "/product-stream-filter?limit=25&page=4" }, "prev": { - "example": "/promotion?limit=25&page=2" + "example": "/product-stream-filter?limit=25&page=2" } } } @@ -49558,7 +49558,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49573,11 +49573,11 @@ }, "post": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "Create a new Promotion resources.", + "summary": "Create a new Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotion", + "operationId": "createProductStreamFilter", "parameters": [ { "name": "_response", @@ -49596,14 +49596,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -49615,7 +49615,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49630,7 +49630,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49646,14 +49646,14 @@ } } }, - "/search/promotion": { + "/search/product-stream-filter": { "post": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "Search for the Promotion resources.", + "summary": "Search for the Product Stream Filter resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPromotion", + "operationId": "searchProductStreamFilter", "requestBody": { "required": true, "content": { @@ -49666,7 +49666,7 @@ }, "responses": { "200": { - "description": "List of Promotion", + "description": "List of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -49680,7 +49680,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49698,7 +49698,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49715,19 +49715,19 @@ } } }, - "/promotion/{id}": { + "/product-stream-filter/{id}": { "get": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "Detailed information about a Promotion resource.", + "summary": "Detailed information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotion", + "operationId": "getProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -49737,7 +49737,7 @@ ], "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -49749,7 +49749,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49764,7 +49764,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49781,16 +49781,16 @@ }, "delete": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "Delete a Promotion resource.", + "summary": "Delete a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotion", + "operationId": "deleteProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -49821,16 +49821,16 @@ }, "patch": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "Partially update information about a Promotion resource.", + "summary": "Partially update information about a Product Stream Filter resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotion", + "operationId": "updateProductStreamFilter", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion", + "description": "Identifier for the product_stream_filter", "required": true, "schema": { "type": "string", @@ -49848,18 +49848,18 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion resource.", + "description": "Partially update information about a Product Stream Filter resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } }, "responses": { "200": { - "description": "Detail of Promotion", + "description": "Detail of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -49871,7 +49871,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49886,7 +49886,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49905,14 +49905,14 @@ } } }, - "/aggregate/promotion": { + "/aggregate/product-stream-filter": { "post": { "tags": [ - "Promotion" + "Product Stream Filter" ], - "summary": "Aggregate for the Promotion resources.", + "summary": "Aggregate for the Product Stream Filter resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotion", + "operationId": "aggregateProductStreamFilter", "requestBody": { "required": true, "content": { @@ -49936,7 +49936,7 @@ }, "responses": { "200": { - "description": "List of Promotion", + "description": "List of ProductStreamFilter", "content": { "application/vnd.api+json": { "schema": { @@ -49950,7 +49950,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49968,7 +49968,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Promotion" + "$ref": "#/components/schemas/ProductStreamFilter" } } } @@ -49985,14 +49985,14 @@ } } }, - "/promotion-discount": { + "/product-visibility": { "get": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "List with basic information of Promotion Discount resources.", + "summary": "List with basic information of Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountList", + "operationId": "getProductVisibilityList", "parameters": [ { "name": "limit", @@ -50021,7 +50021,7 @@ ], "responses": { "200": { - "description": "List of Promotion Discount resources.", + "description": "List of Product Visibility resources.", "content": { "application/vnd.api+json": { "schema": { @@ -50040,7 +50040,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } ] @@ -50054,16 +50054,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-discount?limit=25" + "example": "/product-visibility?limit=25" }, "last": { - "example": "/promotion-discount?limit=25&page=11" + "example": "/product-visibility?limit=25&page=11" }, "next": { - "example": "/promotion-discount?limit=25&page=4" + "example": "/product-visibility?limit=25&page=4" }, "prev": { - "example": "/promotion-discount?limit=25&page=2" + "example": "/product-visibility?limit=25&page=2" } } } @@ -50084,7 +50084,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50099,11 +50099,11 @@ }, "post": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "Create a new Promotion Discount resources.", + "summary": "Create a new Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscount", + "operationId": "createProductVisibility", "parameters": [ { "name": "_response", @@ -50122,14 +50122,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -50141,7 +50141,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50156,7 +50156,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50172,14 +50172,14 @@ } } }, - "/search/promotion-discount": { + "/search/product-visibility": { "post": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "Search for the Promotion Discount resources.", + "summary": "Search for the Product Visibility resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionDiscount", + "operationId": "searchProductVisibility", "requestBody": { "required": true, "content": { @@ -50192,7 +50192,7 @@ }, "responses": { "200": { - "description": "List of PromotionDiscount", + "description": "List of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -50206,7 +50206,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50224,7 +50224,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50241,19 +50241,19 @@ } } }, - "/promotion-discount/{id}": { + "/product-visibility/{id}": { "get": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "Detailed information about a Promotion Discount resource.", + "summary": "Detailed information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscount", + "operationId": "getProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -50263,7 +50263,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -50275,7 +50275,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50290,7 +50290,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50307,16 +50307,16 @@ }, "delete": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "Delete a Promotion Discount resource.", + "summary": "Delete a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscount", + "operationId": "deleteProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -50347,16 +50347,16 @@ }, "patch": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "Partially update information about a Promotion Discount resource.", + "summary": "Partially update information about a Product Visibility resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscount", + "operationId": "updateProductVisibility", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount", + "description": "Identifier for the product_visibility", "required": true, "schema": { "type": "string", @@ -50374,18 +50374,18 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Discount resource.", + "description": "Partially update information about a Product Visibility resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscount", + "description": "Detail of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -50397,7 +50397,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50412,7 +50412,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50431,14 +50431,14 @@ } } }, - "/aggregate/promotion-discount": { + "/aggregate/product-visibility": { "post": { "tags": [ - "Promotion Discount" + "Product Visibility" ], - "summary": "Aggregate for the Promotion Discount resources.", + "summary": "Aggregate for the Product Visibility resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionDiscount", + "operationId": "aggregateProductVisibility", "requestBody": { "required": true, "content": { @@ -50462,7 +50462,7 @@ }, "responses": { "200": { - "description": "List of PromotionDiscount", + "description": "List of ProductVisibility", "content": { "application/vnd.api+json": { "schema": { @@ -50476,7 +50476,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50494,7 +50494,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscount" + "$ref": "#/components/schemas/ProductVisibility" } } } @@ -50511,14 +50511,14 @@ } } }, - "/promotion-discount-prices": { + "/promotion": { "get": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "List with basic information of Promotion Discount Prices resources.", + "summary": "List with basic information of Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPricesList", + "operationId": "getPromotionList", "parameters": [ { "name": "limit", @@ -50547,7 +50547,7 @@ ], "responses": { "200": { - "description": "List of Promotion Discount Prices resources.", + "description": "List of Promotion resources.", "content": { "application/vnd.api+json": { "schema": { @@ -50566,7 +50566,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } ] @@ -50580,16 +50580,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-discount-prices?limit=25" + "example": "/promotion?limit=25" }, "last": { - "example": "/promotion-discount-prices?limit=25&page=11" + "example": "/promotion?limit=25&page=11" }, "next": { - "example": "/promotion-discount-prices?limit=25&page=4" + "example": "/promotion?limit=25&page=4" }, "prev": { - "example": "/promotion-discount-prices?limit=25&page=2" + "example": "/promotion?limit=25&page=2" } } } @@ -50610,7 +50610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50625,11 +50625,11 @@ }, "post": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "Create a new Promotion Discount Prices resources.", + "summary": "Create a new Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionDiscountPrices", + "operationId": "createPromotion", "parameters": [ { "name": "_response", @@ -50648,14 +50648,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -50667,7 +50667,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50682,7 +50682,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50698,14 +50698,14 @@ } } }, - "/search/promotion-discount-prices": { + "/search/promotion": { "post": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "Search for the Promotion Discount Prices resources.", + "summary": "Search for the Promotion resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionDiscountPrices", + "operationId": "searchPromotion", "requestBody": { "required": true, "content": { @@ -50718,7 +50718,7 @@ }, "responses": { "200": { - "description": "List of PromotionDiscountPrices", + "description": "List of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -50732,7 +50732,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50750,7 +50750,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50767,19 +50767,19 @@ } } }, - "/promotion-discount-prices/{id}": { + "/promotion/{id}": { "get": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "Detailed information about a Promotion Discount Prices resource.", + "summary": "Detailed information about a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionDiscountPrices", + "operationId": "getPromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -50789,7 +50789,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -50801,7 +50801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50816,7 +50816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50833,16 +50833,16 @@ }, "delete": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "Delete a Promotion Discount Prices resource.", + "summary": "Delete a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionDiscountPrices", + "operationId": "deletePromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -50873,16 +50873,16 @@ }, "patch": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "Partially update information about a Promotion Discount Prices resource.", + "summary": "Partially update information about a Promotion resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionDiscountPrices", + "operationId": "updatePromotion", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_discount_prices", + "description": "Identifier for the promotion", "required": true, "schema": { "type": "string", @@ -50900,18 +50900,18 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Discount Prices resource.", + "description": "Partially update information about a Promotion resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } }, "responses": { "200": { - "description": "Detail of PromotionDiscountPrices", + "description": "Detail of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -50923,7 +50923,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50938,7 +50938,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -50957,14 +50957,14 @@ } } }, - "/aggregate/promotion-discount-prices": { + "/aggregate/promotion": { "post": { "tags": [ - "Promotion Discount Prices" + "Promotion" ], - "summary": "Aggregate for the Promotion Discount Prices resources.", + "summary": "Aggregate for the Promotion resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionDiscountPrices", + "operationId": "aggregatePromotion", "requestBody": { "required": true, "content": { @@ -50988,7 +50988,7 @@ }, "responses": { "200": { - "description": "List of PromotionDiscountPrices", + "description": "List of Promotion", "content": { "application/vnd.api+json": { "schema": { @@ -51002,7 +51002,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -51020,7 +51020,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "$ref": "#/components/schemas/Promotion" } } } @@ -51037,14 +51037,14 @@ } } }, - "/promotion-individual-code": { + "/promotion-discount": { "get": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "List with basic information of Promotion Individual Code resources.", + "summary": "List with basic information of Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCodeList", + "operationId": "getPromotionDiscountList", "parameters": [ { "name": "limit", @@ -51073,7 +51073,7 @@ ], "responses": { "200": { - "description": "List of Promotion Individual Code resources.", + "description": "List of Promotion Discount resources.", "content": { "application/vnd.api+json": { "schema": { @@ -51092,7 +51092,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } ] @@ -51106,16 +51106,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-individual-code?limit=25" + "example": "/promotion-discount?limit=25" }, "last": { - "example": "/promotion-individual-code?limit=25&page=11" + "example": "/promotion-discount?limit=25&page=11" }, "next": { - "example": "/promotion-individual-code?limit=25&page=4" + "example": "/promotion-discount?limit=25&page=4" }, "prev": { - "example": "/promotion-individual-code?limit=25&page=2" + "example": "/promotion-discount?limit=25&page=2" } } } @@ -51136,7 +51136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51151,11 +51151,11 @@ }, "post": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "Create a new Promotion Individual Code resources.", + "summary": "Create a new Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionIndividualCode", + "operationId": "createPromotionDiscount", "parameters": [ { "name": "_response", @@ -51174,14 +51174,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -51193,7 +51193,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51208,7 +51208,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51224,14 +51224,14 @@ } } }, - "/search/promotion-individual-code": { + "/search/promotion-discount": { "post": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "Search for the Promotion Individual Code resources.", + "summary": "Search for the Promotion Discount resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionIndividualCode", + "operationId": "searchPromotionDiscount", "requestBody": { "required": true, "content": { @@ -51244,7 +51244,7 @@ }, "responses": { "200": { - "description": "List of PromotionIndividualCode", + "description": "List of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -51258,7 +51258,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51276,7 +51276,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51293,19 +51293,19 @@ } } }, - "/promotion-individual-code/{id}": { + "/promotion-discount/{id}": { "get": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "Detailed information about a Promotion Individual Code resource.", + "summary": "Detailed information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionIndividualCode", + "operationId": "getPromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -51315,7 +51315,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -51327,7 +51327,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51342,7 +51342,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51359,16 +51359,16 @@ }, "delete": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "Delete a Promotion Individual Code resource.", + "summary": "Delete a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionIndividualCode", + "operationId": "deletePromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -51399,16 +51399,16 @@ }, "patch": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "Partially update information about a Promotion Individual Code resource.", + "summary": "Partially update information about a Promotion Discount resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionIndividualCode", + "operationId": "updatePromotionDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_individual_code", + "description": "Identifier for the promotion_discount", "required": true, "schema": { "type": "string", @@ -51426,18 +51426,18 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Individual Code resource.", + "description": "Partially update information about a Promotion Discount resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } }, "responses": { "200": { - "description": "Detail of PromotionIndividualCode", + "description": "Detail of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -51449,7 +51449,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51464,7 +51464,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51483,14 +51483,14 @@ } } }, - "/aggregate/promotion-individual-code": { + "/aggregate/promotion-discount": { "post": { "tags": [ - "Promotion Individual Code" + "Promotion Discount" ], - "summary": "Aggregate for the Promotion Individual Code resources.", + "summary": "Aggregate for the Promotion Discount resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionIndividualCode", + "operationId": "aggregatePromotionDiscount", "requestBody": { "required": true, "content": { @@ -51514,7 +51514,7 @@ }, "responses": { "200": { - "description": "List of PromotionIndividualCode", + "description": "List of PromotionDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -51528,7 +51528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51546,7 +51546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" + "$ref": "#/components/schemas/PromotionDiscount" } } } @@ -51563,14 +51563,14 @@ } } }, - "/promotion-sales-channel": { + "/promotion-discount-prices": { "get": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "List with basic information of Promotion Sales Channel resources.", + "summary": "List with basic information of Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannelList", + "operationId": "getPromotionDiscountPricesList", "parameters": [ { "name": "limit", @@ -51599,7 +51599,7 @@ ], "responses": { "200": { - "description": "List of Promotion Sales Channel resources.", + "description": "List of Promotion Discount Prices resources.", "content": { "application/vnd.api+json": { "schema": { @@ -51618,7 +51618,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } ] @@ -51632,16 +51632,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-sales-channel?limit=25" + "example": "/promotion-discount-prices?limit=25" }, "last": { - "example": "/promotion-sales-channel?limit=25&page=11" + "example": "/promotion-discount-prices?limit=25&page=11" }, "next": { - "example": "/promotion-sales-channel?limit=25&page=4" + "example": "/promotion-discount-prices?limit=25&page=4" }, "prev": { - "example": "/promotion-sales-channel?limit=25&page=2" + "example": "/promotion-discount-prices?limit=25&page=2" } } } @@ -51662,7 +51662,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51677,11 +51677,11 @@ }, "post": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "Create a new Promotion Sales Channel resources.", + "summary": "Create a new Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSalesChannel", + "operationId": "createPromotionDiscountPrices", "parameters": [ { "name": "_response", @@ -51700,14 +51700,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -51719,7 +51719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51734,7 +51734,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51750,14 +51750,14 @@ } } }, - "/search/promotion-sales-channel": { + "/search/promotion-discount-prices": { "post": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "Search for the Promotion Sales Channel resources.", + "summary": "Search for the Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionSalesChannel", + "operationId": "searchPromotionDiscountPrices", "requestBody": { "required": true, "content": { @@ -51770,7 +51770,7 @@ }, "responses": { "200": { - "description": "List of PromotionSalesChannel", + "description": "List of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -51784,7 +51784,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51802,7 +51802,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51819,19 +51819,19 @@ } } }, - "/promotion-sales-channel/{id}": { + "/promotion-discount-prices/{id}": { "get": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "Detailed information about a Promotion Sales Channel resource.", + "summary": "Detailed information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSalesChannel", + "operationId": "getPromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -51841,7 +51841,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -51853,7 +51853,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51868,7 +51868,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51885,16 +51885,16 @@ }, "delete": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "Delete a Promotion Sales Channel resource.", + "summary": "Delete a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSalesChannel", + "operationId": "deletePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -51925,16 +51925,16 @@ }, "patch": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "Partially update information about a Promotion Sales Channel resource.", + "summary": "Partially update information about a Promotion Discount Prices resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSalesChannel", + "operationId": "updatePromotionDiscountPrices", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_sales_channel", + "description": "Identifier for the promotion_discount_prices", "required": true, "schema": { "type": "string", @@ -51952,18 +51952,18 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Sales Channel resource.", + "description": "Partially update information about a Promotion Discount Prices resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } }, "responses": { "200": { - "description": "Detail of PromotionSalesChannel", + "description": "Detail of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -51975,7 +51975,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -51990,7 +51990,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -52009,14 +52009,14 @@ } } }, - "/aggregate/promotion-sales-channel": { + "/aggregate/promotion-discount-prices": { "post": { "tags": [ - "Promotion Sales Channel" + "Promotion Discount Prices" ], - "summary": "Aggregate for the Promotion Sales Channel resources.", + "summary": "Aggregate for the Promotion Discount Prices resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionSalesChannel", + "operationId": "aggregatePromotionDiscountPrices", "requestBody": { "required": true, "content": { @@ -52040,7 +52040,7 @@ }, "responses": { "200": { - "description": "List of PromotionSalesChannel", + "description": "List of PromotionDiscountPrices", "content": { "application/vnd.api+json": { "schema": { @@ -52054,7 +52054,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -52072,7 +52072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" + "$ref": "#/components/schemas/PromotionDiscountPrices" } } } @@ -52089,14 +52089,14 @@ } } }, - "/promotion-setgroup": { + "/promotion-individual-code": { "get": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "List with basic information of Promotion Setgroup resources.", + "summary": "List with basic information of Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroupList", + "operationId": "getPromotionIndividualCodeList", "parameters": [ { "name": "limit", @@ -52125,7 +52125,7 @@ ], "responses": { "200": { - "description": "List of Promotion Setgroup resources.", + "description": "List of Promotion Individual Code resources.", "content": { "application/vnd.api+json": { "schema": { @@ -52144,7 +52144,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } ] @@ -52158,16 +52158,16 @@ "type": "object", "properties": { "first": { - "example": "/promotion-setgroup?limit=25" + "example": "/promotion-individual-code?limit=25" }, "last": { - "example": "/promotion-setgroup?limit=25&page=11" + "example": "/promotion-individual-code?limit=25&page=11" }, "next": { - "example": "/promotion-setgroup?limit=25&page=4" + "example": "/promotion-individual-code?limit=25&page=4" }, "prev": { - "example": "/promotion-setgroup?limit=25&page=2" + "example": "/promotion-individual-code?limit=25&page=2" } } } @@ -52188,7 +52188,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52203,11 +52203,11 @@ }, "post": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "Create a new Promotion Setgroup resources.", + "summary": "Create a new Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPromotionSetgroup", + "operationId": "createPromotionIndividualCode", "parameters": [ { "name": "_response", @@ -52226,14 +52226,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -52245,7 +52245,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52260,7 +52260,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52276,14 +52276,14 @@ } } }, - "/search/promotion-setgroup": { + "/search/promotion-individual-code": { "post": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "Search for the Promotion Setgroup resources.", + "summary": "Search for the Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPromotionSetgroup", + "operationId": "searchPromotionIndividualCode", "requestBody": { "required": true, "content": { @@ -52296,7 +52296,7 @@ }, "responses": { "200": { - "description": "List of PromotionSetgroup", + "description": "List of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -52310,7 +52310,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52328,7 +52328,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52345,19 +52345,19 @@ } } }, - "/promotion-setgroup/{id}": { + "/promotion-individual-code/{id}": { "get": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "Detailed information about a Promotion Setgroup resource.", + "summary": "Detailed information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPromotionSetgroup", + "operationId": "getPromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -52367,7 +52367,7 @@ ], "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -52379,7 +52379,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52394,7 +52394,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52411,16 +52411,16 @@ }, "delete": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "Delete a Promotion Setgroup resource.", + "summary": "Delete a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePromotionSetgroup", + "operationId": "deletePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -52451,16 +52451,16 @@ }, "patch": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "Partially update information about a Promotion Setgroup resource.", + "summary": "Partially update information about a Promotion Individual Code resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePromotionSetgroup", + "operationId": "updatePromotionIndividualCode", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the promotion_setgroup", + "description": "Identifier for the promotion_individual_code", "required": true, "schema": { "type": "string", @@ -52478,18 +52478,18 @@ } ], "requestBody": { - "description": "Partially update information about a Promotion Setgroup resource.", + "description": "Partially update information about a Promotion Individual Code resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } }, "responses": { "200": { - "description": "Detail of PromotionSetgroup", + "description": "Detail of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -52501,7 +52501,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52516,7 +52516,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52535,14 +52535,14 @@ } } }, - "/aggregate/promotion-setgroup": { + "/aggregate/promotion-individual-code": { "post": { "tags": [ - "Promotion Setgroup" + "Promotion Individual Code" ], - "summary": "Aggregate for the Promotion Setgroup resources.", + "summary": "Aggregate for the Promotion Individual Code resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionSetgroup", + "operationId": "aggregatePromotionIndividualCode", "requestBody": { "required": true, "content": { @@ -52566,7 +52566,7 @@ }, "responses": { "200": { - "description": "List of PromotionSetgroup", + "description": "List of PromotionIndividualCode", "content": { "application/vnd.api+json": { "schema": { @@ -52580,7 +52580,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52598,7 +52598,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "$ref": "#/components/schemas/PromotionIndividualCode" } } } @@ -52615,14 +52615,14 @@ } } }, - "/property-group": { + "/promotion-sales-channel": { "get": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "List with basic information of Property Group resources.", + "summary": "List with basic information of Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupList", + "operationId": "getPromotionSalesChannelList", "parameters": [ { "name": "limit", @@ -52651,7 +52651,7 @@ ], "responses": { "200": { - "description": "List of Property Group resources.", + "description": "List of Promotion Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -52670,7 +52670,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } ] @@ -52684,16 +52684,16 @@ "type": "object", "properties": { "first": { - "example": "/property-group?limit=25" + "example": "/promotion-sales-channel?limit=25" }, "last": { - "example": "/property-group?limit=25&page=11" + "example": "/promotion-sales-channel?limit=25&page=11" }, "next": { - "example": "/property-group?limit=25&page=4" + "example": "/promotion-sales-channel?limit=25&page=4" }, "prev": { - "example": "/property-group?limit=25&page=2" + "example": "/promotion-sales-channel?limit=25&page=2" } } } @@ -52714,7 +52714,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52729,11 +52729,11 @@ }, "post": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "Create a new Property Group resources.", + "summary": "Create a new Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroup", + "operationId": "createPromotionSalesChannel", "parameters": [ { "name": "_response", @@ -52752,14 +52752,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -52771,7 +52771,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52786,7 +52786,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52802,14 +52802,14 @@ } } }, - "/search/property-group": { + "/search/promotion-sales-channel": { "post": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "Search for the Property Group resources.", + "summary": "Search for the Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPropertyGroup", + "operationId": "searchPromotionSalesChannel", "requestBody": { "required": true, "content": { @@ -52822,7 +52822,7 @@ }, "responses": { "200": { - "description": "List of PropertyGroup", + "description": "List of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -52836,7 +52836,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52854,7 +52854,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52871,19 +52871,19 @@ } } }, - "/property-group/{id}": { + "/promotion-sales-channel/{id}": { "get": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "Detailed information about a Property Group resource.", + "summary": "Detailed information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroup", + "operationId": "getPromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -52893,7 +52893,7 @@ ], "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -52905,7 +52905,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52920,7 +52920,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -52937,16 +52937,16 @@ }, "delete": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "Delete a Property Group resource.", + "summary": "Delete a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroup", + "operationId": "deletePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -52977,16 +52977,16 @@ }, "patch": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "Partially update information about a Property Group resource.", + "summary": "Partially update information about a Promotion Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroup", + "operationId": "updatePromotionSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group", + "description": "Identifier for the promotion_sales_channel", "required": true, "schema": { "type": "string", @@ -53004,18 +53004,18 @@ } ], "requestBody": { - "description": "Partially update information about a Property Group resource.", + "description": "Partially update information about a Promotion Sales Channel resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroup", + "description": "Detail of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -53027,7 +53027,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -53042,7 +53042,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -53061,14 +53061,14 @@ } } }, - "/aggregate/property-group": { + "/aggregate/promotion-sales-channel": { "post": { "tags": [ - "Property Group" + "Promotion Sales Channel" ], - "summary": "Aggregate for the Property Group resources.", + "summary": "Aggregate for the Promotion Sales Channel resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePropertyGroup", + "operationId": "aggregatePromotionSalesChannel", "requestBody": { "required": true, "content": { @@ -53092,7 +53092,7 @@ }, "responses": { "200": { - "description": "List of PropertyGroup", + "description": "List of PromotionSalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -53106,7 +53106,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -53124,7 +53124,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroup" + "$ref": "#/components/schemas/PromotionSalesChannel" } } } @@ -53141,14 +53141,14 @@ } } }, - "/property-group-option": { + "/promotion-setgroup": { "get": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "List with basic information of Property Group Option resources.", + "summary": "List with basic information of Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOptionList", + "operationId": "getPromotionSetgroupList", "parameters": [ { "name": "limit", @@ -53177,7 +53177,7 @@ ], "responses": { "200": { - "description": "List of Property Group Option resources.", + "description": "List of Promotion Setgroup resources.", "content": { "application/vnd.api+json": { "schema": { @@ -53196,7 +53196,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } ] @@ -53210,16 +53210,16 @@ "type": "object", "properties": { "first": { - "example": "/property-group-option?limit=25" + "example": "/promotion-setgroup?limit=25" }, "last": { - "example": "/property-group-option?limit=25&page=11" + "example": "/promotion-setgroup?limit=25&page=11" }, "next": { - "example": "/property-group-option?limit=25&page=4" + "example": "/promotion-setgroup?limit=25&page=4" }, "prev": { - "example": "/property-group-option?limit=25&page=2" + "example": "/promotion-setgroup?limit=25&page=2" } } } @@ -53240,7 +53240,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53255,11 +53255,11 @@ }, "post": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "Create a new Property Group Option resources.", + "summary": "Create a new Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "createPropertyGroupOption", + "operationId": "createPromotionSetgroup", "parameters": [ { "name": "_response", @@ -53278,14 +53278,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -53297,7 +53297,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53312,7 +53312,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53328,14 +53328,14 @@ } } }, - "/search/property-group-option": { + "/search/promotion-setgroup": { "post": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "Search for the Property Group Option resources.", + "summary": "Search for the Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchPropertyGroupOption", + "operationId": "searchPromotionSetgroup", "requestBody": { "required": true, "content": { @@ -53348,7 +53348,7 @@ }, "responses": { "200": { - "description": "List of PropertyGroupOption", + "description": "List of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -53362,7 +53362,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53380,7 +53380,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53397,19 +53397,19 @@ } } }, - "/property-group-option/{id}": { + "/promotion-setgroup/{id}": { "get": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "Detailed information about a Property Group Option resource.", + "summary": "Detailed information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "getPropertyGroupOption", + "operationId": "getPromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -53419,7 +53419,7 @@ ], "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -53431,7 +53431,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53446,7 +53446,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53463,16 +53463,16 @@ }, "delete": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "Delete a Property Group Option resource.", + "summary": "Delete a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "deletePropertyGroupOption", + "operationId": "deletePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -53503,16 +53503,16 @@ }, "patch": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "Partially update information about a Property Group Option resource.", + "summary": "Partially update information about a Promotion Setgroup resource.", "description": "Available since: 6.0.0.0", - "operationId": "updatePropertyGroupOption", + "operationId": "updatePromotionSetgroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the property_group_option", + "description": "Identifier for the promotion_setgroup", "required": true, "schema": { "type": "string", @@ -53530,18 +53530,18 @@ } ], "requestBody": { - "description": "Partially update information about a Property Group Option resource.", + "description": "Partially update information about a Promotion Setgroup resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } }, "responses": { "200": { - "description": "Detail of PropertyGroupOption", + "description": "Detail of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -53553,7 +53553,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53568,7 +53568,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53587,14 +53587,14 @@ } } }, - "/aggregate/property-group-option": { + "/aggregate/promotion-setgroup": { "post": { "tags": [ - "Property Group Option" + "Promotion Setgroup" ], - "summary": "Aggregate for the Property Group Option resources.", + "summary": "Aggregate for the Promotion Setgroup resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregatePropertyGroupOption", + "operationId": "aggregatePromotionSetgroup", "requestBody": { "required": true, "content": { @@ -53618,7 +53618,7 @@ }, "responses": { "200": { - "description": "List of PropertyGroupOption", + "description": "List of PromotionSetgroup", "content": { "application/vnd.api+json": { "schema": { @@ -53632,7 +53632,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53650,7 +53650,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "$ref": "#/components/schemas/PromotionSetgroup" } } } @@ -53667,14 +53667,14 @@ } } }, - "/rule": { + "/property-group": { "get": { "tags": [ - "Rule" + "Property Group" ], - "summary": "List with basic information of Rule resources.", + "summary": "List with basic information of Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleList", + "operationId": "getPropertyGroupList", "parameters": [ { "name": "limit", @@ -53703,7 +53703,7 @@ ], "responses": { "200": { - "description": "List of Rule resources.", + "description": "List of Property Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -53722,7 +53722,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } ] @@ -53736,16 +53736,16 @@ "type": "object", "properties": { "first": { - "example": "/rule?limit=25" + "example": "/property-group?limit=25" }, "last": { - "example": "/rule?limit=25&page=11" + "example": "/property-group?limit=25&page=11" }, "next": { - "example": "/rule?limit=25&page=4" + "example": "/property-group?limit=25&page=4" }, "prev": { - "example": "/rule?limit=25&page=2" + "example": "/property-group?limit=25&page=2" } } } @@ -53766,7 +53766,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53781,11 +53781,11 @@ }, "post": { "tags": [ - "Rule" + "Property Group" ], - "summary": "Create a new Rule resources.", + "summary": "Create a new Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "createRule", + "operationId": "createPropertyGroup", "parameters": [ { "name": "_response", @@ -53804,14 +53804,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -53823,7 +53823,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53838,7 +53838,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53854,14 +53854,14 @@ } } }, - "/search/rule": { + "/search/property-group": { "post": { "tags": [ - "Rule" + "Property Group" ], - "summary": "Search for the Rule resources.", + "summary": "Search for the Property Group resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchRule", + "operationId": "searchPropertyGroup", "requestBody": { "required": true, "content": { @@ -53874,7 +53874,7 @@ }, "responses": { "200": { - "description": "List of Rule", + "description": "List of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -53888,7 +53888,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53906,7 +53906,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53923,19 +53923,19 @@ } } }, - "/rule/{id}": { + "/property-group/{id}": { "get": { "tags": [ - "Rule" + "Property Group" ], - "summary": "Detailed information about a Rule resource.", + "summary": "Detailed information about a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "getRule", + "operationId": "getPropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -53945,7 +53945,7 @@ ], "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -53957,7 +53957,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53972,7 +53972,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -53989,16 +53989,16 @@ }, "delete": { "tags": [ - "Rule" + "Property Group" ], - "summary": "Delete a Rule resource.", + "summary": "Delete a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteRule", + "operationId": "deletePropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -54029,16 +54029,16 @@ }, "patch": { "tags": [ - "Rule" + "Property Group" ], - "summary": "Partially update information about a Rule resource.", + "summary": "Partially update information about a Property Group resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateRule", + "operationId": "updatePropertyGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule", + "description": "Identifier for the property_group", "required": true, "schema": { "type": "string", @@ -54056,18 +54056,18 @@ } ], "requestBody": { - "description": "Partially update information about a Rule resource.", + "description": "Partially update information about a Property Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } }, "responses": { "200": { - "description": "Detail of Rule", + "description": "Detail of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -54079,7 +54079,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -54094,7 +54094,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -54113,14 +54113,14 @@ } } }, - "/aggregate/rule": { + "/aggregate/property-group": { "post": { "tags": [ - "Rule" + "Property Group" ], - "summary": "Aggregate for the Rule resources.", + "summary": "Aggregate for the Property Group resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateRule", + "operationId": "aggregatePropertyGroup", "requestBody": { "required": true, "content": { @@ -54144,7 +54144,7 @@ }, "responses": { "200": { - "description": "List of Rule", + "description": "List of PropertyGroup", "content": { "application/vnd.api+json": { "schema": { @@ -54158,7 +54158,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -54176,7 +54176,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/PropertyGroup" } } } @@ -54193,14 +54193,14 @@ } } }, - "/rule-condition": { + "/property-group-option": { "get": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "List with basic information of Rule Condition resources.", + "summary": "List with basic information of Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleConditionList", + "operationId": "getPropertyGroupOptionList", "parameters": [ { "name": "limit", @@ -54229,7 +54229,7 @@ ], "responses": { "200": { - "description": "List of Rule Condition resources.", + "description": "List of Property Group Option resources.", "content": { "application/vnd.api+json": { "schema": { @@ -54248,7 +54248,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } ] @@ -54262,16 +54262,16 @@ "type": "object", "properties": { "first": { - "example": "/rule-condition?limit=25" + "example": "/property-group-option?limit=25" }, "last": { - "example": "/rule-condition?limit=25&page=11" + "example": "/property-group-option?limit=25&page=11" }, "next": { - "example": "/rule-condition?limit=25&page=4" + "example": "/property-group-option?limit=25&page=4" }, "prev": { - "example": "/rule-condition?limit=25&page=2" + "example": "/property-group-option?limit=25&page=2" } } } @@ -54292,7 +54292,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54307,11 +54307,11 @@ }, "post": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "Create a new Rule Condition resources.", + "summary": "Create a new Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "createRuleCondition", + "operationId": "createPropertyGroupOption", "parameters": [ { "name": "_response", @@ -54330,14 +54330,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -54349,7 +54349,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54364,7 +54364,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54380,14 +54380,14 @@ } } }, - "/search/rule-condition": { + "/search/property-group-option": { "post": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "Search for the Rule Condition resources.", + "summary": "Search for the Property Group Option resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchRuleCondition", + "operationId": "searchPropertyGroupOption", "requestBody": { "required": true, "content": { @@ -54400,7 +54400,7 @@ }, "responses": { "200": { - "description": "List of RuleCondition", + "description": "List of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -54414,7 +54414,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54432,7 +54432,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54449,19 +54449,19 @@ } } }, - "/rule-condition/{id}": { + "/property-group-option/{id}": { "get": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "Detailed information about a Rule Condition resource.", + "summary": "Detailed information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "getRuleCondition", + "operationId": "getPropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -54471,7 +54471,7 @@ ], "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -54483,7 +54483,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54498,7 +54498,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54515,16 +54515,16 @@ }, "delete": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "Delete a Rule Condition resource.", + "summary": "Delete a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteRuleCondition", + "operationId": "deletePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -54555,16 +54555,16 @@ }, "patch": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "Partially update information about a Rule Condition resource.", + "summary": "Partially update information about a Property Group Option resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateRuleCondition", + "operationId": "updatePropertyGroupOption", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the rule_condition", + "description": "Identifier for the property_group_option", "required": true, "schema": { "type": "string", @@ -54582,18 +54582,18 @@ } ], "requestBody": { - "description": "Partially update information about a Rule Condition resource.", + "description": "Partially update information about a Property Group Option resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } }, "responses": { "200": { - "description": "Detail of RuleCondition", + "description": "Detail of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -54605,7 +54605,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54620,7 +54620,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54639,14 +54639,14 @@ } } }, - "/aggregate/rule-condition": { + "/aggregate/property-group-option": { "post": { "tags": [ - "Rule Condition" + "Property Group Option" ], - "summary": "Aggregate for the Rule Condition resources.", + "summary": "Aggregate for the Property Group Option resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateRuleCondition", + "operationId": "aggregatePropertyGroupOption", "requestBody": { "required": true, "content": { @@ -54670,7 +54670,7 @@ }, "responses": { "200": { - "description": "List of RuleCondition", + "description": "List of PropertyGroupOption", "content": { "application/vnd.api+json": { "schema": { @@ -54684,7 +54684,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54702,7 +54702,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/PropertyGroupOption" } } } @@ -54719,14 +54719,14 @@ } } }, - "/sales-channel": { + "/rule": { "get": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "List with basic information of Sales Channel resources.", + "summary": "List with basic information of Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelList", + "operationId": "getRuleList", "parameters": [ { "name": "limit", @@ -54755,7 +54755,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel resources.", + "description": "List of Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -54774,7 +54774,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } ] @@ -54788,16 +54788,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel?limit=25" + "example": "/rule?limit=25" }, "last": { - "example": "/sales-channel?limit=25&page=11" + "example": "/rule?limit=25&page=11" }, "next": { - "example": "/sales-channel?limit=25&page=4" + "example": "/rule?limit=25&page=4" }, "prev": { - "example": "/sales-channel?limit=25&page=2" + "example": "/rule?limit=25&page=2" } } } @@ -54818,7 +54818,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -54833,11 +54833,11 @@ }, "post": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "Create a new Sales Channel resources.", + "summary": "Create a new Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannel", + "operationId": "createRule", "parameters": [ { "name": "_response", @@ -54856,14 +54856,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -54875,7 +54875,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -54890,7 +54890,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -54906,14 +54906,14 @@ } } }, - "/search/sales-channel": { + "/search/rule": { "post": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "Search for the Sales Channel resources.", + "summary": "Search for the Rule resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannel", + "operationId": "searchRule", "requestBody": { "required": true, "content": { @@ -54926,7 +54926,7 @@ }, "responses": { "200": { - "description": "List of SalesChannel", + "description": "List of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -54940,7 +54940,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -54958,7 +54958,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -54975,19 +54975,19 @@ } } }, - "/sales-channel/{id}": { + "/rule/{id}": { "get": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "Detailed information about a Sales Channel resource.", + "summary": "Detailed information about a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannel", + "operationId": "getRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -54997,7 +54997,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -55009,7 +55009,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -55024,7 +55024,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -55041,16 +55041,16 @@ }, "delete": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "Delete a Sales Channel resource.", + "summary": "Delete a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannel", + "operationId": "deleteRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -55081,16 +55081,16 @@ }, "patch": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "Partially update information about a Sales Channel resource.", + "summary": "Partially update information about a Rule resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannel", + "operationId": "updateRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel", + "description": "Identifier for the rule", "required": true, "schema": { "type": "string", @@ -55108,18 +55108,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel resource.", + "description": "Partially update information about a Rule resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } }, "responses": { "200": { - "description": "Detail of SalesChannel", + "description": "Detail of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -55131,7 +55131,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -55146,7 +55146,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -55165,14 +55165,14 @@ } } }, - "/aggregate/sales-channel": { + "/aggregate/rule": { "post": { "tags": [ - "Sales Channel" + "Rule" ], - "summary": "Aggregate for the Sales Channel resources.", + "summary": "Aggregate for the Rule resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannel", + "operationId": "aggregateRule", "requestBody": { "required": true, "content": { @@ -55196,7 +55196,7 @@ }, "responses": { "200": { - "description": "List of SalesChannel", + "description": "List of Rule", "content": { "application/vnd.api+json": { "schema": { @@ -55210,7 +55210,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -55228,7 +55228,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannel" + "$ref": "#/components/schemas/Rule" } } } @@ -55245,14 +55245,14 @@ } } }, - "/sales-channel-analytics": { + "/rule-condition": { "get": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "List with basic information of Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalyticsList", + "summary": "List with basic information of Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getRuleConditionList", "parameters": [ { "name": "limit", @@ -55281,7 +55281,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Analytics resources.", + "description": "List of Rule Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -55300,7 +55300,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } ] @@ -55314,16 +55314,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-analytics?limit=25" + "example": "/rule-condition?limit=25" }, "last": { - "example": "/sales-channel-analytics?limit=25&page=11" + "example": "/rule-condition?limit=25&page=11" }, "next": { - "example": "/sales-channel-analytics?limit=25&page=4" + "example": "/rule-condition?limit=25&page=4" }, "prev": { - "example": "/sales-channel-analytics?limit=25&page=2" + "example": "/rule-condition?limit=25&page=2" } } } @@ -55344,7 +55344,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55359,11 +55359,11 @@ }, "post": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "Create a new Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "createSalesChannelAnalytics", + "summary": "Create a new Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createRuleCondition", "parameters": [ { "name": "_response", @@ -55382,14 +55382,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -55401,7 +55401,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55416,7 +55416,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55432,14 +55432,14 @@ } } }, - "/search/sales-channel-analytics": { + "/search/rule-condition": { "post": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "Search for the Sales Channel Analytics resources.", - "description": "Available since: 6.2.0.0", - "operationId": "searchSalesChannelAnalytics", + "summary": "Search for the Rule Condition resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchRuleCondition", "requestBody": { "required": true, "content": { @@ -55452,7 +55452,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelAnalytics", + "description": "List of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -55466,7 +55466,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55484,7 +55484,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55501,19 +55501,19 @@ } } }, - "/sales-channel-analytics/{id}": { + "/rule-condition/{id}": { "get": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "Detailed information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "getSalesChannelAnalytics", + "summary": "Detailed information about a Rule Condition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -55523,7 +55523,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -55535,7 +55535,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55550,7 +55550,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55567,16 +55567,16 @@ }, "delete": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "Delete a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "deleteSalesChannelAnalytics", + "summary": "Delete a Rule Condition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -55607,16 +55607,16 @@ }, "patch": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "Partially update information about a Sales Channel Analytics resource.", - "description": "Available since: 6.2.0.0", - "operationId": "updateSalesChannelAnalytics", + "summary": "Partially update information about a Rule Condition resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateRuleCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_analytics", + "description": "Identifier for the rule_condition", "required": true, "schema": { "type": "string", @@ -55634,18 +55634,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Analytics resource.", + "description": "Partially update information about a Rule Condition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelAnalytics", + "description": "Detail of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -55657,7 +55657,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55672,7 +55672,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55691,14 +55691,14 @@ } } }, - "/aggregate/sales-channel-analytics": { + "/aggregate/rule-condition": { "post": { "tags": [ - "Sales Channel Analytics" + "Rule Condition" ], - "summary": "Aggregate for the Sales Channel Analytics resources.", + "summary": "Aggregate for the Rule Condition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelAnalytics", + "operationId": "aggregateRuleCondition", "requestBody": { "required": true, "content": { @@ -55722,7 +55722,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelAnalytics", + "description": "List of RuleCondition", "content": { "application/vnd.api+json": { "schema": { @@ -55736,7 +55736,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55754,7 +55754,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "$ref": "#/components/schemas/RuleCondition" } } } @@ -55771,14 +55771,14 @@ } } }, - "/sales-channel-domain": { + "/sales-channel": { "get": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "List with basic information of Sales Channel Domain resources.", + "summary": "List with basic information of Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomainList", + "operationId": "getSalesChannelList", "parameters": [ { "name": "limit", @@ -55807,7 +55807,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Domain resources.", + "description": "List of Sales Channel resources.", "content": { "application/vnd.api+json": { "schema": { @@ -55826,7 +55826,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } ] @@ -55840,16 +55840,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-domain?limit=25" + "example": "/sales-channel?limit=25" }, "last": { - "example": "/sales-channel-domain?limit=25&page=11" + "example": "/sales-channel?limit=25&page=11" }, "next": { - "example": "/sales-channel-domain?limit=25&page=4" + "example": "/sales-channel?limit=25&page=4" }, "prev": { - "example": "/sales-channel-domain?limit=25&page=2" + "example": "/sales-channel?limit=25&page=2" } } } @@ -55870,7 +55870,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -55885,11 +55885,11 @@ }, "post": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "Create a new Sales Channel Domain resources.", + "summary": "Create a new Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelDomain", + "operationId": "createSalesChannel", "parameters": [ { "name": "_response", @@ -55908,14 +55908,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -55927,7 +55927,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -55942,7 +55942,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -55958,14 +55958,14 @@ } } }, - "/search/sales-channel-domain": { + "/search/sales-channel": { "post": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "Search for the Sales Channel Domain resources.", + "summary": "Search for the Sales Channel resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelDomain", + "operationId": "searchSalesChannel", "requestBody": { "required": true, "content": { @@ -55978,7 +55978,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelDomain", + "description": "List of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -55992,7 +55992,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56010,7 +56010,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56027,19 +56027,19 @@ } } }, - "/sales-channel-domain/{id}": { + "/sales-channel/{id}": { "get": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "Detailed information about a Sales Channel Domain resource.", + "summary": "Detailed information about a Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelDomain", + "operationId": "getSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -56049,7 +56049,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -56061,7 +56061,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56076,7 +56076,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56093,16 +56093,16 @@ }, "delete": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "Delete a Sales Channel Domain resource.", + "summary": "Delete a Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelDomain", + "operationId": "deleteSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -56133,16 +56133,16 @@ }, "patch": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "Partially update information about a Sales Channel Domain resource.", + "summary": "Partially update information about a Sales Channel resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelDomain", + "operationId": "updateSalesChannel", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_domain", + "description": "Identifier for the sales_channel", "required": true, "schema": { "type": "string", @@ -56160,18 +56160,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Domain resource.", + "description": "Partially update information about a Sales Channel resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelDomain", + "description": "Detail of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -56183,7 +56183,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56198,7 +56198,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56217,14 +56217,14 @@ } } }, - "/aggregate/sales-channel-domain": { + "/aggregate/sales-channel": { "post": { "tags": [ - "Sales Channel Domain" + "Sales Channel" ], - "summary": "Aggregate for the Sales Channel Domain resources.", + "summary": "Aggregate for the Sales Channel resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelDomain", + "operationId": "aggregateSalesChannel", "requestBody": { "required": true, "content": { @@ -56248,7 +56248,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelDomain", + "description": "List of SalesChannel", "content": { "application/vnd.api+json": { "schema": { @@ -56262,7 +56262,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56280,7 +56280,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "$ref": "#/components/schemas/SalesChannel" } } } @@ -56297,14 +56297,14 @@ } } }, - "/sales-channel-type": { + "/sales-channel-analytics": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "List with basic information of Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelTypeList", + "summary": "List with basic information of Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalyticsList", "parameters": [ { "name": "limit", @@ -56333,7 +56333,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Type resources.", + "description": "List of Sales Channel Analytics resources.", "content": { "application/vnd.api+json": { "schema": { @@ -56352,7 +56352,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } ] @@ -56366,16 +56366,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-type?limit=25" + "example": "/sales-channel-analytics?limit=25" }, "last": { - "example": "/sales-channel-type?limit=25&page=11" + "example": "/sales-channel-analytics?limit=25&page=11" }, "next": { - "example": "/sales-channel-type?limit=25&page=4" + "example": "/sales-channel-analytics?limit=25&page=4" }, "prev": { - "example": "/sales-channel-type?limit=25&page=2" + "example": "/sales-channel-analytics?limit=25&page=2" } } } @@ -56396,7 +56396,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56411,11 +56411,11 @@ }, "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "Create a new Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSalesChannelType", + "summary": "Create a new Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "createSalesChannelAnalytics", "parameters": [ { "name": "_response", @@ -56434,14 +56434,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -56453,7 +56453,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56468,7 +56468,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56484,14 +56484,14 @@ } } }, - "/search/sales-channel-type": { + "/search/sales-channel-analytics": { "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "Search for the Sales Channel Type resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSalesChannelType", + "summary": "Search for the Sales Channel Analytics resources.", + "description": "Available since: 6.2.0.0", + "operationId": "searchSalesChannelAnalytics", "requestBody": { "required": true, "content": { @@ -56504,7 +56504,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -56518,7 +56518,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56536,7 +56536,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56553,19 +56553,19 @@ } } }, - "/sales-channel-type/{id}": { + "/sales-channel-analytics/{id}": { "get": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "Detailed information about a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSalesChannelType", + "summary": "Detailed information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "getSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -56575,7 +56575,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -56587,7 +56587,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56602,7 +56602,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56619,16 +56619,16 @@ }, "delete": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "Delete a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSalesChannelType", + "summary": "Delete a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "deleteSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -56659,16 +56659,16 @@ }, "patch": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "Partially update information about a Sales Channel Type resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSalesChannelType", + "summary": "Partially update information about a Sales Channel Analytics resource.", + "description": "Available since: 6.2.0.0", + "operationId": "updateSalesChannelAnalytics", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_type", + "description": "Identifier for the sales_channel_analytics", "required": true, "schema": { "type": "string", @@ -56686,18 +56686,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Type resource.", + "description": "Partially update information about a Sales Channel Analytics resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelType", + "description": "Detail of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -56709,7 +56709,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56724,7 +56724,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56743,14 +56743,14 @@ } } }, - "/aggregate/sales-channel-type": { + "/aggregate/sales-channel-analytics": { "post": { "tags": [ - "Sales Channel Type" + "Sales Channel Analytics" ], - "summary": "Aggregate for the Sales Channel Type resources.", + "summary": "Aggregate for the Sales Channel Analytics resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelType", + "operationId": "aggregateSalesChannelAnalytics", "requestBody": { "required": true, "content": { @@ -56774,7 +56774,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelType", + "description": "List of SalesChannelAnalytics", "content": { "application/vnd.api+json": { "schema": { @@ -56788,7 +56788,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56806,7 +56806,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelType" + "$ref": "#/components/schemas/SalesChannelAnalytics" } } } @@ -56823,14 +56823,14 @@ } } }, - "/salutation": { + "/sales-channel-domain": { "get": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "List with basic information of Salutation resources.", + "summary": "List with basic information of Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutationList", + "operationId": "getSalesChannelDomainList", "parameters": [ { "name": "limit", @@ -56859,7 +56859,7 @@ ], "responses": { "200": { - "description": "List of Salutation resources.", + "description": "List of Sales Channel Domain resources.", "content": { "application/vnd.api+json": { "schema": { @@ -56878,7 +56878,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } ] @@ -56892,16 +56892,16 @@ "type": "object", "properties": { "first": { - "example": "/salutation?limit=25" + "example": "/sales-channel-domain?limit=25" }, "last": { - "example": "/salutation?limit=25&page=11" + "example": "/sales-channel-domain?limit=25&page=11" }, "next": { - "example": "/salutation?limit=25&page=4" + "example": "/sales-channel-domain?limit=25&page=4" }, "prev": { - "example": "/salutation?limit=25&page=2" + "example": "/sales-channel-domain?limit=25&page=2" } } } @@ -56922,7 +56922,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -56937,11 +56937,11 @@ }, "post": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "Fetches salutations with a criteria obj.", - "description": "Fetches salutations with a criteria obj.", - "operationId": "createSalutation", + "summary": "Create a new Sales Channel Domain resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createSalesChannelDomain", "parameters": [ { "name": "_response", @@ -56960,14 +56960,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -56979,7 +56979,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -56994,7 +56994,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57010,14 +57010,14 @@ } } }, - "/search/salutation": { + "/search/sales-channel-domain": { "post": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "Search for the Salutation resources.", + "summary": "Search for the Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSalutation", + "operationId": "searchSalesChannelDomain", "requestBody": { "required": true, "content": { @@ -57030,7 +57030,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -57044,7 +57044,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57062,7 +57062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57079,19 +57079,19 @@ } } }, - "/salutation/{id}": { + "/sales-channel-domain/{id}": { "get": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "Detailed information about a Salutation resource.", + "summary": "Detailed information about a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSalutation", + "operationId": "getSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -57101,7 +57101,7 @@ ], "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -57113,7 +57113,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57128,7 +57128,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57145,16 +57145,16 @@ }, "delete": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "Delete a Salutation resource.", + "summary": "Delete a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSalutation", + "operationId": "deleteSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -57185,16 +57185,16 @@ }, "patch": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "Partially update information about a Salutation resource.", + "summary": "Partially update information about a Sales Channel Domain resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSalutation", + "operationId": "updateSalesChannelDomain", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the salutation", + "description": "Identifier for the sales_channel_domain", "required": true, "schema": { "type": "string", @@ -57212,18 +57212,18 @@ } ], "requestBody": { - "description": "Partially update information about a Salutation resource.", + "description": "Partially update information about a Sales Channel Domain resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } }, "responses": { "200": { - "description": "Detail of Salutation", + "description": "Detail of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -57235,7 +57235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57250,7 +57250,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57269,14 +57269,14 @@ } } }, - "/aggregate/salutation": { + "/aggregate/sales-channel-domain": { "post": { "tags": [ - "Salutation" + "Sales Channel Domain" ], - "summary": "Aggregate for the Salutation resources.", + "summary": "Aggregate for the Sales Channel Domain resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalutation", + "operationId": "aggregateSalesChannelDomain", "requestBody": { "required": true, "content": { @@ -57300,7 +57300,7 @@ }, "responses": { "200": { - "description": "List of Salutation", + "description": "List of SalesChannelDomain", "content": { "application/vnd.api+json": { "schema": { @@ -57314,7 +57314,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57332,7 +57332,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/SalesChannelDomain" } } } @@ -57349,14 +57349,14 @@ } } }, - "/scheduled-task": { + "/sales-channel-type": { "get": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "List with basic information of Scheduled Task resources.", + "summary": "List with basic information of Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTaskList", + "operationId": "getSalesChannelTypeList", "parameters": [ { "name": "limit", @@ -57385,7 +57385,7 @@ ], "responses": { "200": { - "description": "List of Scheduled Task resources.", + "description": "List of Sales Channel Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -57404,7 +57404,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } ] @@ -57418,16 +57418,16 @@ "type": "object", "properties": { "first": { - "example": "/scheduled-task?limit=25" + "example": "/sales-channel-type?limit=25" }, "last": { - "example": "/scheduled-task?limit=25&page=11" + "example": "/sales-channel-type?limit=25&page=11" }, "next": { - "example": "/scheduled-task?limit=25&page=4" + "example": "/sales-channel-type?limit=25&page=4" }, "prev": { - "example": "/scheduled-task?limit=25&page=2" + "example": "/sales-channel-type?limit=25&page=2" } } } @@ -57448,7 +57448,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57463,11 +57463,11 @@ }, "post": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "Create a new Scheduled Task resources.", + "summary": "Create a new Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "createScheduledTask", + "operationId": "createSalesChannelType", "parameters": [ { "name": "_response", @@ -57486,14 +57486,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -57505,7 +57505,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57520,7 +57520,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57536,14 +57536,14 @@ } } }, - "/search/scheduled-task": { + "/search/sales-channel-type": { "post": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "Search for the Scheduled Task resources.", + "summary": "Search for the Sales Channel Type resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchScheduledTask", + "operationId": "searchSalesChannelType", "requestBody": { "required": true, "content": { @@ -57556,7 +57556,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -57570,7 +57570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57588,7 +57588,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57605,19 +57605,19 @@ } } }, - "/scheduled-task/{id}": { + "/sales-channel-type/{id}": { "get": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "Detailed information about a Scheduled Task resource.", + "summary": "Detailed information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "getScheduledTask", + "operationId": "getSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -57627,7 +57627,7 @@ ], "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -57639,7 +57639,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57654,7 +57654,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57671,16 +57671,16 @@ }, "delete": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "Delete a Scheduled Task resource.", + "summary": "Delete a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteScheduledTask", + "operationId": "deleteSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -57711,16 +57711,16 @@ }, "patch": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "Partially update information about a Scheduled Task resource.", + "summary": "Partially update information about a Sales Channel Type resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateScheduledTask", + "operationId": "updateSalesChannelType", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the scheduled_task", + "description": "Identifier for the sales_channel_type", "required": true, "schema": { "type": "string", @@ -57738,18 +57738,18 @@ } ], "requestBody": { - "description": "Partially update information about a Scheduled Task resource.", + "description": "Partially update information about a Sales Channel Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } }, "responses": { "200": { - "description": "Detail of ScheduledTask", + "description": "Detail of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -57761,7 +57761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57776,7 +57776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57795,14 +57795,14 @@ } } }, - "/aggregate/scheduled-task": { + "/aggregate/sales-channel-type": { "post": { "tags": [ - "Scheduled Task" + "Sales Channel Type" ], - "summary": "Aggregate for the Scheduled Task resources.", + "summary": "Aggregate for the Sales Channel Type resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateScheduledTask", + "operationId": "aggregateSalesChannelType", "requestBody": { "required": true, "content": { @@ -57826,7 +57826,7 @@ }, "responses": { "200": { - "description": "List of ScheduledTask", + "description": "List of SalesChannelType", "content": { "application/vnd.api+json": { "schema": { @@ -57840,7 +57840,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57858,7 +57858,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ScheduledTask" + "$ref": "#/components/schemas/SalesChannelType" } } } @@ -57875,14 +57875,14 @@ } } }, - "/script": { + "/salutation": { "get": { "tags": [ - "Script" + "Salutation" ], - "summary": "List with basic information of Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "getScriptList", + "summary": "List with basic information of Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getSalutationList", "parameters": [ { "name": "limit", @@ -57911,7 +57911,7 @@ ], "responses": { "200": { - "description": "List of Script resources.", + "description": "List of Salutation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -57930,7 +57930,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } ] @@ -57944,16 +57944,16 @@ "type": "object", "properties": { "first": { - "example": "/script?limit=25" + "example": "/salutation?limit=25" }, "last": { - "example": "/script?limit=25&page=11" + "example": "/salutation?limit=25&page=11" }, "next": { - "example": "/script?limit=25&page=4" + "example": "/salutation?limit=25&page=4" }, "prev": { - "example": "/script?limit=25&page=2" + "example": "/salutation?limit=25&page=2" } } } @@ -57974,7 +57974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -57989,11 +57989,11 @@ }, "post": { "tags": [ - "Script" + "Salutation" ], - "summary": "Create a new Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "createScript", + "summary": "Fetches salutations with a criteria obj.", + "description": "Fetches salutations with a criteria obj.", + "operationId": "createSalutation", "parameters": [ { "name": "_response", @@ -58012,14 +58012,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -58031,7 +58031,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58046,7 +58046,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58062,14 +58062,14 @@ } } }, - "/search/script": { + "/search/salutation": { "post": { "tags": [ - "Script" + "Salutation" ], - "summary": "Search for the Script resources.", - "description": "Available since: 6.4.7.0", - "operationId": "searchScript", + "summary": "Search for the Salutation resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchSalutation", "requestBody": { "required": true, "content": { @@ -58082,7 +58082,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -58096,7 +58096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58114,7 +58114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58131,19 +58131,19 @@ } } }, - "/script/{id}": { + "/salutation/{id}": { "get": { "tags": [ - "Script" + "Salutation" ], - "summary": "Detailed information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "getScript", + "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 script", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -58153,7 +58153,7 @@ ], "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -58165,7 +58165,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58180,7 +58180,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58197,16 +58197,16 @@ }, "delete": { "tags": [ - "Script" + "Salutation" ], - "summary": "Delete a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "deleteScript", + "summary": "Delete a Salutation resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSalutation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the script", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -58237,16 +58237,16 @@ }, "patch": { "tags": [ - "Script" + "Salutation" ], - "summary": "Partially update information about a Script resource.", - "description": "Available since: 6.4.7.0", - "operationId": "updateScript", + "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 script", + "description": "Identifier for the salutation", "required": true, "schema": { "type": "string", @@ -58264,18 +58264,18 @@ } ], "requestBody": { - "description": "Partially update information about a Script resource.", + "description": "Partially update information about a Salutation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } }, "responses": { "200": { - "description": "Detail of Script", + "description": "Detail of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -58287,7 +58287,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58302,7 +58302,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58321,14 +58321,14 @@ } } }, - "/aggregate/script": { + "/aggregate/salutation": { "post": { "tags": [ - "Script" + "Salutation" ], - "summary": "Aggregate for the Script resources.", + "summary": "Aggregate for the Salutation resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateScript", + "operationId": "aggregateSalutation", "requestBody": { "required": true, "content": { @@ -58352,7 +58352,7 @@ }, "responses": { "200": { - "description": "List of Script", + "description": "List of Salutation", "content": { "application/vnd.api+json": { "schema": { @@ -58366,7 +58366,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58384,7 +58384,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Script" + "$ref": "#/components/schemas/Salutation" } } } @@ -58401,14 +58401,14 @@ } } }, - "/seo-url": { + "/scheduled-task": { "get": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "List with basic information of Seo Url resources.", + "summary": "List with basic information of Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlList", + "operationId": "getScheduledTaskList", "parameters": [ { "name": "limit", @@ -58437,7 +58437,7 @@ ], "responses": { "200": { - "description": "List of Seo Url resources.", + "description": "List of Scheduled Task resources.", "content": { "application/vnd.api+json": { "schema": { @@ -58456,7 +58456,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } ] @@ -58470,16 +58470,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url?limit=25" + "example": "/scheduled-task?limit=25" }, "last": { - "example": "/seo-url?limit=25&page=11" + "example": "/scheduled-task?limit=25&page=11" }, "next": { - "example": "/seo-url?limit=25&page=4" + "example": "/scheduled-task?limit=25&page=4" }, "prev": { - "example": "/seo-url?limit=25&page=2" + "example": "/scheduled-task?limit=25&page=2" } } } @@ -58500,7 +58500,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58515,11 +58515,11 @@ }, "post": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "Create a new Seo Url resources.", + "summary": "Create a new Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrl", + "operationId": "createScheduledTask", "parameters": [ { "name": "_response", @@ -58538,14 +58538,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -58557,7 +58557,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58572,7 +58572,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58588,14 +58588,14 @@ } } }, - "/search/seo-url": { + "/search/scheduled-task": { "post": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "Search for the Seo Url resources.", + "summary": "Search for the Scheduled Task resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrl", + "operationId": "searchScheduledTask", "requestBody": { "required": true, "content": { @@ -58608,7 +58608,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -58622,7 +58622,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58640,7 +58640,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58657,19 +58657,19 @@ } } }, - "/seo-url/{id}": { + "/scheduled-task/{id}": { "get": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "Detailed information about a Seo Url resource.", + "summary": "Detailed information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrl", + "operationId": "getScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -58679,7 +58679,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -58691,7 +58691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58706,7 +58706,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58723,16 +58723,16 @@ }, "delete": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "Delete a Seo Url resource.", + "summary": "Delete a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrl", + "operationId": "deleteScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -58763,16 +58763,16 @@ }, "patch": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "Partially update information about a Seo Url resource.", + "summary": "Partially update information about a Scheduled Task resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrl", + "operationId": "updateScheduledTask", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url", + "description": "Identifier for the scheduled_task", "required": true, "schema": { "type": "string", @@ -58790,18 +58790,18 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url resource.", + "description": "Partially update information about a Scheduled Task resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } }, "responses": { "200": { - "description": "Detail of SeoUrl", + "description": "Detail of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -58813,7 +58813,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58828,7 +58828,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58847,14 +58847,14 @@ } } }, - "/aggregate/seo-url": { + "/aggregate/scheduled-task": { "post": { "tags": [ - "Seo Url" + "Scheduled Task" ], - "summary": "Aggregate for the Seo Url resources.", + "summary": "Aggregate for the Scheduled Task resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrl", + "operationId": "aggregateScheduledTask", "requestBody": { "required": true, "content": { @@ -58878,7 +58878,7 @@ }, "responses": { "200": { - "description": "List of SeoUrl", + "description": "List of ScheduledTask", "content": { "application/vnd.api+json": { "schema": { @@ -58892,7 +58892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58910,7 +58910,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrl" + "$ref": "#/components/schemas/ScheduledTask" } } } @@ -58927,14 +58927,14 @@ } } }, - "/seo-url-template": { + "/script": { "get": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "List with basic information of Seo Url Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplateList", + "summary": "List with basic information of Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "getScriptList", "parameters": [ { "name": "limit", @@ -58963,7 +58963,7 @@ ], "responses": { "200": { - "description": "List of Seo Url Template resources.", + "description": "List of Script resources.", "content": { "application/vnd.api+json": { "schema": { @@ -58982,7 +58982,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } ] @@ -58996,16 +58996,16 @@ "type": "object", "properties": { "first": { - "example": "/seo-url-template?limit=25" + "example": "/script?limit=25" }, "last": { - "example": "/seo-url-template?limit=25&page=11" + "example": "/script?limit=25&page=11" }, "next": { - "example": "/seo-url-template?limit=25&page=4" + "example": "/script?limit=25&page=4" }, "prev": { - "example": "/seo-url-template?limit=25&page=2" + "example": "/script?limit=25&page=2" } } } @@ -59026,7 +59026,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59041,11 +59041,11 @@ }, "post": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "Create a new Seo Url Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createSeoUrlTemplate", + "summary": "Create a new Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "createScript", "parameters": [ { "name": "_response", @@ -59064,14 +59064,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -59083,7 +59083,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59098,7 +59098,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59114,14 +59114,14 @@ } } }, - "/search/seo-url-template": { + "/search/script": { "post": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "Search for the Seo Url Template resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchSeoUrlTemplate", + "summary": "Search for the Script resources.", + "description": "Available since: 6.4.7.0", + "operationId": "searchScript", "requestBody": { "required": true, "content": { @@ -59134,7 +59134,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -59148,7 +59148,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59166,7 +59166,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59183,19 +59183,19 @@ } } }, - "/seo-url-template/{id}": { + "/script/{id}": { "get": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "Detailed information about a Seo Url Template resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSeoUrlTemplate", + "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 seo_url_template", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -59205,7 +59205,7 @@ ], "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -59217,7 +59217,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59232,7 +59232,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59249,16 +59249,16 @@ }, "delete": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "Delete a Seo Url Template resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSeoUrlTemplate", + "summary": "Delete a Script resource.", + "description": "Available since: 6.4.7.0", + "operationId": "deleteScript", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the seo_url_template", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -59289,16 +59289,16 @@ }, "patch": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "Partially update information about a Seo Url Template resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSeoUrlTemplate", + "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 seo_url_template", + "description": "Identifier for the script", "required": true, "schema": { "type": "string", @@ -59316,18 +59316,18 @@ } ], "requestBody": { - "description": "Partially update information about a Seo Url Template resource.", + "description": "Partially update information about a Script resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } }, "responses": { "200": { - "description": "Detail of SeoUrlTemplate", + "description": "Detail of Script", "content": { "application/vnd.api+json": { "schema": { @@ -59339,7 +59339,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59354,7 +59354,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59373,14 +59373,14 @@ } } }, - "/aggregate/seo-url-template": { + "/aggregate/script": { "post": { "tags": [ - "Seo Url Template" + "Script" ], - "summary": "Aggregate for the Seo Url Template resources.", + "summary": "Aggregate for the Script resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrlTemplate", + "operationId": "aggregateScript", "requestBody": { "required": true, "content": { @@ -59404,7 +59404,7 @@ }, "responses": { "200": { - "description": "List of SeoUrlTemplate", + "description": "List of Script", "content": { "application/vnd.api+json": { "schema": { @@ -59418,7 +59418,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59436,7 +59436,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "$ref": "#/components/schemas/Script" } } } @@ -59453,14 +59453,14 @@ } } }, - "/shipping-method": { + "/seo-url": { "get": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "List with basic information of Shipping Method resources.", + "summary": "List with basic information of Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodList", + "operationId": "getSeoUrlList", "parameters": [ { "name": "limit", @@ -59489,7 +59489,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method resources.", + "description": "List of Seo Url resources.", "content": { "application/vnd.api+json": { "schema": { @@ -59508,7 +59508,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } ] @@ -59522,16 +59522,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method?limit=25" + "example": "/seo-url?limit=25" }, "last": { - "example": "/shipping-method?limit=25&page=11" + "example": "/seo-url?limit=25&page=11" }, "next": { - "example": "/shipping-method?limit=25&page=4" + "example": "/seo-url?limit=25&page=4" }, "prev": { - "example": "/shipping-method?limit=25&page=2" + "example": "/seo-url?limit=25&page=2" } } } @@ -59552,7 +59552,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59567,11 +59567,11 @@ }, "post": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "Create a new Shipping Method resources.", + "summary": "Create a new Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethod", + "operationId": "createSeoUrl", "parameters": [ { "name": "_response", @@ -59590,14 +59590,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -59609,7 +59609,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59624,7 +59624,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59640,14 +59640,14 @@ } } }, - "/search/shipping-method": { + "/search/seo-url": { "post": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "Search for the Shipping Method resources.", + "summary": "Search for the Seo Url resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethod", + "operationId": "searchSeoUrl", "requestBody": { "required": true, "content": { @@ -59660,7 +59660,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -59674,7 +59674,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59692,7 +59692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59709,19 +59709,19 @@ } } }, - "/shipping-method/{id}": { + "/seo-url/{id}": { "get": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "Detailed information about a Shipping Method resource.", + "summary": "Detailed information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethod", + "operationId": "getSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -59731,7 +59731,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -59743,7 +59743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59758,7 +59758,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59775,16 +59775,16 @@ }, "delete": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "Delete a Shipping Method resource.", + "summary": "Delete a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethod", + "operationId": "deleteSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -59815,16 +59815,16 @@ }, "patch": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "Partially update information about a Shipping Method resource.", + "summary": "Partially update information about a Seo Url resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethod", + "operationId": "updateSeoUrl", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method", + "description": "Identifier for the seo_url", "required": true, "schema": { "type": "string", @@ -59842,18 +59842,18 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method resource.", + "description": "Partially update information about a Seo Url resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethod", + "description": "Detail of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -59865,7 +59865,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59880,7 +59880,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59899,14 +59899,14 @@ } } }, - "/aggregate/shipping-method": { + "/aggregate/seo-url": { "post": { "tags": [ - "Shipping Method" + "Seo Url" ], - "summary": "Aggregate for the Shipping Method resources.", + "summary": "Aggregate for the Seo Url resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethod", + "operationId": "aggregateSeoUrl", "requestBody": { "required": true, "content": { @@ -59930,7 +59930,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethod", + "description": "List of SeoUrl", "content": { "application/vnd.api+json": { "schema": { @@ -59944,7 +59944,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59962,7 +59962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SeoUrl" } } } @@ -59979,14 +59979,14 @@ } } }, - "/shipping-method-price": { + "/seo-url-template": { "get": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "List with basic information of Shipping Method Price resources.", + "summary": "List with basic information of Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPriceList", + "operationId": "getSeoUrlTemplateList", "parameters": [ { "name": "limit", @@ -60015,7 +60015,7 @@ ], "responses": { "200": { - "description": "List of Shipping Method Price resources.", + "description": "List of Seo Url Template resources.", "content": { "application/vnd.api+json": { "schema": { @@ -60034,7 +60034,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } ] @@ -60048,16 +60048,16 @@ "type": "object", "properties": { "first": { - "example": "/shipping-method-price?limit=25" + "example": "/seo-url-template?limit=25" }, "last": { - "example": "/shipping-method-price?limit=25&page=11" + "example": "/seo-url-template?limit=25&page=11" }, "next": { - "example": "/shipping-method-price?limit=25&page=4" + "example": "/seo-url-template?limit=25&page=4" }, "prev": { - "example": "/shipping-method-price?limit=25&page=2" + "example": "/seo-url-template?limit=25&page=2" } } } @@ -60078,7 +60078,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60093,11 +60093,11 @@ }, "post": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "Create a new Shipping Method Price resources.", + "summary": "Create a new Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "createShippingMethodPrice", + "operationId": "createSeoUrlTemplate", "parameters": [ { "name": "_response", @@ -60116,14 +60116,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -60135,7 +60135,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60150,7 +60150,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60166,14 +60166,14 @@ } } }, - "/search/shipping-method-price": { + "/search/seo-url-template": { "post": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "Search for the Shipping Method Price resources.", + "summary": "Search for the Seo Url Template resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchShippingMethodPrice", + "operationId": "searchSeoUrlTemplate", "requestBody": { "required": true, "content": { @@ -60186,7 +60186,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -60200,7 +60200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60218,7 +60218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60235,19 +60235,19 @@ } } }, - "/shipping-method-price/{id}": { + "/seo-url-template/{id}": { "get": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "Detailed information about a Shipping Method Price resource.", + "summary": "Detailed information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "getShippingMethodPrice", + "operationId": "getSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -60257,7 +60257,7 @@ ], "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -60269,7 +60269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60284,7 +60284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60301,16 +60301,16 @@ }, "delete": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "Delete a Shipping Method Price resource.", + "summary": "Delete a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteShippingMethodPrice", + "operationId": "deleteSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -60341,16 +60341,16 @@ }, "patch": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "Partially update information about a Shipping Method Price resource.", + "summary": "Partially update information about a Seo Url Template resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateShippingMethodPrice", + "operationId": "updateSeoUrlTemplate", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the shipping_method_price", + "description": "Identifier for the seo_url_template", "required": true, "schema": { "type": "string", @@ -60368,18 +60368,18 @@ } ], "requestBody": { - "description": "Partially update information about a Shipping Method Price resource.", + "description": "Partially update information about a Seo Url Template resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } }, "responses": { "200": { - "description": "Detail of ShippingMethodPrice", + "description": "Detail of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -60391,7 +60391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60406,7 +60406,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60425,14 +60425,14 @@ } } }, - "/aggregate/shipping-method-price": { + "/aggregate/seo-url-template": { "post": { "tags": [ - "Shipping Method Price" + "Seo Url Template" ], - "summary": "Aggregate for the Shipping Method Price resources.", + "summary": "Aggregate for the Seo Url Template resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethodPrice", + "operationId": "aggregateSeoUrlTemplate", "requestBody": { "required": true, "content": { @@ -60456,7 +60456,7 @@ }, "responses": { "200": { - "description": "List of ShippingMethodPrice", + "description": "List of SeoUrlTemplate", "content": { "application/vnd.api+json": { "schema": { @@ -60470,7 +60470,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60488,7 +60488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "$ref": "#/components/schemas/SeoUrlTemplate" } } } @@ -60505,14 +60505,14 @@ } } }, - "/snippet": { + "/shipping-method": { "get": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "List with basic information of Snippet resources.", + "summary": "List with basic information of Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetList", + "operationId": "getShippingMethodList", "parameters": [ { "name": "limit", @@ -60541,7 +60541,7 @@ ], "responses": { "200": { - "description": "List of Snippet resources.", + "description": "List of Shipping Method resources.", "content": { "application/vnd.api+json": { "schema": { @@ -60560,7 +60560,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } ] @@ -60574,16 +60574,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet?limit=25" + "example": "/shipping-method?limit=25" }, "last": { - "example": "/snippet?limit=25&page=11" + "example": "/shipping-method?limit=25&page=11" }, "next": { - "example": "/snippet?limit=25&page=4" + "example": "/shipping-method?limit=25&page=4" }, "prev": { - "example": "/snippet?limit=25&page=2" + "example": "/shipping-method?limit=25&page=2" } } } @@ -60604,7 +60604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60619,11 +60619,11 @@ }, "post": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "Create a new Snippet resources.", + "summary": "Create a new Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippet", + "operationId": "createShippingMethod", "parameters": [ { "name": "_response", @@ -60642,14 +60642,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -60661,7 +60661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60676,7 +60676,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60692,14 +60692,14 @@ } } }, - "/search/snippet": { + "/search/shipping-method": { "post": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "Search for the Snippet resources.", + "summary": "Search for the Shipping Method resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSnippet", + "operationId": "searchShippingMethod", "requestBody": { "required": true, "content": { @@ -60712,7 +60712,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -60726,7 +60726,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60744,7 +60744,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60761,19 +60761,19 @@ } } }, - "/snippet/{id}": { + "/shipping-method/{id}": { "get": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "Detailed information about a Snippet resource.", + "summary": "Detailed information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", + "operationId": "getShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -60783,7 +60783,7 @@ ], "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -60795,7 +60795,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60810,7 +60810,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60827,16 +60827,16 @@ }, "delete": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "Delete a Snippet resource.", + "summary": "Delete a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", + "operationId": "deleteShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -60867,16 +60867,16 @@ }, "patch": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "Partially update information about a Snippet resource.", + "summary": "Partially update information about a Shipping Method resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", + "operationId": "updateShippingMethod", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet", + "description": "Identifier for the shipping_method", "required": true, "schema": { "type": "string", @@ -60894,18 +60894,18 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet resource.", + "description": "Partially update information about a Shipping Method resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } }, "responses": { "200": { - "description": "Detail of Snippet", + "description": "Detail of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -60917,7 +60917,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60932,7 +60932,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -60951,14 +60951,14 @@ } } }, - "/aggregate/snippet": { + "/aggregate/shipping-method": { "post": { "tags": [ - "Snippet" + "Shipping Method" ], - "summary": "Aggregate for the Snippet resources.", + "summary": "Aggregate for the Shipping Method resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippet", + "operationId": "aggregateShippingMethod", "requestBody": { "required": true, "content": { @@ -60982,7 +60982,7 @@ }, "responses": { "200": { - "description": "List of Snippet", + "description": "List of ShippingMethod", "content": { "application/vnd.api+json": { "schema": { @@ -60996,7 +60996,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -61014,7 +61014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Snippet" + "$ref": "#/components/schemas/ShippingMethod" } } } @@ -61031,14 +61031,14 @@ } } }, - "/snippet-set": { + "/shipping-method-price": { "get": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "List with basic information of Snippet Set resources.", + "summary": "List with basic information of Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSetList", + "operationId": "getShippingMethodPriceList", "parameters": [ { "name": "limit", @@ -61067,7 +61067,7 @@ ], "responses": { "200": { - "description": "List of Snippet Set resources.", + "description": "List of Shipping Method Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61086,7 +61086,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } ] @@ -61100,16 +61100,16 @@ "type": "object", "properties": { "first": { - "example": "/snippet-set?limit=25" + "example": "/shipping-method-price?limit=25" }, "last": { - "example": "/snippet-set?limit=25&page=11" + "example": "/shipping-method-price?limit=25&page=11" }, "next": { - "example": "/snippet-set?limit=25&page=4" + "example": "/shipping-method-price?limit=25&page=4" }, "prev": { - "example": "/snippet-set?limit=25&page=2" + "example": "/shipping-method-price?limit=25&page=2" } } } @@ -61130,7 +61130,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61145,11 +61145,11 @@ }, "post": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "Create a new Snippet Set resources.", + "summary": "Create a new Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSnippetSet", + "operationId": "createShippingMethodPrice", "parameters": [ { "name": "_response", @@ -61168,14 +61168,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -61187,7 +61187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61202,7 +61202,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61218,14 +61218,14 @@ } } }, - "/search/snippet-set": { + "/search/shipping-method-price": { "post": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "Search for the Snippet Set resources.", + "summary": "Search for the Shipping Method Price resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSnippetSet", + "operationId": "searchShippingMethodPrice", "requestBody": { "required": true, "content": { @@ -61238,7 +61238,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -61252,7 +61252,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61270,7 +61270,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61287,19 +61287,19 @@ } } }, - "/snippet-set/{id}": { + "/shipping-method-price/{id}": { "get": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "Detailed information about a Snippet Set resource.", + "summary": "Detailed information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSnippetSet", + "operationId": "getShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -61309,7 +61309,7 @@ ], "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -61321,7 +61321,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61336,7 +61336,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61353,16 +61353,16 @@ }, "delete": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "Delete a Snippet Set resource.", + "summary": "Delete a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippetSet", + "operationId": "deleteShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -61393,16 +61393,16 @@ }, "patch": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "Partially update information about a Snippet Set resource.", + "summary": "Partially update information about a Shipping Method Price resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSnippetSet", + "operationId": "updateShippingMethodPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the snippet_set", + "description": "Identifier for the shipping_method_price", "required": true, "schema": { "type": "string", @@ -61420,18 +61420,18 @@ } ], "requestBody": { - "description": "Partially update information about a Snippet Set resource.", + "description": "Partially update information about a Shipping Method Price resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } }, "responses": { "200": { - "description": "Detail of SnippetSet", + "description": "Detail of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -61443,7 +61443,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61458,7 +61458,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61477,14 +61477,14 @@ } } }, - "/aggregate/snippet-set": { + "/aggregate/shipping-method-price": { "post": { "tags": [ - "Snippet Set" + "Shipping Method Price" ], - "summary": "Aggregate for the Snippet Set resources.", + "summary": "Aggregate for the Shipping Method Price resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippetSet", + "operationId": "aggregateShippingMethodPrice", "requestBody": { "required": true, "content": { @@ -61508,7 +61508,7 @@ }, "responses": { "200": { - "description": "List of SnippetSet", + "description": "List of ShippingMethodPrice", "content": { "application/vnd.api+json": { "schema": { @@ -61522,7 +61522,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61540,7 +61540,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SnippetSet" + "$ref": "#/components/schemas/ShippingMethodPrice" } } } @@ -61557,14 +61557,14 @@ } } }, - "/state-machine": { + "/snippet": { "get": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "List with basic information of State Machine resources.", + "summary": "List with basic information of Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineList", + "operationId": "getSnippetList", "parameters": [ { "name": "limit", @@ -61593,7 +61593,7 @@ ], "responses": { "200": { - "description": "List of State Machine resources.", + "description": "List of Snippet resources.", "content": { "application/vnd.api+json": { "schema": { @@ -61612,7 +61612,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } ] @@ -61626,16 +61626,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine?limit=25" + "example": "/snippet?limit=25" }, "last": { - "example": "/state-machine?limit=25&page=11" + "example": "/snippet?limit=25&page=11" }, "next": { - "example": "/state-machine?limit=25&page=4" + "example": "/snippet?limit=25&page=4" }, "prev": { - "example": "/state-machine?limit=25&page=2" + "example": "/snippet?limit=25&page=2" } } } @@ -61656,7 +61656,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61671,11 +61671,11 @@ }, "post": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "Create a new State Machine resources.", + "summary": "Create a new Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachine", + "operationId": "createSnippet", "parameters": [ { "name": "_response", @@ -61694,14 +61694,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -61713,7 +61713,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61728,7 +61728,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61744,14 +61744,14 @@ } } }, - "/search/state-machine": { + "/search/snippet": { "post": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "Search for the State Machine resources.", + "summary": "Search for the Snippet resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachine", + "operationId": "searchSnippet", "requestBody": { "required": true, "content": { @@ -61764,7 +61764,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -61778,7 +61778,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61796,7 +61796,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61813,19 +61813,19 @@ } } }, - "/state-machine/{id}": { + "/snippet/{id}": { "get": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "Detailed information about a State Machine resource.", + "summary": "Detailed information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachine", + "operationId": "getSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -61835,7 +61835,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -61847,7 +61847,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61862,7 +61862,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61879,16 +61879,16 @@ }, "delete": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "Delete a State Machine resource.", + "summary": "Delete a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachine", + "operationId": "deleteSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -61919,16 +61919,16 @@ }, "patch": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "Partially update information about a State Machine resource.", + "summary": "Partially update information about a Snippet resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachine", + "operationId": "updateSnippet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine", + "description": "Identifier for the snippet", "required": true, "schema": { "type": "string", @@ -61946,18 +61946,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine resource.", + "description": "Partially update information about a Snippet resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } }, "responses": { "200": { - "description": "Detail of StateMachine", + "description": "Detail of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -61969,7 +61969,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -61984,7 +61984,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -62003,14 +62003,14 @@ } } }, - "/aggregate/state-machine": { + "/aggregate/snippet": { "post": { "tags": [ - "State Machine" + "Snippet" ], - "summary": "Aggregate for the State Machine resources.", + "summary": "Aggregate for the Snippet resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachine", + "operationId": "aggregateSnippet", "requestBody": { "required": true, "content": { @@ -62034,7 +62034,7 @@ }, "responses": { "200": { - "description": "List of StateMachine", + "description": "List of Snippet", "content": { "application/vnd.api+json": { "schema": { @@ -62048,7 +62048,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -62066,7 +62066,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachine" + "$ref": "#/components/schemas/Snippet" } } } @@ -62083,14 +62083,14 @@ } } }, - "/state-machine-history": { + "/snippet-set": { "get": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "List with basic information of State Machine History resources.", + "summary": "List with basic information of Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistoryList", + "operationId": "getSnippetSetList", "parameters": [ { "name": "limit", @@ -62119,7 +62119,7 @@ ], "responses": { "200": { - "description": "List of State Machine History resources.", + "description": "List of Snippet Set resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62138,7 +62138,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } ] @@ -62152,16 +62152,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-history?limit=25" + "example": "/snippet-set?limit=25" }, "last": { - "example": "/state-machine-history?limit=25&page=11" + "example": "/snippet-set?limit=25&page=11" }, "next": { - "example": "/state-machine-history?limit=25&page=4" + "example": "/snippet-set?limit=25&page=4" }, "prev": { - "example": "/state-machine-history?limit=25&page=2" + "example": "/snippet-set?limit=25&page=2" } } } @@ -62182,7 +62182,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62197,11 +62197,11 @@ }, "post": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "Create a new State Machine History resources.", + "summary": "Create a new Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineHistory", + "operationId": "createSnippetSet", "parameters": [ { "name": "_response", @@ -62220,14 +62220,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -62239,7 +62239,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62254,7 +62254,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62270,14 +62270,14 @@ } } }, - "/search/state-machine-history": { + "/search/snippet-set": { "post": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "Search for the State Machine History resources.", + "summary": "Search for the Snippet Set resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineHistory", + "operationId": "searchSnippetSet", "requestBody": { "required": true, "content": { @@ -62290,7 +62290,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -62304,7 +62304,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62322,7 +62322,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62339,19 +62339,19 @@ } } }, - "/state-machine-history/{id}": { + "/snippet-set/{id}": { "get": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "Detailed information about a State Machine History resource.", + "summary": "Detailed information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", + "operationId": "getSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -62361,7 +62361,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -62373,7 +62373,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62388,7 +62388,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62405,16 +62405,16 @@ }, "delete": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "Delete a State Machine History resource.", + "summary": "Delete a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", + "operationId": "deleteSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -62445,16 +62445,16 @@ }, "patch": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "Partially update information about a State Machine History resource.", + "summary": "Partially update information about a Snippet Set resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", + "operationId": "updateSnippetSet", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_history", + "description": "Identifier for the snippet_set", "required": true, "schema": { "type": "string", @@ -62472,18 +62472,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine History resource.", + "description": "Partially update information about a Snippet Set resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } }, "responses": { "200": { - "description": "Detail of StateMachineHistory", + "description": "Detail of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -62495,7 +62495,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62510,7 +62510,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62529,14 +62529,14 @@ } } }, - "/aggregate/state-machine-history": { + "/aggregate/snippet-set": { "post": { "tags": [ - "State Machine History" + "Snippet Set" ], - "summary": "Aggregate for the State Machine History resources.", + "summary": "Aggregate for the Snippet Set resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineHistory", + "operationId": "aggregateSnippetSet", "requestBody": { "required": true, "content": { @@ -62560,7 +62560,7 @@ }, "responses": { "200": { - "description": "List of StateMachineHistory", + "description": "List of SnippetSet", "content": { "application/vnd.api+json": { "schema": { @@ -62574,7 +62574,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62592,7 +62592,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineHistory" + "$ref": "#/components/schemas/SnippetSet" } } } @@ -62609,14 +62609,14 @@ } } }, - "/state-machine-state": { + "/state-machine": { "get": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "List with basic information of State Machine State resources.", + "summary": "List with basic information of State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineStateList", + "operationId": "getStateMachineList", "parameters": [ { "name": "limit", @@ -62645,7 +62645,7 @@ ], "responses": { "200": { - "description": "List of State Machine State resources.", + "description": "List of State Machine resources.", "content": { "application/vnd.api+json": { "schema": { @@ -62664,7 +62664,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } ] @@ -62678,16 +62678,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-state?limit=25" + "example": "/state-machine?limit=25" }, "last": { - "example": "/state-machine-state?limit=25&page=11" + "example": "/state-machine?limit=25&page=11" }, "next": { - "example": "/state-machine-state?limit=25&page=4" + "example": "/state-machine?limit=25&page=4" }, "prev": { - "example": "/state-machine-state?limit=25&page=2" + "example": "/state-machine?limit=25&page=2" } } } @@ -62708,7 +62708,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62723,11 +62723,11 @@ }, "post": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "Create a new State Machine State resources.", + "summary": "Create a new State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineState", + "operationId": "createStateMachine", "parameters": [ { "name": "_response", @@ -62746,14 +62746,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -62765,7 +62765,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62780,7 +62780,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62796,14 +62796,14 @@ } } }, - "/search/state-machine-state": { + "/search/state-machine": { "post": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "Search for the State Machine State resources.", + "summary": "Search for the State Machine resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineState", + "operationId": "searchStateMachine", "requestBody": { "required": true, "content": { @@ -62816,7 +62816,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -62830,7 +62830,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62848,7 +62848,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62865,19 +62865,19 @@ } } }, - "/state-machine-state/{id}": { + "/state-machine/{id}": { "get": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "Detailed information about a State Machine State resource.", + "summary": "Detailed information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineState", + "operationId": "getStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -62887,7 +62887,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -62899,7 +62899,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62914,7 +62914,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -62931,16 +62931,16 @@ }, "delete": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "Delete a State Machine State resource.", + "summary": "Delete a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineState", + "operationId": "deleteStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -62971,16 +62971,16 @@ }, "patch": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "Partially update information about a State Machine State resource.", + "summary": "Partially update information about a State Machine resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineState", + "operationId": "updateStateMachine", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_state", + "description": "Identifier for the state_machine", "required": true, "schema": { "type": "string", @@ -62998,18 +62998,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine State resource.", + "description": "Partially update information about a State Machine resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } }, "responses": { "200": { - "description": "Detail of StateMachineState", + "description": "Detail of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -63021,7 +63021,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -63036,7 +63036,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -63055,14 +63055,14 @@ } } }, - "/aggregate/state-machine-state": { + "/aggregate/state-machine": { "post": { "tags": [ - "State Machine State" + "State Machine" ], - "summary": "Aggregate for the State Machine State resources.", + "summary": "Aggregate for the State Machine resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineState", + "operationId": "aggregateStateMachine", "requestBody": { "required": true, "content": { @@ -63086,7 +63086,7 @@ }, "responses": { "200": { - "description": "List of StateMachineState", + "description": "List of StateMachine", "content": { "application/vnd.api+json": { "schema": { @@ -63100,7 +63100,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -63118,7 +63118,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachine" } } } @@ -63135,14 +63135,14 @@ } } }, - "/state-machine-transition": { + "/state-machine-history": { "get": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "List with basic information of State Machine Transition resources.", + "summary": "List with basic information of State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransitionList", + "operationId": "getStateMachineHistoryList", "parameters": [ { "name": "limit", @@ -63171,7 +63171,7 @@ ], "responses": { "200": { - "description": "List of State Machine Transition resources.", + "description": "List of State Machine History resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63190,7 +63190,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } ] @@ -63204,16 +63204,16 @@ "type": "object", "properties": { "first": { - "example": "/state-machine-transition?limit=25" + "example": "/state-machine-history?limit=25" }, "last": { - "example": "/state-machine-transition?limit=25&page=11" + "example": "/state-machine-history?limit=25&page=11" }, "next": { - "example": "/state-machine-transition?limit=25&page=4" + "example": "/state-machine-history?limit=25&page=4" }, "prev": { - "example": "/state-machine-transition?limit=25&page=2" + "example": "/state-machine-history?limit=25&page=2" } } } @@ -63234,7 +63234,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63249,11 +63249,11 @@ }, "post": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "Create a new State Machine Transition resources.", + "summary": "Create a new State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "createStateMachineTransition", + "operationId": "createStateMachineHistory", "parameters": [ { "name": "_response", @@ -63272,14 +63272,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -63291,7 +63291,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63306,7 +63306,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63322,14 +63322,14 @@ } } }, - "/search/state-machine-transition": { + "/search/state-machine-history": { "post": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "Search for the State Machine Transition resources.", + "summary": "Search for the State Machine History resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchStateMachineTransition", + "operationId": "searchStateMachineHistory", "requestBody": { "required": true, "content": { @@ -63342,7 +63342,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -63356,7 +63356,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63374,7 +63374,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63391,19 +63391,19 @@ } } }, - "/state-machine-transition/{id}": { + "/state-machine-history/{id}": { "get": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "Detailed information about a State Machine Transition resource.", + "summary": "Detailed information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineTransition", + "operationId": "getStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -63413,7 +63413,7 @@ ], "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -63425,7 +63425,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63440,7 +63440,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63457,16 +63457,16 @@ }, "delete": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "Delete a State Machine Transition resource.", + "summary": "Delete a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineTransition", + "operationId": "deleteStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -63497,16 +63497,16 @@ }, "patch": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "Partially update information about a State Machine Transition resource.", + "summary": "Partially update information about a State Machine History resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineTransition", + "operationId": "updateStateMachineHistory", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the state_machine_transition", + "description": "Identifier for the state_machine_history", "required": true, "schema": { "type": "string", @@ -63524,18 +63524,18 @@ } ], "requestBody": { - "description": "Partially update information about a State Machine Transition resource.", + "description": "Partially update information about a State Machine History resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } }, "responses": { "200": { - "description": "Detail of StateMachineTransition", + "description": "Detail of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -63547,7 +63547,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63562,7 +63562,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63581,14 +63581,14 @@ } } }, - "/aggregate/state-machine-transition": { + "/aggregate/state-machine-history": { "post": { "tags": [ - "State Machine Transition" + "State Machine History" ], - "summary": "Aggregate for the State Machine Transition resources.", + "summary": "Aggregate for the State Machine History resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineTransition", + "operationId": "aggregateStateMachineHistory", "requestBody": { "required": true, "content": { @@ -63612,7 +63612,7 @@ }, "responses": { "200": { - "description": "List of StateMachineTransition", + "description": "List of StateMachineHistory", "content": { "application/vnd.api+json": { "schema": { @@ -63626,7 +63626,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63644,7 +63644,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/StateMachineTransition" + "$ref": "#/components/schemas/StateMachineHistory" } } } @@ -63661,14 +63661,14 @@ } } }, - "/system-config": { + "/state-machine-state": { "get": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "List with basic information of System Config resources.", + "summary": "List with basic information of State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfigList", + "operationId": "getStateMachineStateList", "parameters": [ { "name": "limit", @@ -63697,7 +63697,7 @@ ], "responses": { "200": { - "description": "List of System Config resources.", + "description": "List of State Machine State resources.", "content": { "application/vnd.api+json": { "schema": { @@ -63716,7 +63716,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } ] @@ -63730,16 +63730,16 @@ "type": "object", "properties": { "first": { - "example": "/system-config?limit=25" + "example": "/state-machine-state?limit=25" }, "last": { - "example": "/system-config?limit=25&page=11" + "example": "/state-machine-state?limit=25&page=11" }, "next": { - "example": "/system-config?limit=25&page=4" + "example": "/state-machine-state?limit=25&page=4" }, "prev": { - "example": "/system-config?limit=25&page=2" + "example": "/state-machine-state?limit=25&page=2" } } } @@ -63760,7 +63760,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63775,11 +63775,11 @@ }, "post": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "Create a new System Config resources.", + "summary": "Create a new State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "createSystemConfig", + "operationId": "createStateMachineState", "parameters": [ { "name": "_response", @@ -63798,14 +63798,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -63817,7 +63817,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63832,7 +63832,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63848,14 +63848,14 @@ } } }, - "/search/system-config": { + "/search/state-machine-state": { "post": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "Search for the System Config resources.", + "summary": "Search for the State Machine State resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchSystemConfig", + "operationId": "searchStateMachineState", "requestBody": { "required": true, "content": { @@ -63868,7 +63868,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -63882,7 +63882,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63900,7 +63900,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63917,19 +63917,19 @@ } } }, - "/system-config/{id}": { + "/state-machine-state/{id}": { "get": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "Detailed information about a System Config resource.", + "summary": "Detailed information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", + "operationId": "getStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -63939,7 +63939,7 @@ ], "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -63951,7 +63951,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63966,7 +63966,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -63983,16 +63983,16 @@ }, "delete": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "Delete a System Config resource.", + "summary": "Delete a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", + "operationId": "deleteStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -64023,16 +64023,16 @@ }, "patch": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "Partially update information about a System Config resource.", + "summary": "Partially update information about a State Machine State resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", + "operationId": "updateStateMachineState", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the system_config", + "description": "Identifier for the state_machine_state", "required": true, "schema": { "type": "string", @@ -64050,18 +64050,18 @@ } ], "requestBody": { - "description": "Partially update information about a System Config resource.", + "description": "Partially update information about a State Machine State resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } }, "responses": { "200": { - "description": "Detail of SystemConfig", + "description": "Detail of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -64073,7 +64073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -64088,7 +64088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -64107,14 +64107,14 @@ } } }, - "/aggregate/system-config": { + "/aggregate/state-machine-state": { "post": { "tags": [ - "System Config" + "State Machine State" ], - "summary": "Aggregate for the System Config resources.", + "summary": "Aggregate for the State Machine State resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSystemConfig", + "operationId": "aggregateStateMachineState", "requestBody": { "required": true, "content": { @@ -64138,7 +64138,7 @@ }, "responses": { "200": { - "description": "List of SystemConfig", + "description": "List of StateMachineState", "content": { "application/vnd.api+json": { "schema": { @@ -64152,7 +64152,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -64170,7 +64170,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SystemConfig" + "$ref": "#/components/schemas/StateMachineState" } } } @@ -64187,14 +64187,14 @@ } } }, - "/tag": { + "/state-machine-transition": { "get": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "List with basic information of Tag resources.", + "summary": "List with basic information of State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTagList", + "operationId": "getStateMachineTransitionList", "parameters": [ { "name": "limit", @@ -64223,7 +64223,7 @@ ], "responses": { "200": { - "description": "List of Tag resources.", + "description": "List of State Machine Transition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -64242,7 +64242,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } ] @@ -64256,16 +64256,16 @@ "type": "object", "properties": { "first": { - "example": "/tag?limit=25" + "example": "/state-machine-transition?limit=25" }, "last": { - "example": "/tag?limit=25&page=11" + "example": "/state-machine-transition?limit=25&page=11" }, "next": { - "example": "/tag?limit=25&page=4" + "example": "/state-machine-transition?limit=25&page=4" }, "prev": { - "example": "/tag?limit=25&page=2" + "example": "/state-machine-transition?limit=25&page=2" } } } @@ -64286,7 +64286,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64301,11 +64301,11 @@ }, "post": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "Create a new Tag resources.", + "summary": "Create a new State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTag", + "operationId": "createStateMachineTransition", "parameters": [ { "name": "_response", @@ -64324,14 +64324,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -64343,7 +64343,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64358,7 +64358,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64374,14 +64374,14 @@ } } }, - "/search/tag": { + "/search/state-machine-transition": { "post": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "Search for the Tag resources.", + "summary": "Search for the State Machine Transition resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchTag", + "operationId": "searchStateMachineTransition", "requestBody": { "required": true, "content": { @@ -64394,7 +64394,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -64408,7 +64408,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64426,7 +64426,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64443,19 +64443,19 @@ } } }, - "/tag/{id}": { + "/state-machine-transition/{id}": { "get": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "Detailed information about a Tag resource.", + "summary": "Detailed information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTag", + "operationId": "getStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -64465,7 +64465,7 @@ ], "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -64477,7 +64477,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64492,7 +64492,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64509,16 +64509,16 @@ }, "delete": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "Delete a Tag resource.", + "summary": "Delete a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTag", + "operationId": "deleteStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -64549,16 +64549,16 @@ }, "patch": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "Partially update information about a Tag resource.", + "summary": "Partially update information about a State Machine Transition resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTag", + "operationId": "updateStateMachineTransition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tag", + "description": "Identifier for the state_machine_transition", "required": true, "schema": { "type": "string", @@ -64576,18 +64576,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tag resource.", + "description": "Partially update information about a State Machine Transition resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } }, "responses": { "200": { - "description": "Detail of Tag", + "description": "Detail of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -64599,7 +64599,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64614,7 +64614,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64633,14 +64633,14 @@ } } }, - "/aggregate/tag": { + "/aggregate/state-machine-transition": { "post": { "tags": [ - "Tag" + "State Machine Transition" ], - "summary": "Aggregate for the Tag resources.", + "summary": "Aggregate for the State Machine Transition resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTag", + "operationId": "aggregateStateMachineTransition", "requestBody": { "required": true, "content": { @@ -64664,7 +64664,7 @@ }, "responses": { "200": { - "description": "List of Tag", + "description": "List of StateMachineTransition", "content": { "application/vnd.api+json": { "schema": { @@ -64678,7 +64678,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64696,7 +64696,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/StateMachineTransition" } } } @@ -64713,14 +64713,14 @@ } } }, - "/tax": { + "/system-config": { "get": { "tags": [ - "Tax" + "System Config" ], - "summary": "List with basic information of Tax resources.", + "summary": "List with basic information of System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "getTaxList", + "operationId": "getSystemConfigList", "parameters": [ { "name": "limit", @@ -64749,7 +64749,7 @@ ], "responses": { "200": { - "description": "List of Tax resources.", + "description": "List of System Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -64768,7 +64768,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } ] @@ -64782,16 +64782,16 @@ "type": "object", "properties": { "first": { - "example": "/tax?limit=25" + "example": "/system-config?limit=25" }, "last": { - "example": "/tax?limit=25&page=11" + "example": "/system-config?limit=25&page=11" }, "next": { - "example": "/tax?limit=25&page=4" + "example": "/system-config?limit=25&page=4" }, "prev": { - "example": "/tax?limit=25&page=2" + "example": "/system-config?limit=25&page=2" } } } @@ -64812,7 +64812,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -64827,11 +64827,11 @@ }, "post": { "tags": [ - "Tax" + "System Config" ], - "summary": "Create a new Tax resources.", + "summary": "Create a new System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "createTax", + "operationId": "createSystemConfig", "parameters": [ { "name": "_response", @@ -64850,14 +64850,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -64869,7 +64869,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -64884,7 +64884,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -64900,14 +64900,14 @@ } } }, - "/search/tax": { + "/search/system-config": { "post": { "tags": [ - "Tax" + "System Config" ], - "summary": "Search for the Tax resources.", + "summary": "Search for the System Config resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchTax", + "operationId": "searchSystemConfig", "requestBody": { "required": true, "content": { @@ -64920,7 +64920,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -64934,7 +64934,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -64952,7 +64952,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -64969,19 +64969,19 @@ } } }, - "/tax/{id}": { + "/system-config/{id}": { "get": { "tags": [ - "Tax" + "System Config" ], - "summary": "Detailed information about a Tax resource.", + "summary": "Detailed information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "getTax", + "operationId": "getSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -64991,7 +64991,7 @@ ], "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -65003,7 +65003,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -65018,7 +65018,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -65035,16 +65035,16 @@ }, "delete": { "tags": [ - "Tax" + "System Config" ], - "summary": "Delete a Tax resource.", + "summary": "Delete a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteTax", + "operationId": "deleteSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -65075,16 +65075,16 @@ }, "patch": { "tags": [ - "Tax" + "System Config" ], - "summary": "Partially update information about a Tax resource.", + "summary": "Partially update information about a System Config resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateTax", + "operationId": "updateSystemConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax", + "description": "Identifier for the system_config", "required": true, "schema": { "type": "string", @@ -65102,18 +65102,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax resource.", + "description": "Partially update information about a System Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } }, "responses": { "200": { - "description": "Detail of Tax", + "description": "Detail of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -65125,7 +65125,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -65140,7 +65140,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -65159,14 +65159,14 @@ } } }, - "/aggregate/tax": { + "/aggregate/system-config": { "post": { "tags": [ - "Tax" + "System Config" ], - "summary": "Aggregate for the Tax resources.", + "summary": "Aggregate for the System Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTax", + "operationId": "aggregateSystemConfig", "requestBody": { "required": true, "content": { @@ -65190,7 +65190,7 @@ }, "responses": { "200": { - "description": "List of Tax", + "description": "List of SystemConfig", "content": { "application/vnd.api+json": { "schema": { @@ -65204,7 +65204,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -65222,7 +65222,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/SystemConfig" } } } @@ -65239,14 +65239,14 @@ } } }, - "/tax-provider": { + "/tag": { "get": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "List with basic information of Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProviderList", + "summary": "List with basic information of Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getTagList", "parameters": [ { "name": "limit", @@ -65275,7 +65275,7 @@ ], "responses": { "200": { - "description": "List of Tax Provider resources.", + "description": "List of Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65294,7 +65294,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } ] @@ -65308,16 +65308,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-provider?limit=25" + "example": "/tag?limit=25" }, "last": { - "example": "/tax-provider?limit=25&page=11" + "example": "/tag?limit=25&page=11" }, "next": { - "example": "/tax-provider?limit=25&page=4" + "example": "/tag?limit=25&page=4" }, "prev": { - "example": "/tax-provider?limit=25&page=2" + "example": "/tag?limit=25&page=2" } } } @@ -65338,7 +65338,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65353,11 +65353,11 @@ }, "post": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "Create a new Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "createTaxProvider", + "summary": "Create a new Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTag", "parameters": [ { "name": "_response", @@ -65376,14 +65376,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -65395,7 +65395,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65410,7 +65410,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65426,14 +65426,14 @@ } } }, - "/search/tax-provider": { + "/search/tag": { "post": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "Search for the Tax Provider resources.", - "description": "Available since: 6.5.0.0", - "operationId": "searchTaxProvider", + "summary": "Search for the Tag resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTag", "requestBody": { "required": true, "content": { @@ -65446,7 +65446,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -65460,7 +65460,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65478,7 +65478,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65495,19 +65495,19 @@ } } }, - "/tax-provider/{id}": { + "/tag/{id}": { "get": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "Detailed information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "getTaxProvider", + "summary": "Detailed information about a Tag resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -65517,7 +65517,7 @@ ], "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -65529,7 +65529,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65544,7 +65544,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65561,16 +65561,16 @@ }, "delete": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", + "summary": "Delete a Tag resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -65601,16 +65601,16 @@ }, "patch": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "Partially update information about a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "updateTaxProvider", + "summary": "Partially update information about a Tag resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_provider", + "description": "Identifier for the tag", "required": true, "schema": { "type": "string", @@ -65628,18 +65628,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Provider resource.", + "description": "Partially update information about a Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } }, "responses": { "200": { - "description": "Detail of TaxProvider", + "description": "Detail of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -65651,7 +65651,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65666,7 +65666,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65685,14 +65685,14 @@ } } }, - "/aggregate/tax-provider": { + "/aggregate/tag": { "post": { "tags": [ - "Tax Provider" + "Tag" ], - "summary": "Aggregate for the Tax Provider resources.", + "summary": "Aggregate for the Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxProvider", + "operationId": "aggregateTag", "requestBody": { "required": true, "content": { @@ -65716,7 +65716,7 @@ }, "responses": { "200": { - "description": "List of TaxProvider", + "description": "List of Tag", "content": { "application/vnd.api+json": { "schema": { @@ -65730,7 +65730,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65748,7 +65748,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxProvider" + "$ref": "#/components/schemas/Tag" } } } @@ -65765,14 +65765,14 @@ } } }, - "/tax-rule": { + "/tax": { "get": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "List with basic information of Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleList", + "summary": "List with basic information of Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getTaxList", "parameters": [ { "name": "limit", @@ -65801,7 +65801,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule resources.", + "description": "List of Tax resources.", "content": { "application/vnd.api+json": { "schema": { @@ -65820,7 +65820,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } ] @@ -65834,16 +65834,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule?limit=25" + "example": "/tax?limit=25" }, "last": { - "example": "/tax-rule?limit=25&page=11" + "example": "/tax?limit=25&page=11" }, "next": { - "example": "/tax-rule?limit=25&page=4" + "example": "/tax?limit=25&page=4" }, "prev": { - "example": "/tax-rule?limit=25&page=2" + "example": "/tax?limit=25&page=2" } } } @@ -65864,7 +65864,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -65879,11 +65879,11 @@ }, "post": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "Create a new Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRule", + "summary": "Create a new Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createTax", "parameters": [ { "name": "_response", @@ -65902,14 +65902,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -65921,7 +65921,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -65936,7 +65936,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -65952,14 +65952,14 @@ } } }, - "/search/tax-rule": { + "/search/tax": { "post": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "Search for the Tax Rule resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRule", + "summary": "Search for the Tax resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchTax", "requestBody": { "required": true, "content": { @@ -65972,7 +65972,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -65986,7 +65986,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66004,7 +66004,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66021,19 +66021,19 @@ } } }, - "/tax-rule/{id}": { + "/tax/{id}": { "get": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "Detailed information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRule", + "summary": "Detailed information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -66043,7 +66043,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -66055,7 +66055,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66070,7 +66070,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66087,16 +66087,16 @@ }, "delete": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "Delete a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRule", + "summary": "Delete a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -66127,16 +66127,16 @@ }, "patch": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "Partially update information about a Tax Rule resource.", - "description": "Available since: 6.1.0.0", - "operationId": "updateTaxRule", + "summary": "Partially update information about a Tax resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateTax", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule", + "description": "Identifier for the tax", "required": true, "schema": { "type": "string", @@ -66154,18 +66154,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule resource.", + "description": "Partially update information about a Tax resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } }, "responses": { "200": { - "description": "Detail of TaxRule", + "description": "Detail of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -66177,7 +66177,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66192,7 +66192,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66211,14 +66211,14 @@ } } }, - "/aggregate/tax-rule": { + "/aggregate/tax": { "post": { "tags": [ - "Tax Rule" + "Tax" ], - "summary": "Aggregate for the Tax Rule resources.", + "summary": "Aggregate for the Tax resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRule", + "operationId": "aggregateTax", "requestBody": { "required": true, "content": { @@ -66242,7 +66242,7 @@ }, "responses": { "200": { - "description": "List of TaxRule", + "description": "List of Tax", "content": { "application/vnd.api+json": { "schema": { @@ -66256,7 +66256,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66274,7 +66274,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRule" + "$ref": "#/components/schemas/Tax" } } } @@ -66291,14 +66291,14 @@ } } }, - "/tax-rule-type": { + "/tax-provider": { "get": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "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 Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "getTaxProviderList", "parameters": [ { "name": "limit", @@ -66327,7 +66327,7 @@ ], "responses": { "200": { - "description": "List of Tax Rule Type resources.", + "description": "List of Tax Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66346,7 +66346,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } ] @@ -66360,16 +66360,16 @@ "type": "object", "properties": { "first": { - "example": "/tax-rule-type?limit=25" + "example": "/tax-provider?limit=25" }, "last": { - "example": "/tax-rule-type?limit=25&page=11" + "example": "/tax-provider?limit=25&page=11" }, "next": { - "example": "/tax-rule-type?limit=25&page=4" + "example": "/tax-provider?limit=25&page=4" }, "prev": { - "example": "/tax-rule-type?limit=25&page=2" + "example": "/tax-provider?limit=25&page=2" } } } @@ -66390,7 +66390,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66405,11 +66405,11 @@ }, "post": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "summary": "Create a new Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "createTaxRuleType", + "summary": "Create a new Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "createTaxProvider", "parameters": [ { "name": "_response", @@ -66428,14 +66428,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -66447,7 +66447,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66462,7 +66462,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66478,14 +66478,14 @@ } } }, - "/search/tax-rule-type": { + "/search/tax-provider": { "post": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "summary": "Search for the Tax Rule Type resources.", - "description": "Available since: 6.1.0.0", - "operationId": "searchTaxRuleType", + "summary": "Search for the Tax Provider resources.", + "description": "Available since: 6.5.0.0", + "operationId": "searchTaxProvider", "requestBody": { "required": true, "content": { @@ -66498,7 +66498,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -66512,7 +66512,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66530,7 +66530,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66547,19 +66547,19 @@ } } }, - "/tax-rule-type/{id}": { + "/tax-provider/{id}": { "get": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "summary": "Detailed information about a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "getTaxRuleType", + "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 tax_rule_type", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -66569,7 +66569,7 @@ ], "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -66581,7 +66581,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66596,7 +66596,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66613,16 +66613,16 @@ }, "delete": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "summary": "Delete a Tax Rule Type resource.", - "description": "Available since: 6.1.0.0", - "operationId": "deleteTaxRuleType", + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -66653,16 +66653,16 @@ }, "patch": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "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 Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "updateTaxProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the tax_rule_type", + "description": "Identifier for the tax_provider", "required": true, "schema": { "type": "string", @@ -66680,18 +66680,18 @@ } ], "requestBody": { - "description": "Partially update information about a Tax Rule Type resource.", + "description": "Partially update information about a Tax Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } }, "responses": { "200": { - "description": "Detail of TaxRuleType", + "description": "Detail of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -66703,7 +66703,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66718,7 +66718,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66737,14 +66737,14 @@ } } }, - "/aggregate/tax-rule-type": { + "/aggregate/tax-provider": { "post": { "tags": [ - "Tax Rule Type" + "Tax Provider" ], - "summary": "Aggregate for the Tax Rule Type resources.", + "summary": "Aggregate for the Tax Provider resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRuleType", + "operationId": "aggregateTaxProvider", "requestBody": { "required": true, "content": { @@ -66768,7 +66768,7 @@ }, "responses": { "200": { - "description": "List of TaxRuleType", + "description": "List of TaxProvider", "content": { "application/vnd.api+json": { "schema": { @@ -66782,7 +66782,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66800,7 +66800,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/TaxRuleType" + "$ref": "#/components/schemas/TaxProvider" } } } @@ -66817,14 +66817,14 @@ } } }, - "/theme": { + "/tax-rule": { "get": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "List with basic information of Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getThemeList", + "summary": "List with basic information of Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleList", "parameters": [ { "name": "limit", @@ -66853,7 +66853,7 @@ ], "responses": { "200": { - "description": "List of Theme resources.", + "description": "List of Tax Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -66872,7 +66872,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } ] @@ -66886,16 +66886,16 @@ "type": "object", "properties": { "first": { - "example": "/theme?limit=25" + "example": "/tax-rule?limit=25" }, "last": { - "example": "/theme?limit=25&page=11" + "example": "/tax-rule?limit=25&page=11" }, "next": { - "example": "/theme?limit=25&page=4" + "example": "/tax-rule?limit=25&page=4" }, "prev": { - "example": "/theme?limit=25&page=2" + "example": "/tax-rule?limit=25&page=2" } } } @@ -66916,7 +66916,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -66931,11 +66931,11 @@ }, "post": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "Create a new Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createTheme", + "summary": "Create a new Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRule", "parameters": [ { "name": "_response", @@ -66954,14 +66954,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -66973,7 +66973,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -66988,7 +66988,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67004,14 +67004,14 @@ } } }, - "/search/theme": { + "/search/tax-rule": { "post": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "Search for the Theme resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchTheme", + "summary": "Search for the Tax Rule resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRule", "requestBody": { "required": true, "content": { @@ -67024,7 +67024,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -67038,7 +67038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67056,7 +67056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67073,19 +67073,19 @@ } } }, - "/theme/{id}": { + "/tax-rule/{id}": { "get": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "Detailed information about a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getTheme", + "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 theme", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -67095,7 +67095,7 @@ ], "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -67107,7 +67107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67122,7 +67122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67139,16 +67139,16 @@ }, "delete": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "Delete a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", + "summary": "Delete a Tax Rule resource.", + "description": "Available since: 6.1.0.0", + "operationId": "deleteTaxRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the theme", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -67179,16 +67179,16 @@ }, "patch": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "Partially update information about a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateTheme", + "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 theme", + "description": "Identifier for the tax_rule", "required": true, "schema": { "type": "string", @@ -67206,18 +67206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Theme resource.", + "description": "Partially update information about a Tax Rule resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } }, "responses": { "200": { - "description": "Detail of Theme", + "description": "Detail of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -67229,7 +67229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67244,7 +67244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67263,14 +67263,14 @@ } } }, - "/aggregate/theme": { + "/aggregate/tax-rule": { "post": { "tags": [ - "Theme" + "Tax Rule" ], - "summary": "Aggregate for the Theme resources.", + "summary": "Aggregate for the Tax Rule resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateTheme", + "operationId": "aggregateTaxRule", "requestBody": { "required": true, "content": { @@ -67294,7 +67294,7 @@ }, "responses": { "200": { - "description": "List of Theme", + "description": "List of TaxRule", "content": { "application/vnd.api+json": { "schema": { @@ -67308,7 +67308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67326,7 +67326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Theme" + "$ref": "#/components/schemas/TaxRule" } } } @@ -67343,14 +67343,14 @@ } } }, - "/unit": { + "/tax-rule-type": { "get": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "List with basic information of Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getUnitList", + "summary": "List with basic information of Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "getTaxRuleTypeList", "parameters": [ { "name": "limit", @@ -67379,7 +67379,7 @@ ], "responses": { "200": { - "description": "List of Unit resources.", + "description": "List of Tax Rule Type resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67398,7 +67398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } ] @@ -67412,16 +67412,16 @@ "type": "object", "properties": { "first": { - "example": "/unit?limit=25" + "example": "/tax-rule-type?limit=25" }, "last": { - "example": "/unit?limit=25&page=11" + "example": "/tax-rule-type?limit=25&page=11" }, "next": { - "example": "/unit?limit=25&page=4" + "example": "/tax-rule-type?limit=25&page=4" }, "prev": { - "example": "/unit?limit=25&page=2" + "example": "/tax-rule-type?limit=25&page=2" } } } @@ -67442,7 +67442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67457,11 +67457,11 @@ }, "post": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "Create a new Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createUnit", + "summary": "Create a new Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "createTaxRuleType", "parameters": [ { "name": "_response", @@ -67480,14 +67480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -67499,7 +67499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67514,7 +67514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67530,14 +67530,14 @@ } } }, - "/search/unit": { + "/search/tax-rule-type": { "post": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "Search for the Unit resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchUnit", + "summary": "Search for the Tax Rule Type resources.", + "description": "Available since: 6.1.0.0", + "operationId": "searchTaxRuleType", "requestBody": { "required": true, "content": { @@ -67550,7 +67550,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -67564,7 +67564,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67582,7 +67582,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67599,19 +67599,19 @@ } } }, - "/unit/{id}": { + "/tax-rule-type/{id}": { "get": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "Detailed information about a Unit resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUnit", + "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 unit", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -67621,7 +67621,7 @@ ], "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -67633,7 +67633,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67648,7 +67648,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67665,16 +67665,16 @@ }, "delete": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "Delete a Unit resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUnit", + "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 unit", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -67705,16 +67705,16 @@ }, "patch": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "Partially update information about a Unit resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUnit", + "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 unit", + "description": "Identifier for the tax_rule_type", "required": true, "schema": { "type": "string", @@ -67732,18 +67732,18 @@ } ], "requestBody": { - "description": "Partially update information about a Unit resource.", + "description": "Partially update information about a Tax Rule Type resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } }, "responses": { "200": { - "description": "Detail of Unit", + "description": "Detail of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -67755,7 +67755,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67770,7 +67770,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67789,14 +67789,14 @@ } } }, - "/aggregate/unit": { + "/aggregate/tax-rule-type": { "post": { "tags": [ - "Unit" + "Tax Rule Type" ], - "summary": "Aggregate for the Unit resources.", + "summary": "Aggregate for the Tax Rule Type resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUnit", + "operationId": "aggregateTaxRuleType", "requestBody": { "required": true, "content": { @@ -67820,7 +67820,7 @@ }, "responses": { "200": { - "description": "List of Unit", + "description": "List of TaxRuleType", "content": { "application/vnd.api+json": { "schema": { @@ -67834,7 +67834,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67852,7 +67852,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/TaxRuleType" } } } @@ -67869,14 +67869,14 @@ } } }, - "/user": { + "/theme": { "get": { "tags": [ - "User" + "Theme" ], - "summary": "List with basic information of User resources.", + "summary": "List with basic information of Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserList", + "operationId": "getThemeList", "parameters": [ { "name": "limit", @@ -67905,7 +67905,7 @@ ], "responses": { "200": { - "description": "List of User resources.", + "description": "List of Theme resources.", "content": { "application/vnd.api+json": { "schema": { @@ -67924,7 +67924,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } ] @@ -67938,16 +67938,16 @@ "type": "object", "properties": { "first": { - "example": "/user?limit=25" + "example": "/theme?limit=25" }, "last": { - "example": "/user?limit=25&page=11" + "example": "/theme?limit=25&page=11" }, "next": { - "example": "/user?limit=25&page=4" + "example": "/theme?limit=25&page=4" }, "prev": { - "example": "/user?limit=25&page=2" + "example": "/theme?limit=25&page=2" } } } @@ -67968,7 +67968,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -67983,11 +67983,11 @@ }, "post": { "tags": [ - "User" + "Theme" ], - "summary": "Create a new User resources.", + "summary": "Create a new Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUser", + "operationId": "createTheme", "parameters": [ { "name": "_response", @@ -68006,14 +68006,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -68025,7 +68025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68040,7 +68040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68056,14 +68056,14 @@ } } }, - "/search/user": { + "/search/theme": { "post": { "tags": [ - "User" + "Theme" ], - "summary": "Search for the User resources.", + "summary": "Search for the Theme resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUser", + "operationId": "searchTheme", "requestBody": { "required": true, "content": { @@ -68076,7 +68076,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -68090,7 +68090,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68108,7 +68108,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68125,19 +68125,19 @@ } } }, - "/user/{id}": { + "/theme/{id}": { "get": { "tags": [ - "User" + "Theme" ], - "summary": "Detailed information about a User resource.", + "summary": "Detailed information about a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUser", + "operationId": "getTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -68147,7 +68147,7 @@ ], "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -68159,7 +68159,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68174,7 +68174,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68191,16 +68191,16 @@ }, "delete": { "tags": [ - "User" + "Theme" ], - "summary": "Delete a User resource.", + "summary": "Delete a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUser", + "operationId": "deleteTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -68231,16 +68231,16 @@ }, "patch": { "tags": [ - "User" + "Theme" ], - "summary": "Partially update information about a User resource.", + "summary": "Partially update information about a Theme resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUser", + "operationId": "updateTheme", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user", + "description": "Identifier for the theme", "required": true, "schema": { "type": "string", @@ -68258,18 +68258,18 @@ } ], "requestBody": { - "description": "Partially update information about a User resource.", + "description": "Partially update information about a Theme resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } }, "responses": { "200": { - "description": "Detail of User", + "description": "Detail of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -68281,7 +68281,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68296,7 +68296,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68315,14 +68315,14 @@ } } }, - "/aggregate/user": { + "/aggregate/theme": { "post": { "tags": [ - "User" + "Theme" ], - "summary": "Aggregate for the User resources.", + "summary": "Aggregate for the Theme resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUser", + "operationId": "aggregateTheme", "requestBody": { "required": true, "content": { @@ -68346,7 +68346,7 @@ }, "responses": { "200": { - "description": "List of User", + "description": "List of Theme", "content": { "application/vnd.api+json": { "schema": { @@ -68360,7 +68360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68378,7 +68378,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/Theme" } } } @@ -68395,14 +68395,14 @@ } } }, - "/user-access-key": { + "/unit": { "get": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "List with basic information of User Access Key resources.", + "summary": "List with basic information of Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKeyList", + "operationId": "getUnitList", "parameters": [ { "name": "limit", @@ -68431,7 +68431,7 @@ ], "responses": { "200": { - "description": "List of User Access Key resources.", + "description": "List of Unit resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68450,7 +68450,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } ] @@ -68464,16 +68464,16 @@ "type": "object", "properties": { "first": { - "example": "/user-access-key?limit=25" + "example": "/unit?limit=25" }, "last": { - "example": "/user-access-key?limit=25&page=11" + "example": "/unit?limit=25&page=11" }, "next": { - "example": "/user-access-key?limit=25&page=4" + "example": "/unit?limit=25&page=4" }, "prev": { - "example": "/user-access-key?limit=25&page=2" + "example": "/unit?limit=25&page=2" } } } @@ -68494,7 +68494,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68509,11 +68509,11 @@ }, "post": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "Create a new User Access Key resources.", + "summary": "Create a new Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUserAccessKey", + "operationId": "createUnit", "parameters": [ { "name": "_response", @@ -68532,14 +68532,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -68551,7 +68551,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68566,7 +68566,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68582,14 +68582,14 @@ } } }, - "/search/user-access-key": { + "/search/unit": { "post": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "Search for the User Access Key resources.", + "summary": "Search for the Unit resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUserAccessKey", + "operationId": "searchUnit", "requestBody": { "required": true, "content": { @@ -68602,7 +68602,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -68616,7 +68616,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68634,7 +68634,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68651,19 +68651,19 @@ } } }, - "/user-access-key/{id}": { + "/unit/{id}": { "get": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "Detailed information about a User Access Key resource.", + "summary": "Detailed information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", + "operationId": "getUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -68673,7 +68673,7 @@ ], "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -68685,7 +68685,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68700,7 +68700,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68717,16 +68717,16 @@ }, "delete": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "Delete a User Access Key resource.", + "summary": "Delete a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", + "operationId": "deleteUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -68757,16 +68757,16 @@ }, "patch": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "Partially update information about a User Access Key resource.", + "summary": "Partially update information about a Unit resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", + "operationId": "updateUnit", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_access_key", + "description": "Identifier for the unit", "required": true, "schema": { "type": "string", @@ -68784,18 +68784,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Access Key resource.", + "description": "Partially update information about a Unit resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } }, "responses": { "200": { - "description": "Detail of UserAccessKey", + "description": "Detail of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -68807,7 +68807,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68822,7 +68822,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68841,14 +68841,14 @@ } } }, - "/aggregate/user-access-key": { + "/aggregate/unit": { "post": { "tags": [ - "User Access Key" + "Unit" ], - "summary": "Aggregate for the User Access Key resources.", + "summary": "Aggregate for the Unit resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserAccessKey", + "operationId": "aggregateUnit", "requestBody": { "required": true, "content": { @@ -68872,7 +68872,7 @@ }, "responses": { "200": { - "description": "List of UserAccessKey", + "description": "List of Unit", "content": { "application/vnd.api+json": { "schema": { @@ -68886,7 +68886,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68904,7 +68904,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserAccessKey" + "$ref": "#/components/schemas/Unit" } } } @@ -68921,14 +68921,14 @@ } } }, - "/user-config": { + "/user": { "get": { "tags": [ - "User Config" + "User" ], - "summary": "List with basic information of User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfigList", + "summary": "List with basic information of User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserList", "parameters": [ { "name": "limit", @@ -68957,7 +68957,7 @@ ], "responses": { "200": { - "description": "List of User Config resources.", + "description": "List of User resources.", "content": { "application/vnd.api+json": { "schema": { @@ -68976,7 +68976,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } ] @@ -68990,16 +68990,16 @@ "type": "object", "properties": { "first": { - "example": "/user-config?limit=25" + "example": "/user?limit=25" }, "last": { - "example": "/user-config?limit=25&page=11" + "example": "/user?limit=25&page=11" }, "next": { - "example": "/user-config?limit=25&page=4" + "example": "/user?limit=25&page=4" }, "prev": { - "example": "/user-config?limit=25&page=2" + "example": "/user?limit=25&page=2" } } } @@ -69020,7 +69020,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69035,11 +69035,11 @@ }, "post": { "tags": [ - "User Config" + "User" ], - "summary": "Create a new User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "createUserConfig", + "summary": "Create a new User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUser", "parameters": [ { "name": "_response", @@ -69058,14 +69058,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -69077,7 +69077,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69092,7 +69092,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69108,14 +69108,14 @@ } } }, - "/search/user-config": { + "/search/user": { "post": { "tags": [ - "User Config" + "User" ], - "summary": "Search for the User Config resources.", - "description": "Available since: 6.3.5.0", - "operationId": "searchUserConfig", + "summary": "Search for the User resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUser", "requestBody": { "required": true, "content": { @@ -69128,7 +69128,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -69142,7 +69142,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69160,7 +69160,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69177,19 +69177,19 @@ } } }, - "/user-config/{id}": { + "/user/{id}": { "get": { "tags": [ - "User Config" + "User" ], - "summary": "Detailed information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "getUserConfig", + "summary": "Detailed information about a User resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -69199,7 +69199,7 @@ ], "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -69211,7 +69211,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69226,7 +69226,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69243,16 +69243,16 @@ }, "delete": { "tags": [ - "User Config" + "User" ], - "summary": "Delete a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "deleteUserConfig", + "summary": "Delete a User resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -69283,16 +69283,16 @@ }, "patch": { "tags": [ - "User Config" + "User" ], - "summary": "Partially update information about a User Config resource.", - "description": "Available since: 6.3.5.0", - "operationId": "updateUserConfig", + "summary": "Partially update information about a User resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_config", + "description": "Identifier for the user", "required": true, "schema": { "type": "string", @@ -69310,18 +69310,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Config resource.", + "description": "Partially update information about a User resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { - "description": "Detail of UserConfig", + "description": "Detail of User", "content": { "application/vnd.api+json": { "schema": { @@ -69333,7 +69333,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69348,7 +69348,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69367,14 +69367,14 @@ } } }, - "/aggregate/user-config": { + "/aggregate/user": { "post": { "tags": [ - "User Config" + "User" ], - "summary": "Aggregate for the User Config resources.", + "summary": "Aggregate for the User resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserConfig", + "operationId": "aggregateUser", "requestBody": { "required": true, "content": { @@ -69398,7 +69398,7 @@ }, "responses": { "200": { - "description": "List of UserConfig", + "description": "List of User", "content": { "application/vnd.api+json": { "schema": { @@ -69412,7 +69412,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69430,7 +69430,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserConfig" + "$ref": "#/components/schemas/User" } } } @@ -69447,14 +69447,14 @@ } } }, - "/user-recovery": { + "/user-access-key": { "get": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "List with basic information of User Recovery resources.", + "summary": "List with basic information of User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "getUserRecoveryList", + "operationId": "getUserAccessKeyList", "parameters": [ { "name": "limit", @@ -69483,7 +69483,7 @@ ], "responses": { "200": { - "description": "List of User Recovery resources.", + "description": "List of User Access Key resources.", "content": { "application/vnd.api+json": { "schema": { @@ -69502,7 +69502,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } ] @@ -69516,16 +69516,16 @@ "type": "object", "properties": { "first": { - "example": "/user-recovery?limit=25" + "example": "/user-access-key?limit=25" }, "last": { - "example": "/user-recovery?limit=25&page=11" + "example": "/user-access-key?limit=25&page=11" }, "next": { - "example": "/user-recovery?limit=25&page=4" + "example": "/user-access-key?limit=25&page=4" }, "prev": { - "example": "/user-recovery?limit=25&page=2" + "example": "/user-access-key?limit=25&page=2" } } } @@ -69546,7 +69546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69561,11 +69561,11 @@ }, "post": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "Create a new User Recovery resources.", + "summary": "Create a new User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "createUserRecovery", + "operationId": "createUserAccessKey", "parameters": [ { "name": "_response", @@ -69584,14 +69584,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -69603,7 +69603,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69618,7 +69618,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69634,14 +69634,14 @@ } } }, - "/search/user-recovery": { + "/search/user-access-key": { "post": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "Search for the User Recovery resources.", + "summary": "Search for the User Access Key resources.", "description": "Available since: 6.0.0.0", - "operationId": "searchUserRecovery", + "operationId": "searchUserAccessKey", "requestBody": { "required": true, "content": { @@ -69654,7 +69654,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -69668,7 +69668,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69686,7 +69686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69703,19 +69703,19 @@ } } }, - "/user-recovery/{id}": { + "/user-access-key/{id}": { "get": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "Detailed information about a User Recovery resource.", + "summary": "Detailed information about a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "getUserRecovery", + "operationId": "getUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -69725,7 +69725,7 @@ ], "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -69737,7 +69737,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69752,7 +69752,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69769,16 +69769,16 @@ }, "delete": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "Delete a User Recovery resource.", + "summary": "Delete a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "deleteUserRecovery", + "operationId": "deleteUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -69809,16 +69809,16 @@ }, "patch": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "Partially update information about a User Recovery resource.", + "summary": "Partially update information about a User Access Key resource.", "description": "Available since: 6.0.0.0", - "operationId": "updateUserRecovery", + "operationId": "updateUserAccessKey", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the user_recovery", + "description": "Identifier for the user_access_key", "required": true, "schema": { "type": "string", @@ -69836,18 +69836,18 @@ } ], "requestBody": { - "description": "Partially update information about a User Recovery resource.", + "description": "Partially update information about a User Access Key resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } }, "responses": { "200": { - "description": "Detail of UserRecovery", + "description": "Detail of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -69859,7 +69859,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69874,7 +69874,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69893,14 +69893,14 @@ } } }, - "/aggregate/user-recovery": { + "/aggregate/user-access-key": { "post": { "tags": [ - "User Recovery" + "User Access Key" ], - "summary": "Aggregate for the User Recovery resources.", + "summary": "Aggregate for the User Access Key resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserRecovery", + "operationId": "aggregateUserAccessKey", "requestBody": { "required": true, "content": { @@ -69924,7 +69924,7 @@ }, "responses": { "200": { - "description": "List of UserRecovery", + "description": "List of UserAccessKey", "content": { "application/vnd.api+json": { "schema": { @@ -69938,7 +69938,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69956,7 +69956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/UserRecovery" + "$ref": "#/components/schemas/UserAccessKey" } } } @@ -69973,14 +69973,14 @@ } } }, - "/webhook": { + "/user-config": { "get": { "tags": [ - "Webhook" + "User Config" ], - "summary": "List with basic information of Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhookList", + "summary": "List with basic information of User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "getUserConfigList", "parameters": [ { "name": "limit", @@ -70009,7 +70009,7 @@ ], "responses": { "200": { - "description": "List of Webhook resources.", + "description": "List of User Config resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70028,7 +70028,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } ] @@ -70042,16 +70042,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook?limit=25" + "example": "/user-config?limit=25" }, "last": { - "example": "/webhook?limit=25&page=11" + "example": "/user-config?limit=25&page=11" }, "next": { - "example": "/webhook?limit=25&page=4" + "example": "/user-config?limit=25&page=4" }, "prev": { - "example": "/webhook?limit=25&page=2" + "example": "/user-config?limit=25&page=2" } } } @@ -70072,7 +70072,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70087,11 +70087,11 @@ }, "post": { "tags": [ - "Webhook" + "User Config" ], - "summary": "Create a new Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "createWebhook", + "summary": "Create a new User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "createUserConfig", "parameters": [ { "name": "_response", @@ -70110,14 +70110,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70129,7 +70129,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70144,7 +70144,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70160,14 +70160,14 @@ } } }, - "/search/webhook": { + "/search/user-config": { "post": { "tags": [ - "Webhook" + "User Config" ], - "summary": "Search for the Webhook resources.", - "description": "Available since: 6.3.1.0", - "operationId": "searchWebhook", + "summary": "Search for the User Config resources.", + "description": "Available since: 6.3.5.0", + "operationId": "searchUserConfig", "requestBody": { "required": true, "content": { @@ -70180,7 +70180,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70194,7 +70194,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70212,7 +70212,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70229,19 +70229,19 @@ } } }, - "/webhook/{id}": { + "/user-config/{id}": { "get": { "tags": [ - "Webhook" + "User Config" ], - "summary": "Detailed information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "getWebhook", + "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 webhook", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -70251,7 +70251,7 @@ ], "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70263,7 +70263,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70278,7 +70278,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70295,16 +70295,16 @@ }, "delete": { "tags": [ - "Webhook" + "User Config" ], - "summary": "Delete a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "deleteWebhook", + "summary": "Delete a User Config resource.", + "description": "Available since: 6.3.5.0", + "operationId": "deleteUserConfig", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -70335,16 +70335,16 @@ }, "patch": { "tags": [ - "Webhook" + "User Config" ], - "summary": "Partially update information about a Webhook resource.", - "description": "Available since: 6.3.1.0", - "operationId": "updateWebhook", + "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 webhook", + "description": "Identifier for the user_config", "required": true, "schema": { "type": "string", @@ -70362,18 +70362,18 @@ } ], "requestBody": { - "description": "Partially update information about a Webhook resource.", + "description": "Partially update information about a User Config resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } }, "responses": { "200": { - "description": "Detail of Webhook", + "description": "Detail of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70385,7 +70385,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70400,7 +70400,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70419,14 +70419,14 @@ } } }, - "/aggregate/webhook": { + "/aggregate/user-config": { "post": { "tags": [ - "Webhook" + "User Config" ], - "summary": "Aggregate for the Webhook resources.", + "summary": "Aggregate for the User Config resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhook", + "operationId": "aggregateUserConfig", "requestBody": { "required": true, "content": { @@ -70450,7 +70450,7 @@ }, "responses": { "200": { - "description": "List of Webhook", + "description": "List of UserConfig", "content": { "application/vnd.api+json": { "schema": { @@ -70464,7 +70464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70482,7 +70482,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Webhook" + "$ref": "#/components/schemas/UserConfig" } } } @@ -70499,14 +70499,14 @@ } } }, - "/webhook-event-log": { + "/user-recovery": { "get": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "List with basic information of Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLogList", + "summary": "List with basic information of User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecoveryList", "parameters": [ { "name": "limit", @@ -70535,7 +70535,7 @@ ], "responses": { "200": { - "description": "List of Webhook Event Log resources.", + "description": "List of User Recovery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -70554,7 +70554,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } ] @@ -70568,16 +70568,16 @@ "type": "object", "properties": { "first": { - "example": "/webhook-event-log?limit=25" + "example": "/user-recovery?limit=25" }, "last": { - "example": "/webhook-event-log?limit=25&page=11" + "example": "/user-recovery?limit=25&page=11" }, "next": { - "example": "/webhook-event-log?limit=25&page=4" + "example": "/user-recovery?limit=25&page=4" }, "prev": { - "example": "/webhook-event-log?limit=25&page=2" + "example": "/user-recovery?limit=25&page=2" } } } @@ -70598,7 +70598,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70613,11 +70613,11 @@ }, "post": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "Create a new Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "createWebhookEventLog", + "summary": "Create a new User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createUserRecovery", "parameters": [ { "name": "_response", @@ -70636,14 +70636,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -70655,7 +70655,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70670,7 +70670,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70686,14 +70686,14 @@ } } }, - "/search/webhook-event-log": { + "/search/user-recovery": { "post": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "Search for the Webhook Event Log resources.", - "description": "Available since: 6.4.1.0", - "operationId": "searchWebhookEventLog", + "summary": "Search for the User Recovery resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchUserRecovery", "requestBody": { "required": true, "content": { @@ -70706,7 +70706,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -70720,7 +70720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70738,7 +70738,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70755,19 +70755,19 @@ } } }, - "/webhook-event-log/{id}": { + "/user-recovery/{id}": { "get": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "Detailed information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "getWebhookEventLog", + "summary": "Detailed information about a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -70777,7 +70777,7 @@ ], "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -70789,7 +70789,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70804,7 +70804,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70821,16 +70821,16 @@ }, "delete": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "Delete a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "deleteWebhookEventLog", + "summary": "Delete a User Recovery resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserRecovery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the webhook_event_log", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -70861,16 +70861,16 @@ }, "patch": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "Partially update information about a Webhook Event Log resource.", - "description": "Available since: 6.4.1.0", - "operationId": "updateWebhookEventLog", + "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 webhook_event_log", + "description": "Identifier for the user_recovery", "required": true, "schema": { "type": "string", @@ -70888,18 +70888,18 @@ } ], "requestBody": { - "description": "Partially update information about a Webhook Event Log resource.", + "description": "Partially update information about a User Recovery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } }, "responses": { "200": { - "description": "Detail of WebhookEventLog", + "description": "Detail of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -70911,7 +70911,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70926,7 +70926,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -70945,14 +70945,14 @@ } } }, - "/aggregate/webhook-event-log": { + "/aggregate/user-recovery": { "post": { "tags": [ - "Webhook Event Log" + "User Recovery" ], - "summary": "Aggregate for the Webhook Event Log resources.", + "summary": "Aggregate for the User Recovery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhookEventLog", + "operationId": "aggregateUserRecovery", "requestBody": { "required": true, "content": { @@ -70976,7 +70976,7 @@ }, "responses": { "200": { - "description": "List of WebhookEventLog", + "description": "List of UserRecovery", "content": { "application/vnd.api+json": { "schema": { @@ -70990,7 +70990,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -71008,7 +71008,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "$ref": "#/components/schemas/UserRecovery" } } } @@ -71025,218 +71025,338 @@ } } }, - "/_action/cleanup": { - "delete": { + "/webhook": { + "get": { "tags": [ - "System Operations" + "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" + } + } ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "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" } } - } - }, - "/_action/order/document/download": { + }, "post": { "tags": [ - "Document Management" + "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" + ] + } + } ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", "requestBody": { - "description": "documentIds", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { - "description": "The documents.", + "description": "Detail of Webhook", "content": { - "application/octet-stream": { + "application/vnd.api+json": { "schema": { - "type": "string", - "format": "binary" + "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" } } } }, - "/_action/order/document/{documentTypeName}/create": { + "/search/webhook": { "post": { "tags": [ - "Document Management" - ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", - "parameters": [ - { - "name": "documentTypeName", - "in": "path", - "description": "The type of document to create", - "required": true, - "schema": { - "type": "string" - } - } + "Webhook" ], + "summary": "Search for the Webhook resources.", + "description": "Available since: 6.3.1.0", + "operationId": "searchWebhook", "requestBody": { - "description": "test", "required": true, "content": { "application/json": { "schema": { - "type": "array", - "items": { + "$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", - "required": [ - "orderId", - "type" - ], "properties": { - "orderId": { - "description": "Identifier of the order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "description": "Type of the document to be generated.", - "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", - "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", - "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" + "total": { + "type": "integer" }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" + } } } } } } - } - }, - "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/order/{orderId}/state/{transition}": { - "post": { + "/webhook/{id}": { + "get": { "tags": [ - "Order Management" + "Webhook" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Detailed information about a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "getWebhook", "parameters": [ { - "name": "orderId", + "name": "id", "in": "path", - "description": "Identifier of the order.", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", - "required": true, - "schema": { - "type": "string" - } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "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" + } + } } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Webhook" } - }, - "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" } - }, - "type": "object" + } } } - } - }, - "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { + }, + "delete": { "tags": [ - "Document Management" + "Webhook" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "summary": "Delete a Webhook resource.", + "description": "Available since: 6.3.1.0", + "operationId": "deleteWebhook", "parameters": [ { - "name": "documentId", + "name": "id", "in": "path", - "description": "Identifier of the document to be downloaded.", + "description": "Identifier for the webhook", "required": true, "schema": { "type": "string", @@ -71244,8 +71364,1485 @@ } }, { - "name": "deepLinkCode", - "in": "path", + "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", + "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", + "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 Event Log" + ], + "summary": "Partially update information about a Webhook Event Log resource.", + "description": "Available since: 6.4.1.0", + "operationId": "updateWebhookEventLog", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the webhook_event_log", + "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 Event Log resource.", + "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" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/webhook-event-log": { + "post": { + "tags": [ + "Webhook Event Log" + ], + "summary": "Aggregate for the Webhook Event Log resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWebhookEventLog", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of WebhookEventLog", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "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" + } + } + } + }, + "/_action/message-queue/consume": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "receiver" + ], + "properties": { + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns information about handled messages", + "content": { + "application/json": { + "schema": { + "properties": { + "handledMessages": { + "description": "The number of messages processed.", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Check that the Application is running", + "operationId": "healthCheck", + "responses": { + "200": { + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_info/system-health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" + } + ], + "responses": { + "200": { + "description": "Returns the system health check results", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_action/indexing": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", + "parameters": [ + { + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "offset": { + "description": "The offset for the iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns information about the iteration.", + "content": { + "application/json": { + "schema": { + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/mail-template/send": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], + "properties": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/mail-template/validate": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "contentHtml", + "contentPlain" + ], + "properties": { + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "Returns a no content response indicating the mail content was rendered successfully." + } + } + } + }, + "/_action/mail-template/build": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/_action/order/{orderId}/order-address": { + "post": { + "tags": [ + "Order address" + ], + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "description": "The ID of the delivery (optional)", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/_info/version": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", + "responses": { + "200": { + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" + }, + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", + "responses": { + "200": { + "description": "Information about the cache state.", + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/events.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", + "responses": { + "200": { + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } + } + } + } + }, + "/_action/cleanup": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cleanup finished." + } + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "/_action/document/{documentId}/{deepLinkCode}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", "description": "A unique hash code which was generated when the document was created.", "required": true, "schema": { @@ -71364,92 +72961,118 @@ } } }, - "/_action/order/{orderId}/order-address": { + "/_action/sync": { "post": { "tags": [ - "Order address" + "Bulk Operations" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", "parameters": [ { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "description": "The ID of the delivery (optional)", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "customerAddressId", - "type" + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" ] }, - "description": "The mapping of order addresses" - } + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "filter": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + } + }, + "type": "object" } } } - }, - "required": true - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." } - } - } - }, - "/_info/events.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + }, "responses": { "200": { - "description": "Returns a list of about the business events.", + "description": "Returns a sync result containing information about the updated entities", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/businessEventsResponse" + "properties": { + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" + } + }, + "type": "object" } } } @@ -71518,173 +73141,418 @@ } } } - }, - "400": { - "$ref": "#/components/responses/400" + }, + "400": { + "$ref": "#/components/responses/400" + } + } + } + }, + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, + "/app-system/privileges/requested": { + "get": { + "tags": [ + "App System" + ], + "summary": "Get requested privileges for all apps", + "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", + "operationId": "getRequestedPrivileges", + "security": [ + { + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing requested privileges.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "example": { + "privileges": { + "SwagAnalytics": [ + "customer:read", + "order:read" + ], + "SwagExample": [ + "product:write" + ] + } + } + } + } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + } + } + } + }, + "/app-system/{appName}/privileges/accepted": { + "get": { + "tags": [ + "App System" + ], + "summary": "Get accepted privileges for an app", + "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", + "operationId": "getAcceptedPrivileges", + "parameters": [ + { + "name": "appName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "security": [ + { + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing accepted privileges.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + } + } + }, + "example": { + "privileges": { + "customer:read": true, + "order:read": true + } + } + } + } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + } + } + }, + "/app-system/{appName}/privileges": { + "patch": { + "tags": [ + "App System" + ], + "summary": "Accept or revoke privileges for an app", + "description": "Accepts or revokes specified privileges for the given app.", + "operationId": "managePrivileges", + "parameters": [ + { + "name": "appName", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "accept": { + "type": "array", + "items": { + "type": "string" + } + }, + "revoke": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "example": { + "accept": [ + "customer:read", + "order:read" + ], + "revoke": [ + "product:write" + ] + } + } + } + }, + "responses": { + "204": { + "description": "Returns no content if privileges were managed successfully." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/_action/media/{mediaId}/upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "Identifier of the media entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `png`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the media file that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", + "schema": { + "type": "string" + } + } + } } } } }, - "/_action/mail-template/send": { + "/_action/media/upload": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", + "summary": "Upload a new media file", + "description": "Creates a new media entity and uploads a file to it using form-data file upload.", + "operationId": "uploadV2", "requestBody": { - "required": true, "content": { - "application/json": { + "multipart/form-data": { "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], + "type": "object", "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", + "file": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" + "format": "binary", + "description": "The file to upload" }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } + "fileName": { + "type": "string", + "description": "Name of the uploaded file" }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "private": { + "type": "boolean", + "description": "Whether the media should be private" }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "mimeType": { + "type": "string", + "description": "MIME type of the file" }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" } }, - "type": "object" + "required": [ + "file" + ] } } } }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "Media file uploaded successfully", "content": { - "application/json": { + "application\\/json": { "schema": { + "type": "object", "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" } - }, - "type": "object" + } } } } @@ -71692,127 +73560,146 @@ } } }, - "/_action/mail-template/validate": { + "/_action/media/upload_by_url": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", + "summary": "Upload a media file from URL", + "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", + "operationId": "uploadByUrl", "requestBody": { - "required": true, "content": { - "application/json": { + "application\\/json": { "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], + "type": "object", "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" + "url": { + "type": "string", + "description": "URL of the file to download and upload" }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the uploaded file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" } }, - "type": "object" + "required": [ + "url" + ] } } } }, "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "200": { + "description": "Media file uploaded successfully", + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } + } + } + } } } } }, - "/_action/mail-template/build": { + "/_action/media/external-link": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", + "summary": "Create external media link", + "description": "Creates a new media entity that links to an external URL without downloading the file.", + "operationId": "externalLink", "requestBody": { - "required": true, "content": { - "application/json": { + "application\\/json": { "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], + "type": "object", "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" + "url": { + "type": "string", + "description": "URL of the external media file" }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on path" } }, - "type": "object" + "required": [ + "url", + "mimeType" + ] } } } }, "responses": { "200": { - "description": "The rendered preview of the mail template.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/_info/config": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get API information", - "description": "Get information about the API", - "operationId": "config", - "responses": { - "200": { - "description": "Returns information about the API.", + "description": "External media link created successfully", "content": { - "application/json": { + "application\\/json": { "schema": { - "$ref": "#/components/schemas/infoConfigResponse" + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } } } } @@ -71898,73 +73785,59 @@ } } }, - "/_action/indexing": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", - "responses": { - "200": { - "description": "Returns an empty response indicating that the indexing process started." - } - } - } - }, - "/_action/indexing/{indexer}": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", - "parameters": [ - { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } - }, + "/_info/message-stats.json": { + "get": { + "summary": "Get statistics for recently processed messages in the message queue", + "operationId": "getMessageStats", "responses": { "200": { - "description": "Returns information about the iteration.", + "description": "Statistics received", "content": { "application/json": { "schema": { + "type": "object", + "required": [ + "enabled" + ], "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" + "enabled": { + "type": "boolean", + "description": "Whether message queue statistics are enabled in configuration" }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" + "stats": { + "type": [ + "object", + "null" + ], + "properties": { + "totalMessagesProcessed": { + "type": "integer" + }, + "processedSince": { + "type": "string", + "format": "date-time" + }, + "averageTimeInQueue": { + "type": "number", + "format": "float" + }, + "messageTypeStats": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "count": { + "type": "integer" + } + } + } + } + } } - }, - "type": "object" + } } } } @@ -71972,137 +73845,180 @@ } } }, - "/_info/health-check": { + "/_info/openapi3.json": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } + ], "responses": { "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" + "$ref": "#/components/responses/OpenApi3" } } } }, - "/_info/system-health-check": { - "get": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "post": { "tags": [ - "System Info & Health Check" + "Order Management" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "verbose", - "in": "query", - "required": false, + "name": "orderTransactionId", + "in": "path", + "description": "Identifier of the order transaction.", + "required": true, "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } } ], - "responses": { - "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } + }, + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" } - } + }, + "type": "object" } } - }, - "500": { - "description": "Application is not working properly" } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", + }, "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/_action/cache-delayed": { + "/_action/container_cache": { "delete": { "tags": [ "System Operations" ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "responses": { "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "description": "Returns a no content response indicating that the container cache is cleared." } } } }, - "/_action/index": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": [ - "System Operations" + "Order Management" + ], + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", + "parameters": [ + { + "name": "orderDeliveryId", + "in": "path", + "description": "Identifier of the order delivery.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", "requestBody": { + "required": false, "content": { "application/json": { "schema": { "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", + "sendMail": { + "description": "Controls if a mail should be send to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", "type": "array", "items": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } + }, + "stateFieldName": { + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" } }, "type": "object" @@ -72111,68 +74027,38 @@ } }, "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" } } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { + "/_action/cache": { + "delete": { "tags": [ - "Document Management" + "System Operations" ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } + } + } + }, + "/_action/cache-delayed": { + "delete": { + "tags": [ + "System Operations" ], + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "description": "Number range not found" + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } @@ -72210,60 +74096,62 @@ } } }, - "/_info/openapi3.json": { - "get": { + "/_action/index-products": { + "post": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] - } + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." } + } + } + }, + "/_info/config": { + "get": { + "tags": [ + "System Info & Health Check" ], + "summary": "Get API information", + "description": "Get information about the API", + "operationId": "config", "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "Returns information about the API.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/infoConfigResponse" + } + } + } } } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/index": { "post": { "tags": [ - "Customer impersonation" + "System Operations" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "customerId", - "salesChannelId" - ], "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" - }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } } }, "type": "object" @@ -72271,39 +74159,138 @@ } } }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." + } + } + } + }, + "/_action/order/document/download": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", + "requestBody": { + "description": "documentIds", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, "responses": { "200": { - "description": "The generated customer impersonation token.", + "description": "The documents.", "content": { - "application/json": { + "application/octet-stream": { "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/order/document/{documentTypeName}/create": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", + "parameters": [ + { + "name": "documentTypeName", + "in": "path", + "description": "The type of document to create", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "test", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "required": [ + "orderId", + "type" + ], "properties": { - "token": { - "description": "The generated customer impersonation token", + "orderId": { + "description": "Identifier of the order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Type of the document to be generated.", "type": "string" + }, + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" + }, + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", + "type": "string", + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" } - }, - "type": "object" + } } } } } + }, + "responses": { + "200": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + } } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "/_action/order/{orderId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", "parameters": [ { - "name": "orderDeliveryId", + "name": "orderId", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Identifier of the order.", "required": true, "schema": { "type": "string", @@ -72313,7 +74300,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -72327,7 +74314,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be send to the customer." + "description": "Controls if a mail should be sent to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -72346,7 +74333,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "description": "This is the state column within the order database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" } @@ -72363,73 +74350,246 @@ } } }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", + "/_action/increment/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Increment a value in the specified pool", + "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", + "operationId": "incrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the increment operation.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to increment in the pool." + } + } + } + } + } + }, "responses": { "200": { - "description": "Successful operation", + "description": "Successfully incremented the value", "content": { "application/json": { "schema": { "type": "object", - "required": [ - "endpoints" - ], "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" + } + } + }, + "get": { + "tags": [ + "Increment Storage" + ], + "summary": "List increment values from pool", + "description": "Retrieves a list of increment values from the specified pool with pagination support.", + "operationId": "getIncrementValues", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to list values from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the increment operation.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum number of items to return.", + "required": false, + "schema": { + "type": "integer", + "default": 5, + "minimum": 1 + } + }, + { + "name": "offset", + "in": "query", + "description": "Number of items to skip for pagination.", + "required": false, + "schema": { + "type": "integer", + "default": 0, + "minimum": 0 + } + } + ], + "responses": { + "200": { + "description": "List of increment values", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The increment key" + }, + "count": { + "type": "integer", + "description": "The current count value" } } } } } } + }, + "400": { + "description": "Bad request - cluster parameter missing" + } + } + } + }, + "/_action/decrement/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Decrement a value in the specified pool", + "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", + "operationId": "decrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the decrement operation.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to decrement in the pool." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully decremented the value", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/_action/reset-increment/{pool}": { "post": { "tags": [ - "Order Management" + "Increment Storage" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", + "summary": "Reset increment values in pool", + "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", + "operationId": "resetIncrementValues", "parameters": [ { - "name": "orderTransactionId", + "name": "pool", "in": "path", - "description": "Identifier of the order transaction.", + "description": "The name of the increment pool to reset.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the reset operation.", "required": true, "schema": { "type": "string" @@ -72441,105 +74601,62 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "key": { "type": "string", - "default": "stateId" + "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." } - }, - "type": "object" + } } } } }, "responses": { "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" - } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." + "description": "Successfully reset the increment values", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - cluster parameter missing" } } } }, - "/_action/container_cache": { + "/_action/delete-increment/{pool}": { "delete": { "tags": [ - "System Operations" - ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." - } - } - } - }, - "/_action/media/{mediaId}/upload": { - "post": { - "tags": [ - "Asset Management" + "Increment Storage" ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", + "summary": "Delete increment keys from pool", + "description": "Deletes specific increment keys from the specified pool.", + "operationId": "deleteIncrementKeys", "parameters": [ { - "name": "mediaId", + "name": "pool", "in": "path", - "description": "Identifier of the media entity.", + "description": "The name of the increment pool to delete keys from.", "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", "schema": { "type": "string" } }, { - "name": "extension", + "name": "cluster", "in": "query", - "description": "Extension of the uploaded file. For example `png`", + "description": "Cluster identifier for the delete operation.", "required": true, "schema": { "type": "string" @@ -72547,72 +74664,98 @@ } ], "requestBody": { + "required": true, "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { + "type": "object", "required": [ - "url" + "keys" ], "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", - "type": "string" + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of keys to delete from the pool." } - }, - "type": "object" + } } } } }, "responses": { "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", - "schema": { - "type": "string" - } - } - } + "description": "Successfully deleted the increment keys" + }, + "400": { + "description": "Bad request - invalid keys parameter or cluster parameter missing" } } } }, - "/_action/cache_info": { - "get": { + "/_action/theme/{themeId}": { + "patch": { "tags": [ - "System Operations" + "Theme" + ], + "summary": "Update theme configuration", + "description": "Updates the configuration of a theme. The theme configuration is a collection of fields that are provided as variables in the theme's SCSS files and the templates.", + "operationId": "updateThemeConfiguration", + "parameters": [ + { + "name": "themeId", + "description": "The ID of the theme to update", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "parentThemeId", + "description": "The ID of the parent theme to inherit the configuration from.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "reset", + "description": "If true, the theme configuration will be reset to the default values from the theme.json file.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "validate", + "description": "If true, the theme configuration will be validated before being updated.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + }, + { + "name": "sanitize", + "description": "If true, the theme configuration will be sanitized during validation. before being updated. Only applies if validate is true.", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + } + } ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", "responses": { "200": { - "description": "Information about the cache state.", + "description": "Theme updated successfully.", "content": { "application/json": { "schema": { - "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" - }, - "cacheAdapter": { - "description": "The active cache adapter.", - "type": "string" - } - }, "type": "object" } } @@ -72621,27 +74764,214 @@ } } }, - "/_info/version": { + "/_action/theme/{themeId}/configuration": { "get": { "tags": [ - "System Info & Health Check" + "Theme" + ], + "summary": "Get theme configuration", + "description": "Returns the theme configuration including fields, blocks, and current values", + "operationId": "getThemeConfiguration", + "parameters": [ + { + "name": "themeId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "Returns the version of the Shopware instance.", + "description": "Theme merged configuration", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "version": { - "description": "The Shopware version.", + "fields": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "label": { + "type": "string", + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + }, + "helpText": { + "type": [ + "string", + "null" + ], + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + }, + "type": { + "type": "string" + }, + "value": { + "type": [ + "string", + "null" + ] + }, + "editable": { + "type": "boolean" + }, + "block": { + "type": [ + "string", + "null" + ] + }, + "section": { + "type": [ + "string", + "null" + ] + }, + "tab": { + "type": [ + "string", + "null" + ] + }, + "order": { + "type": [ + "integer", + "null" + ] + }, + "sectionOrder": { + "type": [ + "integer", + "null" + ] + }, + "blockOrder": { + "type": [ + "integer", + "null" + ] + }, + "tabOrder": { + "type": [ + "integer", + "null" + ] + }, + "custom": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "scss": { + "type": [ + "string", + "null" + ] + }, + "fullWidth": { + "type": [ + "boolean", + "null" + ] + } + }, + "required": [ + "name", + "label", + "type", + "value", + "editable" + ] + } + }, + "blocks": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "label": { + "type": "object", + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "label" + ] + } + }, + "configInheritance": { + "type": "array", + "items": { + "type": "string" + } + }, + "themeTechnicalName": { "type": "string" + }, + "currentFields": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "isInherited": { + "type": "boolean" + }, + "value": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "isInherited", + "value" + ] + } + }, + "baseThemeFields": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "isInherited": { + "type": "boolean" + }, + "value": { + "type": [ + "string", + "null" + ] + } + }, + "required": [ + "isInherited", + "value" + ] + } } }, - "type": "object" + "required": [ + "fields", + "blocks", + "themeTechnicalName", + "currentFields", + "baseThemeFields" + ] } } } @@ -72649,117 +74979,70 @@ } } }, - "/_action/sync": { + "/_action/theme/{themeId}/assign/{salesChannelId}": { "post": { "tags": [ - "Bulk Operations" + "Theme" ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", + "summary": "Assign theme to sales channel", + "description": "Assigns a theme to a specific sales channel", + "operationId": "assignTheme", "parameters": [ { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "name": "themeId", + "in": "path", + "required": true, "schema": { - "type": "boolean", - "default": true + "type": "string" } }, { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "name": "salesChannelId", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] + "type": "string" } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], - "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", - "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } - }, - "filter": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - } - }, + "responses": { + "200": { + "description": "Theme assigned successfully", + "content": { + "application/json": { + "schema": { "type": "object" } } } } - }, + } + } + }, + "/_action/theme/{themeId}/reset": { + "patch": { + "tags": [ + "Theme" + ], + "summary": "Reset theme configuration", + "description": "Resets the theme configuration to its default values", + "operationId": "resetTheme", + "parameters": [ + { + "name": "themeId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { - "description": "Returns a sync result containing information about the updated entities", + "description": "Theme reset successfully", "content": { "application/json": { "schema": { - "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" - }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" - }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" - } - }, "type": "object" } } @@ -72768,46 +75051,148 @@ } } }, - "/_action/message-queue/consume": { - "post": { + "/_action/theme/{themeId}/structured-fields": { + "get": { "tags": [ - "System Operations" + "Theme" ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "receiver" - ], - "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" - } - }, - "type": "object" - } + "summary": "Get theme configuration fields in structured format", + "description": "Returns the theme configuration fields in a structured format with tabs, blocks, sections and fields", + "operationId": "getThemeConfigurationStructuredFields", + "parameters": [ + { + "name": "themeId", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "Returns information about handled messages", + "description": "Structured theme configuration", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" + "tabs": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "labelSnippetKey": { + "type": "string" + }, + "label": { + "type": "string", + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + }, + "blocks": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "labelSnippetKey": { + "type": "string" + }, + "label": { + "type": "string", + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + }, + "sections": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "labelSnippetKey": { + "type": "string" + }, + "label": { + "type": "string", + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + }, + "fields": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "labelSnippetKey": { + "type": "string" + }, + "helpTextSnippetKey": { + "type": "string" + }, + "type": { + "type": "string" + }, + "custom": { + "type": [ + "object", + "null" + ], + "additionalProperties": true + }, + "fullWidth": { + "type": [ + "boolean", + "null" + ] + }, + "label": { + "type": "string", + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + }, + "helpText": { + "type": [ + "string", + "null" + ], + "deprecated": true, + "description": "This field is deprecated and will be removed in v6.8.0.0" + } + }, + "required": [ + "labelSnippetKey", + "helpTextSnippetKey", + "type", + "label" + ] + } + } + }, + "required": [ + "labelSnippetKey", + "label", + "fields" + ] + } + } + }, + "required": [ + "labelSnippetKey", + "label", + "sections" + ] + } + } + }, + "required": [ + "labelSnippetKey", + "label", + "blocks" + ] + } } }, - "type": "object" + "required": [ + "tabs" + ] } } } @@ -73499,6 +75884,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "contextGatewayUrl": { + "type": "string" + }, "inAppPurchasesGatewayUrl": { "type": "string" }, @@ -73511,6 +75899,12 @@ "selfManaged": { "type": "boolean" }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string" }, @@ -74021,6 +76415,9 @@ "checkoutGatewayUrl": { "type": "string" }, + "contextGatewayUrl": { + "type": "string" + }, "inAppPurchasesGatewayUrl": { "type": "string" }, @@ -74033,6 +76430,12 @@ "selfManaged": { "type": "boolean" }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string", "description": "Label given to an app." @@ -84597,6 +87000,37 @@ }, "type": "object" }, + "stateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "c78c7ea361b7def0876b75bd1bd37879" + } + } + } + } + }, + "type": "object" + }, "aclRoles": { "properties": { "links": { @@ -84729,6 +87163,12 @@ "app": { "$ref": "#/components/schemas/App" }, + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, "aclRoles": { "type": "array", "items": { @@ -86756,6 +89196,289 @@ }, "type": "object" }, + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "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": { + "measurementSystem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_system" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c0484ac171c930ce54e78cd2e0d80e5a" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "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" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" + } + }, + "type": "object" + }, + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "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": { + "units": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_display_unit" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "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" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } + } + }, + "type": "object" + }, "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -86783,8 +89506,7 @@ "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "type": "string" }, "uploadedAt": { "type": "string", @@ -87662,7 +90384,6 @@ }, "fileExtension": { "type": "string", - "readOnly": true, "description": "Type of file indication. For example: jpeg, png." }, "uploadedAt": { @@ -90122,6 +92843,22 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -90389,6 +93126,64 @@ }, "type": "object" }, + "primaryOrderDelivery": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" + } + } + } + }, + "type": "object" + }, + "primaryOrderTransaction": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbaa9e50388c524d97853a4fc4476b0e" + } + } + } + }, + "type": "object" + }, "orderCustomer": { "properties": { "links": { @@ -90831,6 +93626,22 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of the billing address version." }, + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$", @@ -91114,6 +93925,12 @@ "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, + "primaryOrderDelivery": { + "$ref": "#/components/schemas/OrderDelivery" + }, + "primaryOrderTransaction": { + "$ref": "#/components/schemas/OrderTransaction" + }, "orderCustomer": { "$ref": "#/components/schemas/OrderCustomer" }, @@ -92121,6 +94938,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -92297,6 +95143,9 @@ "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -93800,6 +96649,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -93941,6 +96819,9 @@ "$ref": "#/components/schemas/OrderTransactionCapture" } }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" + }, "shippingCosts": { "properties": { "calculatedTaxes": { @@ -104517,6 +107398,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, @@ -105870,6 +108754,9 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of hreflangDefaultDomain." }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string", "description": "Name of the sales channel." @@ -106410,6 +109297,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { "type": "boolean" }, @@ -106652,6 +109542,9 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of snippet set." }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { "type": "boolean", "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance." @@ -109192,6 +112085,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -109319,6 +112216,35 @@ } }, "type": "object" + }, + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -109383,6 +112309,10 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of user." }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -109405,6 +112335,9 @@ "user": { "$ref": "#/components/schemas/User" }, + "integration": { + "$ref": "#/components/schemas/Integration" + }, "entityId": { "description": "Unique identity of entity." } @@ -113339,6 +116272,369 @@ } } }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net", + "linked" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] + }, + "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" + } + } + } + }, + "properties": { + "name": { + "description": "Unique name of the businessEventsResponse." + }, + "class": { + "description": "Class name of business event." + }, + "data": { + "description": "Internal field." + }, + "aware": { + "description": "Parameter that indicates the areas in which the business event is supported." + }, + "extensions": { + "description": "Internal field." + } + } + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "Criteria": { "type": "object", "description": "Criteria to query entities.", @@ -114065,322 +117361,6 @@ "field" ] }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "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." - } - } - } - } - }, - "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" - } - } - } - }, - "properties": { - "name": { - "description": "Unique name of the businessEventsResponse." - }, - "class": { - "description": "Class name of business event." - }, - "data": { - "description": "Internal field." - }, - "aware": { - "description": "Parameter that indicates the areas in which the business event is supported." - }, - "extensions": { - "description": "Internal field." - } - } - }, - "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" - ] - } - ] - }, "Cart": { "properties": { "id": { @@ -116193,12 +119173,13 @@ "securitySchemes": { "oAuth": { "type": "oauth2", - "description": "Authentication API", + "description": "Authentication using OAuth 2.0", "flows": { "password": { - "tokenUrl": "http://localhost:8000/api/oauth/token", + "tokenUrl": "/api/oauth/token", "scopes": { - "write": "Full write access" + "write": "Full write access", + "admin": "Admin scope for administrative operations" } }, "clientCredentials": { @@ -116423,6 +119404,14 @@ "name": "Main Category", "description": "The endpoint for operations on Main Category" }, + { + "name": "Measurement Display Unit", + "description": "The endpoint for operations on Measurement Display Unit" + }, + { + "name": "Measurement System", + "description": "The endpoint for operations on Measurement System" + }, { "name": "Media", "description": "The endpoint for operations on Media" diff --git a/adminapi.summary.json b/adminapi.summary.json index 3f59c69..9541bc5 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -5,8 +5,11 @@ "/_action/cache_info", "/_action/cleanup", "/_action/container_cache", + "/_action/decrement/{pool}", + "/_action/delete-increment/{pool}", "/_action/document/{documentId}/upload", "/_action/document/{documentId}/{deepLinkCode}", + "/_action/increment/{pool}", "/_action/index", "/_action/index-products", "/_action/indexing", @@ -14,6 +17,9 @@ "/_action/mail-template/build", "/_action/mail-template/send", "/_action/mail-template/validate", + "/_action/media/external-link", + "/_action/media/upload", + "/_action/media/upload_by_url", "/_action/media/{mediaId}/upload", "/_action/message-queue/consume", "/_action/number-range/reserve/{type}/{saleschannel}", @@ -24,13 +30,20 @@ "/_action/order_delivery/{orderDeliveryId}/state/{transition}", "/_action/order_transaction/{orderTransactionId}/state/{transition}", "/_action/order_transaction_capture_refund/{refundId}", + "/_action/reset-increment/{pool}", "/_action/scheduled-task/min-run-interval", "/_action/scheduled-task/run", "/_action/sync", + "/_action/theme/{themeId}", + "/_action/theme/{themeId}/assign/{salesChannelId}", + "/_action/theme/{themeId}/configuration", + "/_action/theme/{themeId}/reset", + "/_action/theme/{themeId}/structured-fields", "/_info/config", "/_info/events.json", "/_info/flow-actions.json", "/_info/health-check", + "/_info/message-stats.json", "/_info/openapi3.json", "/_info/routes", "/_info/system-health-check", @@ -88,6 +101,8 @@ "/aggregate/mail-template", "/aggregate/mail-template-type", "/aggregate/main-category", + "/aggregate/measurement-display-unit", + "/aggregate/measurement-system", "/aggregate/media", "/aggregate/media-default-folder", "/aggregate/media-folder", @@ -190,6 +205,9 @@ "/app-script-condition/{id}", "/app-shipping-method", "/app-shipping-method/{id}", + "/app-system/privileges/requested", + "/app-system/{appName}/privileges", + "/app-system/{appName}/privileges/accepted", "/app-template", "/app-template/{id}", "/app/{id}", @@ -271,6 +289,10 @@ "/mail-template/{id}", "/main-category", "/main-category/{id}", + "/measurement-display-unit", + "/measurement-display-unit/{id}", + "/measurement-system", + "/measurement-system/{id}", "/media", "/media-default-folder", "/media-default-folder/{id}", @@ -444,6 +466,8 @@ "/search/mail-template", "/search/mail-template-type", "/search/main-category", + "/search/measurement-display-unit", + "/search/measurement-system", "/search/media", "/search/media-default-folder", "/search/media-folder", @@ -709,6 +733,11 @@ "MailTemplateTypeJsonApi", "MainCategory", "MainCategoryJsonApi", + "MeasurementDisplayUnit", + "MeasurementDisplayUnitJsonApi", + "MeasurementSystem", + "MeasurementSystemJsonApi", + "MeasurementUnits", "Media", "MediaAiTag", "MediaDefaultFolder", From 07bf6acaad1947313d2b82b9c30621c0ce6d4945 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 Oct 2025 10:56:59 +0200 Subject: [PATCH 46/63] [create-pull-request] automated change (#382) Co-authored-by: shopwareBot --- adminapi.json | 9313 ++++++++++++++++++++++++++--------------- adminapi.summary.json | 6 + 2 files changed, 5929 insertions(+), 3390 deletions(-) diff --git a/adminapi.json b/adminapi.json index d348397..710348c 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.1.2" + "version": "6.7.3.0" }, "servers": [ { @@ -210,6 +210,21 @@ "summary": "Search for the Acl Role resources.", "description": "Available since: 6.0.0.0", "operationId": "searchAclRole", + "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": { @@ -736,6 +751,21 @@ "summary": "Search for the App resources.", "description": "Available since: 6.3.1.0", "operationId": "searchApp", + "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": { @@ -1262,6 +1292,21 @@ "summary": "Search for the App Action Button resources.", "description": "Available since: 6.3.1.0", "operationId": "searchAppActionButton", + "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": { @@ -1788,6 +1833,21 @@ "summary": "Search for the App Administration Snippet resources.", "description": "Available since: 6.4.15.0", "operationId": "searchAppAdministrationSnippet", + "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": { @@ -2314,6 +2374,21 @@ "summary": "Search for the App Cms Block resources.", "description": "Available since: 6.4.2.0", "operationId": "searchAppCmsBlock", + "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": { @@ -2840,6 +2915,21 @@ "summary": "Search for the App Flow Action resources.", "description": "Available since: 6.4.10.0", "operationId": "searchAppFlowAction", + "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": { @@ -3366,6 +3456,21 @@ "summary": "Search for the App Flow Event resources.", "description": "Available since: 6.5.2.0", "operationId": "searchAppFlowEvent", + "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": { @@ -3892,6 +3997,21 @@ "summary": "Search for the App Payment Method resources.", "description": "Available since: 6.4.1.0", "operationId": "searchAppPaymentMethod", + "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": { @@ -4418,6 +4538,21 @@ "summary": "Search for the App Script Condition resources.", "description": "Available since: 6.4.10.3", "operationId": "searchAppScriptCondition", + "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": { @@ -4944,6 +5079,21 @@ "summary": "Search for the App Shipping Method resources.", "description": "Available since: 6.5.7.0", "operationId": "searchAppShippingMethod", + "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": { @@ -5470,6 +5620,21 @@ "summary": "Search for the App Template resources.", "description": "Available since: 6.3.1.0", "operationId": "searchAppTemplate", + "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": { @@ -5996,6 +6161,21 @@ "summary": "Search for the Category resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCategory", + "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": { @@ -6522,6 +6702,21 @@ "summary": "Search for the Cms Block resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsBlock", + "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": { @@ -7048,6 +7243,21 @@ "summary": "Search for the Cms Page resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsPage", + "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": { @@ -7574,6 +7784,21 @@ "summary": "Search for the Cms Section resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsSection", + "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": { @@ -8100,6 +8325,21 @@ "summary": "Search for the Cms Slot resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCmsSlot", + "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": { @@ -8626,6 +8866,21 @@ "summary": "Search for the Country resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCountry", + "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": { @@ -9152,6 +9407,21 @@ "summary": "Search for the Country State resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCountryState", + "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": { @@ -9678,6 +9948,21 @@ "summary": "Search for the Currency resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCurrency", + "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": { @@ -10204,6 +10489,21 @@ "summary": "Search for the Currency Country Rounding resources.", "description": "Available since: 6.4.0.0", "operationId": "searchCurrencyCountryRounding", + "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": { @@ -10730,6 +11030,21 @@ "summary": "Search for the Custom Entity resources.", "description": "Available since: 6.4.9.0", "operationId": "searchCustomEntity", + "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": { @@ -11256,6 +11571,21 @@ "summary": "Search for the Custom Field resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomField", + "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": { @@ -11782,6 +12112,21 @@ "summary": "Search for the Custom Field Set resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomFieldSet", + "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": { @@ -12308,6 +12653,21 @@ "summary": "Search for the Custom Field Set Relation resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomFieldSetRelation", + "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": { @@ -12834,6 +13194,21 @@ "summary": "Search for the Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomer", + "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": { @@ -13360,6 +13735,21 @@ "summary": "Search for the Customer Address resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomerAddress", + "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": { @@ -13886,6 +14276,21 @@ "summary": "Search for the Customer Group resources.", "description": "Available since: 6.0.0.0", "operationId": "searchCustomerGroup", + "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": { @@ -14412,6 +14817,21 @@ "summary": "Search for the Customer Recovery resources.", "description": "Available since: 6.1.0.0", "operationId": "searchCustomerRecovery", + "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": { @@ -14938,6 +15358,21 @@ "summary": "Search for the Customer Wishlist resources.", "description": "Available since: 6.3.4.0", "operationId": "searchCustomerWishlist", + "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": { @@ -15464,6 +15899,21 @@ "summary": "Search for the Customer Wishlist Product resources.", "description": "Available since: 6.3.4.0", "operationId": "searchCustomerWishlistProduct", + "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": { @@ -15990,6 +16440,21 @@ "summary": "Search for the Delivery Time resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDeliveryTime", + "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": { @@ -16516,6 +16981,21 @@ "summary": "Search for the Document resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocument", + "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": { @@ -17042,6 +17522,21 @@ "summary": "Search for the Document Base Config resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocumentBaseConfig", + "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": { @@ -17568,6 +18063,21 @@ "summary": "Search for the Document Base Config Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocumentBaseConfigSalesChannel", + "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": { @@ -18094,6 +18604,21 @@ "summary": "Search for the Document Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchDocumentType", + "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": { @@ -18620,6 +19145,21 @@ "summary": "Search for the Flow resources.", "description": "Available since: 6.4.6.0", "operationId": "searchFlow", + "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": { @@ -19146,6 +19686,21 @@ "summary": "Search for the Flow Sequence resources.", "description": "Available since: 6.4.6.0", "operationId": "searchFlowSequence", + "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": { @@ -19672,6 +20227,21 @@ "summary": "Search for the Flow Template resources.", "description": "Available since: 6.4.18.0", "operationId": "searchFlowTemplate", + "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": { @@ -20198,6 +20768,21 @@ "summary": "Search for the Import Export File resources.", "description": "Available since: 6.0.0.0", "operationId": "searchImportExportFile", + "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": { @@ -20724,6 +21309,21 @@ "summary": "Search for the Import Export Log resources.", "description": "Available since: 6.0.0.0", "operationId": "searchImportExportLog", + "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": { @@ -21250,6 +21850,21 @@ "summary": "Search for the Import Export Profile resources.", "description": "Available since: 6.0.0.0", "operationId": "searchImportExportProfile", + "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": { @@ -21776,6 +22391,21 @@ "summary": "Search for the Integration resources.", "description": "Available since: 6.0.0.0", "operationId": "searchIntegration", + "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": { @@ -22302,6 +22932,21 @@ "summary": "Search for the Landing Page resources.", "description": "Available since: 6.4.0.0", "operationId": "searchLandingPage", + "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": { @@ -22828,6 +23473,21 @@ "summary": "Search for the Language resources.", "description": "Available since: 6.0.0.0", "operationId": "searchLanguage", + "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": { @@ -23354,6 +24014,21 @@ "summary": "Search for the Locale resources.", "description": "Available since: 6.0.0.0", "operationId": "searchLocale", + "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": { @@ -23880,6 +24555,21 @@ "summary": "Search for the Log Entry resources.", "description": "Available since: 6.0.0.0", "operationId": "searchLogEntry", + "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": { @@ -24406,6 +25096,21 @@ "summary": "Search for the Mail Header Footer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMailHeaderFooter", + "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": { @@ -24932,6 +25637,21 @@ "summary": "Search for the Mail Template resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMailTemplate", + "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": { @@ -25458,6 +26178,21 @@ "summary": "Search for the Mail Template Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMailTemplateType", + "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": { @@ -25984,6 +26719,21 @@ "summary": "Search for the Main Category resources.", "description": "Available since: 6.1.0.0", "operationId": "searchMainCategory", + "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": { @@ -26510,6 +27260,21 @@ "summary": "Search for the Measurement Display Unit resources.", "description": "Available since: 6.7.1.0", "operationId": "searchMeasurementDisplayUnit", + "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": { @@ -27036,6 +27801,21 @@ "summary": "Search for the Measurement System resources.", "description": "Available since: 6.7.1.0", "operationId": "searchMeasurementSystem", + "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": { @@ -27562,6 +28342,21 @@ "summary": "Search for the Media resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMedia", + "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": { @@ -28088,6 +28883,21 @@ "summary": "Search for the Media Default Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaDefaultFolder", + "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": { @@ -28614,6 +29424,21 @@ "summary": "Search for the Media Folder resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaFolder", + "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": { @@ -29140,6 +29965,21 @@ "summary": "Search for the Media Folder Configuration resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaFolderConfiguration", + "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": { @@ -29666,6 +30506,21 @@ "summary": "Search for the Media Thumbnail resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaThumbnail", + "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": { @@ -30192,6 +31047,21 @@ "summary": "Search for the Media Thumbnail Size resources.", "description": "Available since: 6.0.0.0", "operationId": "searchMediaThumbnailSize", + "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": { @@ -30718,6 +31588,21 @@ "summary": "Search for the Newsletter Recipient resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNewsletterRecipient", + "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": { @@ -31244,6 +32129,21 @@ "summary": "Search for the Notification resources.", "description": "Available since: 6.4.7.0", "operationId": "searchNotification", + "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": { @@ -31770,6 +32670,21 @@ "summary": "Search for the Number Range resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRange", + "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": { @@ -32296,6 +33211,21 @@ "summary": "Search for the Number Range Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRangeSalesChannel", + "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": { @@ -32822,6 +33752,21 @@ "summary": "Search for the Number Range State resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRangeState", + "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": { @@ -33348,6 +34293,21 @@ "summary": "Search for the Number Range Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchNumberRangeType", + "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": { @@ -33874,6 +34834,21 @@ "summary": "Search for the Order resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrder", + "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": { @@ -34400,6 +35375,21 @@ "summary": "Search for the Order Address resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderAddress", + "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": { @@ -34926,6 +35916,21 @@ "summary": "Search for the Order Customer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderCustomer", + "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": { @@ -35452,6 +36457,21 @@ "summary": "Search for the Order Delivery resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderDelivery", + "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": { @@ -35978,6 +36998,21 @@ "summary": "Search for the Order Delivery Position resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderDeliveryPosition", + "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": { @@ -36504,6 +37539,21 @@ "summary": "Search for the Order Line Item resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderLineItem", + "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": { @@ -37030,6 +38080,21 @@ "summary": "Search for the Order Line Item Download resources.", "description": "Available since: 6.4.19.0", "operationId": "searchOrderLineItemDownload", + "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": { @@ -37556,6 +38621,21 @@ "summary": "Search for the Order Transaction resources.", "description": "Available since: 6.0.0.0", "operationId": "searchOrderTransaction", + "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": { @@ -38082,6 +39162,21 @@ "summary": "Search for the Order Transaction Capture resources.", "description": "Available since: 6.4.12.0", "operationId": "searchOrderTransactionCapture", + "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": { @@ -38608,6 +39703,21 @@ "summary": "Search for the Order Transaction Capture Refund resources.", "description": "Available since: 6.4.12.0", "operationId": "searchOrderTransactionCaptureRefund", + "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": { @@ -39134,6 +40244,21 @@ "summary": "Search for the Order Transaction Capture Refund Position resources.", "description": "Available since: 6.4.12.0", "operationId": "searchOrderTransactionCaptureRefundPosition", + "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": { @@ -39660,6 +40785,21 @@ "summary": "Search for the Payment Method resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPaymentMethod", + "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": { @@ -40186,6 +41326,21 @@ "summary": "Search for the Plugin resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPlugin", + "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": { @@ -40712,6 +41867,21 @@ "summary": "Search for the Product resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProduct", + "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": { @@ -41238,6 +42408,21 @@ "summary": "Search for the Product Configurator Setting resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductConfiguratorSetting", + "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": { @@ -41764,6 +42949,21 @@ "summary": "Search for the Product Cross Selling resources.", "description": "Available since: 6.1.0.0", "operationId": "searchProductCrossSelling", + "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": { @@ -42290,6 +43490,21 @@ "summary": "Search for the Product Cross Selling Assigned Products resources.", "description": "Available since: 6.2.0.0", "operationId": "searchProductCrossSellingAssignedProducts", + "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": { @@ -42816,6 +44031,21 @@ "summary": "Search for the Product Download resources.", "description": "Available since: 6.4.19.0", "operationId": "searchProductDownload", + "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": { @@ -43342,6 +44572,21 @@ "summary": "Search for the Product Export resources.", "description": "Available since: 6.1.0.0", "operationId": "searchProductExport", + "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": { @@ -43868,6 +45113,21 @@ "summary": "Search for the Product Feature Set resources.", "description": "Available since: 6.3.0.0", "operationId": "searchProductFeatureSet", + "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": { @@ -44394,6 +45654,21 @@ "summary": "Search for the Product Keyword Dictionary resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductKeywordDictionary", + "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": { @@ -44920,6 +46195,21 @@ "summary": "Search for the Product Manufacturer resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductManufacturer", + "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": { @@ -45446,6 +46736,21 @@ "summary": "Search for the Product Media resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductMedia", + "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": { @@ -45972,6 +47277,21 @@ "summary": "Search for the Product Price resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductPrice", + "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": { @@ -46498,6 +47818,21 @@ "summary": "Search for the Product Review resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductReview", + "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": { @@ -47024,6 +48359,21 @@ "summary": "Search for the Product Search Config resources.", "description": "Available since: 6.3.5.0", "operationId": "searchProductSearchConfig", + "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": { @@ -47550,6 +48900,21 @@ "summary": "Search for the Product Search Config Field resources.", "description": "Available since: 6.3.5.0", "operationId": "searchProductSearchConfigField", + "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": { @@ -48076,6 +49441,21 @@ "summary": "Search for the Product Search Keyword resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductSearchKeyword", + "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": { @@ -48602,6 +49982,21 @@ "summary": "Search for the Product Sorting resources.", "description": "Available since: 6.3.2.0", "operationId": "searchProductSorting", + "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": { @@ -49128,6 +50523,21 @@ "summary": "Search for the Product Stream resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductStream", + "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": { @@ -49654,6 +51064,21 @@ "summary": "Search for the Product Stream Filter resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductStreamFilter", + "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": { @@ -50180,6 +51605,21 @@ "summary": "Search for the Product Visibility resources.", "description": "Available since: 6.0.0.0", "operationId": "searchProductVisibility", + "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": { @@ -50706,6 +52146,21 @@ "summary": "Search for the Promotion resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotion", + "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": { @@ -51232,6 +52687,21 @@ "summary": "Search for the Promotion Discount resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionDiscount", + "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": { @@ -51758,6 +53228,21 @@ "summary": "Search for the Promotion Discount Prices resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionDiscountPrices", + "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": { @@ -52284,6 +53769,21 @@ "summary": "Search for the Promotion Individual Code resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionIndividualCode", + "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": { @@ -52810,6 +54310,21 @@ "summary": "Search for the Promotion Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionSalesChannel", + "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": { @@ -53336,6 +54851,21 @@ "summary": "Search for the Promotion Setgroup resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPromotionSetgroup", + "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": { @@ -53862,6 +55392,21 @@ "summary": "Search for the Property Group resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPropertyGroup", + "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": { @@ -54388,6 +55933,21 @@ "summary": "Search for the Property Group Option resources.", "description": "Available since: 6.0.0.0", "operationId": "searchPropertyGroupOption", + "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": { @@ -54914,6 +56474,21 @@ "summary": "Search for the Rule resources.", "description": "Available since: 6.0.0.0", "operationId": "searchRule", + "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": { @@ -55440,6 +57015,21 @@ "summary": "Search for the Rule Condition resources.", "description": "Available since: 6.0.0.0", "operationId": "searchRuleCondition", + "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": { @@ -55966,6 +57556,21 @@ "summary": "Search for the Sales Channel resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalesChannel", + "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": { @@ -56492,6 +58097,21 @@ "summary": "Search for the Sales Channel Analytics resources.", "description": "Available since: 6.2.0.0", "operationId": "searchSalesChannelAnalytics", + "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": { @@ -57018,6 +58638,21 @@ "summary": "Search for the Sales Channel Domain resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalesChannelDomain", + "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": { @@ -57544,6 +59179,21 @@ "summary": "Search for the Sales Channel Type resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalesChannelType", + "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": { @@ -58070,6 +59720,21 @@ "summary": "Search for the Salutation resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSalutation", + "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": { @@ -58596,6 +60261,21 @@ "summary": "Search for the Scheduled Task resources.", "description": "Available since: 6.0.0.0", "operationId": "searchScheduledTask", + "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": { @@ -59122,6 +60802,21 @@ "summary": "Search for the Script resources.", "description": "Available since: 6.4.7.0", "operationId": "searchScript", + "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": { @@ -59648,6 +61343,21 @@ "summary": "Search for the Seo Url resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSeoUrl", + "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": { @@ -60174,6 +61884,21 @@ "summary": "Search for the Seo Url Template resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSeoUrlTemplate", + "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": { @@ -60700,6 +62425,21 @@ "summary": "Search for the Shipping Method resources.", "description": "Available since: 6.0.0.0", "operationId": "searchShippingMethod", + "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": { @@ -61226,6 +62966,21 @@ "summary": "Search for the Shipping Method Price resources.", "description": "Available since: 6.0.0.0", "operationId": "searchShippingMethodPrice", + "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": { @@ -61752,282 +63507,297 @@ "summary": "Search for the Snippet resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSnippet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/snippet/{id}": { - "get": { - "tags": [ - "Snippet" - ], - "summary": "Detailed information about a Snippet resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Snippet" - ], - "summary": "Delete a Snippet resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSnippet", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the snippet", - "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": [ - "Snippet" - ], - "summary": "Partially update information about a Snippet resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSnippet", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the snippet", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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 Snippet resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Snippet" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Snippet" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/snippet": { - "post": { - "tags": [ - "Snippet" ], - "summary": "Aggregate for the Snippet resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippet", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/snippet/{id}": { + "get": { + "tags": [ + "Snippet" + ], + "summary": "Detailed information about a Snippet resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Snippet" + ], + "summary": "Delete a Snippet resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet", + "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": [ + "Snippet" + ], + "summary": "Partially update information about a Snippet resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSnippet", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the snippet", + "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 Snippet resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Snippet" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Snippet", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Snippet" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/snippet": { + "post": { + "tags": [ + "Snippet" + ], + "summary": "Aggregate for the Snippet resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSnippet", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -62278,6 +64048,21 @@ "summary": "Search for the Snippet Set resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSnippetSet", + "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": { @@ -62804,6 +64589,21 @@ "summary": "Search for the State Machine resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachine", + "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": { @@ -63330,282 +65130,297 @@ "summary": "Search for the State Machine History resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachineHistory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/state-machine-history/{id}": { - "get": { - "tags": [ - "State Machine History" - ], - "summary": "Detailed information about a State Machine History resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getStateMachineHistory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_history", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "State Machine History" - ], - "summary": "Delete a State Machine History resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteStateMachineHistory", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_history", - "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": [ - "State Machine History" - ], - "summary": "Partially update information about a State Machine History resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateStateMachineHistory", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the state_machine_history", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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 State Machine History resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/state-machine-history": { - "post": { - "tags": [ - "State Machine History" ], - "summary": "Aggregate for the State Machine History resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineHistory", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/state-machine-history/{id}": { + "get": { + "tags": [ + "State Machine History" + ], + "summary": "Detailed information about a State Machine History resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getStateMachineHistory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_history", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "State Machine History" + ], + "summary": "Delete a State Machine History resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteStateMachineHistory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_history", + "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": [ + "State Machine History" + ], + "summary": "Partially update information about a State Machine History resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateStateMachineHistory", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the state_machine_history", + "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 State Machine History resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of StateMachineHistory", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/StateMachineHistory" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/state-machine-history": { + "post": { + "tags": [ + "State Machine History" + ], + "summary": "Aggregate for the State Machine History resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateStateMachineHistory", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -63856,6 +65671,21 @@ "summary": "Search for the State Machine State resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachineState", + "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": { @@ -64382,6 +66212,21 @@ "summary": "Search for the State Machine Transition resources.", "description": "Available since: 6.0.0.0", "operationId": "searchStateMachineTransition", + "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": { @@ -64908,282 +66753,297 @@ "summary": "Search for the System Config resources.", "description": "Available since: 6.0.0.0", "operationId": "searchSystemConfig", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/system-config/{id}": { - "get": { - "tags": [ - "System Config" - ], - "summary": "Detailed information about a System Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getSystemConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the system_config", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "System Config" - ], - "summary": "Delete a System Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteSystemConfig", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the system_config", - "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": [ - "System Config" - ], - "summary": "Partially update information about a System Config resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateSystemConfig", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the system_config", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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 System Config resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/system-config": { - "post": { - "tags": [ - "System Config" ], - "summary": "Aggregate for the System Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSystemConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/system-config/{id}": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Detailed information about a System Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getSystemConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the system_config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "System Config" + ], + "summary": "Delete a System Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteSystemConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the system_config", + "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": [ + "System Config" + ], + "summary": "Partially update information about a System Config resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateSystemConfig", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the system_config", + "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 System Config resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SystemConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SystemConfig" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/system-config": { + "post": { + "tags": [ + "System Config" + ], + "summary": "Aggregate for the System Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSystemConfig", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -65434,6 +67294,21 @@ "summary": "Search for the Tag resources.", "description": "Available since: 6.0.0.0", "operationId": "searchTag", + "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": { @@ -65960,6 +67835,21 @@ "summary": "Search for the Tax resources.", "description": "Available since: 6.0.0.0", "operationId": "searchTax", + "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": { @@ -66486,282 +68376,297 @@ "summary": "Search for the Tax Provider resources.", "description": "Available since: 6.5.0.0", "operationId": "searchTaxProvider", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/tax-provider/{id}": { - "get": { - "tags": [ - "Tax Provider" - ], - "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 tax_provider", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Tax Provider" - ], - "summary": "Delete a Tax Provider resource.", - "description": "Available since: 6.5.0.0", - "operationId": "deleteTaxProvider", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the tax_provider", - "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": [ - "Tax Provider" - ], - "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 tax_provider", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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 Tax Provider resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/tax-provider": { - "post": { - "tags": [ - "Tax Provider" ], - "summary": "Aggregate for the Tax Provider resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxProvider", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/tax-provider/{id}": { + "get": { + "tags": [ + "Tax Provider" + ], + "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 tax_provider", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Tax Provider" + ], + "summary": "Delete a Tax Provider resource.", + "description": "Available since: 6.5.0.0", + "operationId": "deleteTaxProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the tax_provider", + "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": [ + "Tax Provider" + ], + "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 tax_provider", + "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 Tax Provider resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of TaxProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/TaxProvider" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/tax-provider": { + "post": { + "tags": [ + "Tax Provider" + ], + "summary": "Aggregate for the Tax Provider resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTaxProvider", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -67012,6 +68917,21 @@ "summary": "Search for the Tax Rule resources.", "description": "Available since: 6.1.0.0", "operationId": "searchTaxRule", + "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": { @@ -67538,6 +69458,21 @@ "summary": "Search for the Tax Rule Type resources.", "description": "Available since: 6.1.0.0", "operationId": "searchTaxRuleType", + "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": { @@ -68064,282 +69999,297 @@ "summary": "Search for the Theme resources.", "description": "Available since: 6.0.0.0", "operationId": "searchTheme", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/theme/{id}": { - "get": { - "tags": [ - "Theme" - ], - "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 theme", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Theme" - ], - "summary": "Delete a Theme resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteTheme", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the theme", - "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": [ - "Theme" - ], - "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 theme", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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 Theme resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Theme" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/Theme" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/theme": { - "post": { - "tags": [ - "Theme" ], - "summary": "Aggregate for the Theme resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTheme", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/theme/{id}": { + "get": { + "tags": [ + "Theme" + ], + "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 theme", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Theme" + ], + "summary": "Delete a Theme resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteTheme", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the theme", + "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": [ + "Theme" + ], + "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 theme", + "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 Theme resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Theme" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Theme", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Theme" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/theme": { + "post": { + "tags": [ + "Theme" + ], + "summary": "Aggregate for the Theme resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateTheme", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -68590,6 +70540,21 @@ "summary": "Search for the Unit resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUnit", + "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": { @@ -69116,6 +71081,21 @@ "summary": "Search for the User resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUser", + "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": { @@ -69642,282 +71622,297 @@ "summary": "Search for the User Access Key resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUserAccessKey", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/user-access-key/{id}": { - "get": { - "tags": [ - "User Access Key" - ], - "summary": "Detailed information about a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getUserAccessKey", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_access_key", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "User Access Key" - ], - "summary": "Delete a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteUserAccessKey", "parameters": [ { - "name": "id", - "in": "path", - "description": "Identifier for the user_access_key", - "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 Access Key" - ], - "summary": "Partially update information about a User Access Key resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateUserAccessKey", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the user_access_key", - "required": true, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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 Access Key resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/user-access-key": { - "post": { - "tags": [ - "User Access Key" ], - "summary": "Aggregate for the User Access Key resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserAccessKey", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "List of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/user-access-key/{id}": { + "get": { + "tags": [ + "User Access Key" + ], + "summary": "Detailed information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getUserAccessKey", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_access_key", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "User Access Key" + ], + "summary": "Delete a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteUserAccessKey", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_access_key", + "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 Access Key" + ], + "summary": "Partially update information about a User Access Key resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateUserAccessKey", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the user_access_key", + "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 Access Key resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of UserAccessKey", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/UserAccessKey" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/user-access-key": { + "post": { + "tags": [ + "User Access Key" + ], + "summary": "Aggregate for the User Access Key resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateUserAccessKey", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] } } } @@ -70168,6 +72163,21 @@ "summary": "Search for the User Config resources.", "description": "Available since: 6.3.5.0", "operationId": "searchUserConfig", + "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": { @@ -70694,6 +72704,21 @@ "summary": "Search for the User Recovery resources.", "description": "Available since: 6.0.0.0", "operationId": "searchUserRecovery", + "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": { @@ -71220,282 +73245,297 @@ "summary": "Search for the Webhook resources.", "description": "Available since: 6.3.1.0", "operationId": "searchWebhook", - "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, + "name": "sw-include-search-info", + "in": "header", + "description": "Controls whether API search information is included in the response. Default is 1 (enabled), will be 0 (disabled) in the next major version.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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" - } - } - } - } + "enum": [ + "0", + "1" + ], + "default": "1" } - }, - "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" - ] + "$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" + ] } } } @@ -71746,6 +73786,21 @@ "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": { @@ -72077,46 +74132,21 @@ } } }, - "/_action/message-queue/consume": { - "post": { + "/_info/flow-actions.json": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "receiver" - ], - "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" - } - }, - "type": "object" - } - } - } - }, + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", "responses": { "200": { - "description": "Returns information about handled messages", + "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { - "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" - } - }, - "type": "object" + "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } @@ -72124,84 +74154,110 @@ } } }, - "/_info/health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", - "responses": { - "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" - } - } - } - }, - "/_info/system-health-check": { + "/_info/config": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", - "parameters": [ - { - "name": "verbose", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - }, - "description": "Include detailed information in the response" - } - ], + "summary": "Get public runtime config & feature metadata", + "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", + "operationId": "config", "responses": { "200": { - "description": "Returns the system health check results", + "description": "Public runtime configuration & feature metadata returned.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } + "$ref": "#/components/schemas/infoConfigResponse" + }, + "example": { + "version": "6.7.2.0", + "shopId": "NoiU8PfJtu7NBY8M", + "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", + "adminWorker": { + "enableAdminWorker": true, + "enableQueueStatsWorker": true, + "enableNotificationWorker": true, + "transports": [ + "async", + "low_priority" + ] + }, + "bundles": { + "Administration": { + "css": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" + ], + "js": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" + ], + "baseUrl": null, + "type": "plugin" + }, + "Storefront": { + "css": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" + ], + "js": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" + ], + "baseUrl": null, + "type": "plugin" + } + }, + "settings": { + "enableUrlFeature": true, + "appUrlReachable": true, + "appsRequireAppUrl": false, + "private_allowed_extensions": [ + "jpg", + "jpeg", + "png", + "webp", + "avif", + "gif", + "svg", + "bmp", + "tiff", + "tif", + "eps", + "webm", + "mkv", + "flv", + "ogv", + "ogg", + "mov", + "mp4", + "avi", + "wmv", + "pdf", + "aac", + "mp3", + "wav", + "flac", + "oga", + "wma", + "txt", + "doc", + "docx", + "ico", + "glb", + "zip", + "rar", + "csv", + "xls", + "xlsx", + "html", + "xml" + ], + "enableHtmlSanitizer": true, + "enableStagingMode": false, + "disableExtensionManagement": false + }, + "inAppPurchases": [] } } } - }, - "500": { - "description": "Application is not working properly" } } } @@ -72280,197 +74336,551 @@ } } }, - "/_action/mail-template/send": { + "/_action/index-products": { "post": { "tags": [ - "Mail Operations" + "System Operations" + ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." + } + } + } + }, + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", + "parameters": [ + { + "name": "orderDeliveryId", + "in": "path", + "description": "Identifier of the order delivery.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" + "sendMail": { + "description": "Controls if a mail should be send to the customer." }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", + "documentIds": { + "description": "A list of document identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], + "mediaIds": { + "description": "A list of media identifiers that should be attached", "type": "array", "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", + "stateFieldName": { + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", "type": "string" } }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, + "/_action/increment/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Increment a value in the specified pool", + "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", + "operationId": "incrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the increment operation.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to increment in the pool." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully incremented the value", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", + } + } + } + } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" + } + } + }, + "get": { + "tags": [ + "Increment Storage" + ], + "summary": "List increment values from pool", + "description": "Retrieves a list of increment values from the specified pool with pagination support.", + "operationId": "getIncrementValues", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to list values from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the increment operation.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum number of items to return.", + "required": false, + "schema": { + "type": "integer", + "default": 5, + "minimum": 1 + } + }, + { + "name": "offset", + "in": "query", + "description": "Number of items to skip for pagination.", + "required": false, + "schema": { + "type": "integer", + "default": 0, + "minimum": 0 + } + } + ], + "responses": { + "200": { + "description": "List of increment values", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" + "properties": { + "key": { + "type": "string", + "description": "The increment key" + }, + "count": { + "type": "integer", + "description": "The current count value" + } } } - }, - "type": "object" + } + } + } + }, + "400": { + "description": "Bad request - cluster parameter missing" + } + } + } + }, + "/_action/decrement/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Decrement a value in the specified pool", + "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", + "operationId": "decrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the decrement operation.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to decrement in the pool." + } + } } } } }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "Successfully decremented the value", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "success": { + "type": "boolean", + "example": true } - }, - "type": "object" + } } } } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, - "/_action/mail-template/validate": { + "/_action/reset-increment/{pool}": { "post": { "tags": [ - "Mail Operations" + "Increment Storage" + ], + "summary": "Reset increment values in pool", + "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", + "operationId": "resetIncrementValues", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to reset.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the reset operation.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully reset the increment values", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - cluster parameter missing" + } + } + } + }, + "/_action/delete-increment/{pool}": { + "delete": { + "tags": [ + "Increment Storage" + ], + "summary": "Delete increment keys from pool", + "description": "Deletes specific increment keys from the specified pool.", + "operationId": "deleteIncrementKeys", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to delete keys from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the delete operation.", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", "requestBody": { "required": true, "content": { "application/json": { "schema": { + "type": "object", "required": [ - "contentHtml", - "contentPlain" + "keys" ], "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of keys to delete from the pool." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully deleted the increment keys" + }, + "400": { + "description": "Bad request - invalid keys parameter or cluster parameter missing" + } + } + } + }, + "/_action/media/{mediaId}/upload": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "description": "Identifier of the media entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `png`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the media file that will be downloaded.", "type": "string" } }, @@ -72481,57 +74891,301 @@ }, "responses": { "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", + "schema": { + "type": "string" + } + } + } } } } }, - "/_action/mail-template/build": { + "/_action/media/upload": { "post": { "tags": [ - "Mail Operations" + "Asset Management" ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", + "summary": "Upload a new media file", + "description": "Creates a new media entity and uploads a file to it using form-data file upload.", + "operationId": "uploadV2", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The file to upload" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the uploaded file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" + } + }, + "required": [ + "file" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Media file uploaded successfully", + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } + } + } + } + } + } + } + }, + "/_action/media/upload_by_url": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Upload a media file from URL", + "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", + "operationId": "uploadByUrl", + "requestBody": { + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL of the file to download and upload" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the uploaded file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" + } + }, + "required": [ + "url" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Media file uploaded successfully", + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } + } + } + } + } + } + } + }, + "/_action/media/external-link": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Create external media link", + "description": "Creates a new media entity that links to an external URL without downloading the file.", + "operationId": "externalLink", + "requestBody": { + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL of the external media file" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on path" + } + }, + "required": [ + "url", + "mimeType" + ] + } + } + } + }, + "responses": { + "200": { + "description": "External media link created successfully", + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } + } + } + } + } + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", + "responses": { + "200": { + "description": "Information about the cache state.", + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "mailTemplateType", - "mailTemplate" + "customerId", + "salesChannelId" ], - "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" } }, "type": "object" @@ -72541,11 +75195,17 @@ }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "The generated customer impersonation token.", "content": { "application/json": { "schema": { - "type": "string" + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" } } } @@ -72624,111 +75284,73 @@ } } }, - "/_info/version": { - "get": { + "/_action/cache": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_proxy/generate-imitate-customer-token": { - "post": { + "/_action/cache-delayed": { + "delete": { "tags": [ - "Customer impersonation" + "System Operations" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "customerId", - "salesChannelId" - ], - "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" - }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" - } - }, - "type": "object" - } - } + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } - }, + } + } + }, + "/_action/container_cache": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "responses": { - "200": { - "description": "The generated customer impersonation token.", - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." } } } }, - "/_action/cache_info": { + "/oauth/sso/config": { "get": { "tags": [ - "System Operations" + "Authorization & Authentication", + "SSO Login configuration" ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", + "summary": "Loads configuration for the admin login", + "description": "Loads the configuration for the admin login. This configuration is used to load and configure the default or Single Sign On (SSO) login for the admin.", + "operationId": "loadSsoLoginConfig", "responses": { "200": { - "description": "Information about the cache state.", + "description": "Config loaded successfully.", "content": { "application/json": { "schema": { "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", + "useDefault": { + "description": "Experimental: Indicates which login is used. Default or SSO.", "type": "boolean" }, - "cacheAdapter": { - "description": "The active cache adapter.", + "url": { + "description": "Experimental: Contains the return url for the Shopware SSO login.", "type": "string" } }, @@ -72740,21 +75362,25 @@ } } }, - "/_info/events.json": { + "/oauth/sso/code": { "get": { "tags": [ - "System Info & Health Check" + "Authorization & Authentication", + "SSO Login callback" ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + "summary": "Callback function. Fetch an authorization code", + "description": "Fetch an authorization code log in the user.", + "operationId": "callBackWithCode", "responses": { + "302": { + "description": "Experimental: Forwards to the Shopware admin" + }, "200": { - "description": "Returns a list of about the business events.", + "description": "Authorisation process continues", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/businessEventsResponse" + "type": "object" } } } @@ -72762,17 +75388,50 @@ } } }, - "/_action/cleanup": { - "delete": { + "/oauth/sso/auth": { + "get": { "tags": [ - "System Operations" + "Experimental", + "SSO Login forward" ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", + "summary": "Experimental: Redirect to SSO login", + "description": "Experimental: Creates a redirection to the SSO login page", + "operationId": "ssoAuth", "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "302": { + "description": "Experimental: Forwards to SSO login Page" + } + } + } + }, + "/_info/is-sso": { + "get": { + "tags": [ + "Experimental", + "Is SSO environment" + ], + "summary": "Experimental: Is SSO environment", + "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", + "operationId": "isSso", + "responses": { + "200": { + "description": "Experimental: Returns if it is a SSO environment or not" + } + } + } + }, + "/_action/sso/invite-user": { + "post": { + "tags": [ + "Experimental", + "Invite a new SSO user" + ], + "summary": "Experimental: Invite a new SSO user", + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", + "operationId": "inviteUser", + "responses": { + "200": { + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" } } } @@ -72781,6 +75440,9 @@ "get": { "summary": "Get API routes", "operationId": "getRoutes", + "tags": [ + "System Info & Health Check" + ], "responses": { "200": { "description": "Successful operation", @@ -72821,6 +75483,125 @@ } } }, + "/_action/sync": { + "post": { + "tags": [ + "Bulk Operations" + ], + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", + "parameters": [ + { + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", + "schema": { + "type": "boolean", + "default": true + } + }, + { + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "schema": { + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "filter": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + } + }, + "type": "object" + } + } + } + } + }, + "responses": { + "200": { + "description": "Returns a sync result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" + } + }, + "type": "object" + } + } + } + } + } + } + }, "/_action/document/{documentId}/{deepLinkCode}": { "get": { "tags": [ @@ -72961,249 +75742,135 @@ } } }, - "/_action/sync": { - "post": { - "tags": [ - "Bulk Operations" - ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", - "parameters": [ - { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", - "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], - "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", - "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } - }, - "filter": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - } - }, - "type": "object" - } - } - } - } - }, - "responses": { - "200": { - "description": "Returns a sync result containing information about the updated entities", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" - }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" - }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/oauth/token": { + "/_action/message-queue/consume": { "post": { "tags": [ - "Authorization & Authentication" + "System Operations" ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + "required": [ + "receiver" + ], + "properties": { + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" } - ] + }, + "type": "object" } } } }, "responses": { "200": { - "description": "Authorized successfully.", + "description": "Returns information about handled messages", "content": { "application/json": { "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", + "handledMessages": { + "description": "The number of messages processed.", "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" } - }, - "type": "object" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - } - } - } - }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { - "tags": [ - "Document Management" - ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" + }, + "type": "object" + } + } } } + } + } + }, + "/_info/events.json": { + "get": { + "tags": [ + "System Info & Health Check" ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { "200": { - "description": "The generated number", + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } + } + } + } + }, + "/_info/message-stats.json": { + "get": { + "summary": "Get statistics message queue", + "description": "Get statistics for recently processed messages in the message queue", + "operationId": "getMessageStats", + "tags": [ + "System Info & Health Check" + ], + "responses": { + "200": { + "description": "Statistics received", "content": { "application/json": { "schema": { + "type": "object", + "required": [ + "enabled" + ], "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" + "enabled": { + "type": "boolean", + "description": "Whether message queue statistics are enabled in configuration" + }, + "stats": { + "type": [ + "object", + "null" + ], + "properties": { + "totalMessagesProcessed": { + "type": "integer" + }, + "processedSince": { + "type": "string", + "format": "date-time" + }, + "averageTimeInQueue": { + "type": "number", + "format": "float" + }, + "messageTypeStats": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "count": { + "type": "integer" + } + } + } + } + } } - }, - "type": "object" + } } } } - }, - "400": { - "description": "Number range not found" } } } @@ -73410,130 +76077,77 @@ ] } }, - "/_action/media/{mediaId}/upload": { + "/_action/cleanup": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cleanup finished." + } + } + } + }, + "/_action/order_transaction_capture_refund/{refundId}": { "post": { "tags": [ - "Asset Management" + "Order Management" ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", "parameters": [ { - "name": "mediaId", + "name": "refundId", "in": "path", - "description": "Identifier of the media entity.", + "description": "Identifier of the order transaction capture refund.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `png`", - "required": true, - "schema": { - "type": "string" - } } ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, "responses": { "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", - "schema": { - "type": "string" - } - } - } + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" } } } }, - "/_action/media/upload": { + "/oauth/token": { "post": { "tags": [ - "Asset Management" + "Authorization & Authentication" ], - "summary": "Upload a new media file", - "description": "Creates a new media entity and uploads a file to it using form-data file upload.", - "operationId": "uploadV2", + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", "requestBody": { + "required": true, "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The file to upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" } - }, - "required": [ - "file" ] } } @@ -73541,190 +76155,73 @@ }, "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "Authorized successfully.", "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", + "required": [ + "token_type", + "expires_in", + "access_token" + ], "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "token_type": { + "description": "Type of the token.", + "type": "string" + }, + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "type": "string" } - } - } - } - } - } - } - } - }, - "/_action/media/upload_by_url": { - "post": { - "tags": [ - "Asset Management" - ], - "summary": "Upload a media file from URL", - "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", - "operationId": "uploadByUrl", - "requestBody": { - "content": { - "application\\/json": { - "schema": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "URL of the file to download and upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" - } - }, - "required": [ - "url" - ] - } - } - } - }, - "responses": { - "200": { - "description": "Media file uploaded successfully", - "content": { - "application\\/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" - } - } + "type": "object" } } } + }, + "400": { + "$ref": "#/components/responses/400" } } } }, - "/_action/media/external-link": { + "/_action/index": { "post": { "tags": [ - "Asset Management" + "System Operations" ], - "summary": "Create external media link", - "description": "Creates a new media entity that links to an external URL without downloading the file.", - "operationId": "externalLink", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", "requestBody": { "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", "properties": { - "url": { - "type": "string", - "description": "URL of the external media file" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on path" + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } } }, - "required": [ - "url", - "mimeType" - ] + "type": "object" } } } }, "responses": { - "200": { - "description": "External media link created successfully", - "content": { - "application\\/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" - } - } - } - } - } - } - } - } - }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" - } - } - } + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." } } } @@ -73748,96 +76245,8 @@ "description": "Success message", "type": "string" } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/scheduled-task/min-run-interval": { - "get": { - "tags": [ - "System Operations" - ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", - "responses": { - "200": { - "description": "Returns the minimum interval.", - "content": { - "application/json": { - "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_info/message-stats.json": { - "get": { - "summary": "Get statistics for recently processed messages in the message queue", - "operationId": "getMessageStats", - "responses": { - "200": { - "description": "Statistics received", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether message queue statistics are enabled in configuration" - }, - "stats": { - "type": [ - "object", - "null" - ], - "properties": { - "totalMessagesProcessed": { - "type": "integer" - }, - "processedSince": { - "type": "string", - "format": "date-time" - }, - "averageTimeInQueue": { - "type": "number", - "format": "float" - }, - "messageTypeStats": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "count": { - "type": "integer" - } - } - } - } - } - } - } + }, + "type": "object" } } } @@ -73845,31 +76254,30 @@ } } }, - "/_info/openapi3.json": { + "/_action/scheduled-task/min-run-interval": { "get": { "tags": [ - "System Info & Health Check" - ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] - } - } + "System Operations" ], + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } @@ -73946,186 +76354,305 @@ } } }, - "/_action/container_cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." - } - } - } - }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { - "post": { + "/_info/openapi3.json": { + "get": { "tags": [ - "Order Management" + "System Info & Health Check" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", "parameters": [ { - "name": "orderDeliveryId", - "in": "path", - "description": "Identifier of the order delivery.", - "required": true, + "name": "type", + "in": "query", + "description": "Type of the api", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", - "required": true, - "schema": { - "type": "string" + "enum": [ + "jsonapi", + "json" + ] } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be send to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "$ref": "#/components/responses/OpenApi3" } } } }, - "/_action/cache": { - "delete": { + "/_info/version": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } }, - "/_action/cache-delayed": { - "delete": { + "/_info/health-check": { + "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", + "summary": "Check that the Application is running", + "operationId": "healthCheck", "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/order_transaction_capture_refund/{refundId}": { - "post": { + "/_info/system-health-check": { + "get": { "tags": [ - "Order Management" + "System Info & Health Check" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", "parameters": [ { - "name": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, + "name": "verbose", + "in": "query", + "required": false, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" } ], "responses": { - "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" + "200": { + "description": "Returns the system health check results", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + } + } + } + } }, - "404": { - "description": "Refund with id not found" + "500": { + "description": "Application is not working properly" } } } }, - "/_action/index-products": { + "/_action/mail-template/send": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], + "properties": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + } + }, + "type": "object" + } + } } - } - } - }, - "/_info/config": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get API information", - "description": "Get information about the API", - "operationId": "config", + }, "responses": { "200": { - "description": "Returns information about the API.", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/infoConfigResponse" + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" } } } @@ -74133,25 +76660,31 @@ } } }, - "/_action/index": { + "/_action/mail-template/validate": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "required": [ + "contentHtml", + "contentPlain" + ], "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" } }, "type": "object" @@ -74161,7 +76694,74 @@ }, "responses": { "204": { - "description": "Returns a no content response indicating that the indexing progress startet." + "description": "Returns a no content response indicating the mail content was rendered successfully." + } + } + } + }, + "/_action/mail-template/build": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The rendered preview of the mail template.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } } } } @@ -74350,351 +76950,6 @@ } } }, - "/_action/increment/{pool}": { - "post": { - "tags": [ - "Increment Storage" - ], - "summary": "Increment a value in the specified pool", - "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", - "operationId": "incrementValue", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Optional cluster identifier for the increment operation.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to increment in the pool." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successfully incremented the value", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" - } - } - }, - "get": { - "tags": [ - "Increment Storage" - ], - "summary": "List increment values from pool", - "description": "Retrieves a list of increment values from the specified pool with pagination support.", - "operationId": "getIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to list values from.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the increment operation.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of items to return.", - "required": false, - "schema": { - "type": "integer", - "default": 5, - "minimum": 1 - } - }, - { - "name": "offset", - "in": "query", - "description": "Number of items to skip for pagination.", - "required": false, - "schema": { - "type": "integer", - "default": 0, - "minimum": 0 - } - } - ], - "responses": { - "200": { - "description": "List of increment values", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The increment key" - }, - "count": { - "type": "integer", - "description": "The current count value" - } - } - } - } - } - } - }, - "400": { - "description": "Bad request - cluster parameter missing" - } - } - } - }, - "/_action/decrement/{pool}": { - "post": { - "tags": [ - "Increment Storage" - ], - "summary": "Decrement a value in the specified pool", - "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", - "operationId": "decrementValue", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Optional cluster identifier for the decrement operation.", - "required": false, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to decrement in the pool." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successfully decremented the value", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" - } - } - } - }, - "/_action/reset-increment/{pool}": { - "post": { - "tags": [ - "Increment Storage" - ], - "summary": "Reset increment values in pool", - "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", - "operationId": "resetIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to reset.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the reset operation.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successfully reset the increment values", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - cluster parameter missing" - } - } - } - }, - "/_action/delete-increment/{pool}": { - "delete": { - "tags": [ - "Increment Storage" - ], - "summary": "Delete increment keys from pool", - "description": "Deletes specific increment keys from the specified pool.", - "operationId": "deleteIncrementKeys", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to delete keys from.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the delete operation.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "keys" - ], - "properties": { - "keys": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of keys to delete from the pool." - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Successfully deleted the increment keys" - }, - "400": { - "description": "Bad request - invalid keys parameter or cluster parameter missing" - } - } - } - }, "/_action/theme/{themeId}": { "patch": { "tags": [ @@ -87616,6 +89871,9 @@ "name": { "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -88097,6 +90355,9 @@ "type": "string", "description": "Name of the language." }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." @@ -90287,6 +92548,37 @@ }, "type": "object" }, + "a11yDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "f6c460e0d75110fa1ec7529fe364dbb5" + } + } + } + } + }, + "type": "object" + }, "appPaymentMethods": { "properties": { "links": { @@ -90647,6 +92939,12 @@ "$ref": "#/components/schemas/Document" } }, + "a11yDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, "appPaymentMethods": { "type": "array", "items": { @@ -91327,6 +93625,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "width": { "type": "integer", "format": "int64", @@ -91387,6 +93689,35 @@ } }, "type": "object" + }, + "mediaThumbnailSize": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail_size" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0d0b8659a3a47e9d7e1481961f127fd0" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -91415,6 +93746,10 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of media." }, + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "width": { "type": "integer", "format": "int64", @@ -91450,6 +93785,9 @@ }, "media": { "$ref": "#/components/schemas/Media" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" @@ -91524,6 +93862,37 @@ } }, "type": "object" + }, + "mediaThumbnails": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -91575,6 +93944,12 @@ "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } + }, + "mediaThumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } } }, "type": "object" @@ -116246,30 +118621,55 @@ }, "type": "object" }, - "flowBuilderActionsResponse": { + "businessEventsResponse": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", - "description": "Name of the flow action" + "description": "Name of the event" }, - "requirements": { + "class": { + "type": "string", + "description": "Class name of the event" + }, + "data": { + "type": "object", + "description": "Available data of event" + }, + "aware": { "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", + "description": "Flow builder will base on awareness to show actions", "items": { "type": "string" } }, "extensions": { "type": "array", + "description": "Extensions data of event", "items": { "type": "string" - }, - "description": "Extensions data of event" + } } } + }, + "properties": { + "name": { + "description": "Unique name of the businessEventsResponse." + }, + "class": { + "description": "Class name of business event." + }, + "data": { + "description": "Internal field." + }, + "aware": { + "description": "Parameter that indicates the areas in which the business event is supported." + }, + "extensions": { + "description": "Internal field." + } } }, "Price": { @@ -116354,64 +118754,28 @@ "linked" ] }, - "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." + "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" } } } @@ -116540,57 +118904,6 @@ } ] }, - "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" - } - } - } - }, - "properties": { - "name": { - "description": "Unique name of the businessEventsResponse." - }, - "class": { - "description": "Class name of business event." - }, - "data": { - "description": "Internal field." - }, - "aware": { - "description": "Parameter that indicates the areas in which the business event is supported." - }, - "extensions": { - "description": "Internal field." - } - } - }, "MeasurementUnits": { "type": "object", "description": "Configuration of the measurement system", @@ -116785,11 +119098,24 @@ }, "includes": { "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", "type": "object", "additionalProperties": { "type": "array", @@ -117361,6 +119687,213 @@ "field" ] }, + "infoConfigResponse": { + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Shopware version." + }, + "shopId": { + "type": "string", + "description": "Unique shop identifier." + }, + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." + }, + "adminWorker": { + "type": "object", + "description": "Admin worker feature flags and transport configuration.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." + }, + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled." + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." + }, + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { + "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." + }, + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." + }, + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + } + }, + "additionalProperties": false + }, + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true + } + } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false + }, "Cart": { "properties": { "id": { diff --git a/adminapi.summary.json b/adminapi.summary.json index 9541bc5..f3719e3 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -33,6 +33,7 @@ "/_action/reset-increment/{pool}", "/_action/scheduled-task/min-run-interval", "/_action/scheduled-task/run", + "/_action/sso/invite-user", "/_action/sync", "/_action/theme/{themeId}", "/_action/theme/{themeId}/assign/{salesChannelId}", @@ -43,6 +44,7 @@ "/_info/events.json", "/_info/flow-actions.json", "/_info/health-check", + "/_info/is-sso", "/_info/message-stats.json", "/_info/openapi3.json", "/_info/routes", @@ -317,6 +319,9 @@ "/number-range-type", "/number-range-type/{id}", "/number-range/{id}", + "/oauth/sso/auth", + "/oauth/sso/code", + "/oauth/sso/config", "/oauth/token", "/order", "/order-address", @@ -695,6 +700,7 @@ "DocumentType", "DocumentTypeJsonApi", "EqualsFilter", + "Excludes", "Filters", "FindProductVariantRouteResponse", "Flow", From 4e235539f68742db7c1eb5d374ccb4507e80dde2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 11:10:19 +0100 Subject: [PATCH 47/63] [create-pull-request] automated change (#387) Co-authored-by: shopwareBot --- adminapi.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adminapi.json b/adminapi.json index 710348c..76cafe2 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.3.0" + "version": "6.7.4.2" }, "servers": [ { @@ -118852,7 +118852,7 @@ "administration" ] }, - "scopes": { + "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "username": { @@ -118866,7 +118866,7 @@ }, "required": [ "client_id", - "scopes", + "scope", "username", "password" ] @@ -118888,7 +118888,7 @@ "administration" ] }, - "scopes": { + "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "refresh_token": { @@ -118898,7 +118898,7 @@ }, "required": [ "client_id", - "scopes", + "scope", "refresh_token" ] } From d8f665c45a4d33fbb1785e1b379bc164ae7e32aa Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 21 Nov 2025 11:10:40 +0100 Subject: [PATCH 48/63] [create-pull-request] automated change (#385) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 534 ++++++++++++++------------- 1 file changed, 270 insertions(+), 264 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index d0c48f0..9e2ed67 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.6.10.5" + "version": "6.6.10.9" }, "servers": [ { @@ -22206,6 +22206,9 @@ "source": { "type": "string" }, + "taxCalculationType": { + "type": "string" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -22903,6 +22906,9 @@ "source": { "type": "string" }, + "taxCalculationType": { + "type": "string" + }, "stateId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -46778,6 +46784,269 @@ }, "type": "object" }, + "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" + } + } + } + } + }, + "Price": { + "type": "object", + "description": "Price object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + } + }, + "required": [ + "gross", + "net" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net" + ] + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scopes": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scopes", + "refresh_token" + ] + } + ] + }, "Criteria": { "type": "object", "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", @@ -47532,269 +47801,6 @@ } } } - }, - "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" - } - } - } - } - }, - "Price": { - "type": "object", - "description": "Price object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - }, - "listPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net" - ] - } - }, - "required": [ - "currencyId", - "gross", - "net" - ] - }, - "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" - ] - } - ] - }, - "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": { From 56cbf1b2a7f0c1ef8cd4dd2313ddb0cdd2ae4042 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 16 Dec 2025 16:12:58 +0100 Subject: [PATCH 49/63] [create-pull-request] automated change (#392) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index 9e2ed67..a456833 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.6.10.9" + "version": "6.6.10.10" }, "servers": [ { From 45032468185386a5d0ac843dbee496ae7500a737 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 6 Feb 2026 16:28:35 +0100 Subject: [PATCH 50/63] [create-pull-request] automated change (#401) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index a456833..bc63e4b 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.6.10.10" + "version": "6.6.10.11" }, "servers": [ { From 5733c1587c32b371b65072308c5a990480eceda2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 6 Feb 2026 16:28:46 +0100 Subject: [PATCH 51/63] [create-pull-request] automated change (#400) Co-authored-by: shopwareBot --- adminapi.json | 319 +++++++++++++++++++++++++++++++++++------- adminapi.summary.json | 1 + 2 files changed, 271 insertions(+), 49 deletions(-) diff --git a/adminapi.json b/adminapi.json index 76cafe2..d7489ae 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.4.2" + "version": "6.7.6.2" }, "servers": [ { @@ -75125,6 +75125,55 @@ } } }, + "/_action/media/{mediaId}/video-cover": { + "post": { + "tags": [ + "Asset Management" + ], + "summary": "Assign or remove a video cover image", + "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", + "operationId": "assignVideoCover", + "parameters": [ + { + "name": "mediaId", + "in": "path", + "required": true, + "description": "ID of the video media entity", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "coverMediaId": { + "type": [ + "string", + "null" + ], + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the image media entity to use as cover. Set to null to remove the cover." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Video cover assigned or removed successfully" + }, + "400": { + "description": "Invalid request" + } + } + } + }, "/_action/cache_info": { "get": { "tags": [ @@ -80579,6 +80628,7 @@ "type": "object" }, "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -80610,6 +80660,7 @@ "type": "object" }, "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -80701,6 +80752,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering categories", "properties": { "links": { "type": "object", @@ -80732,6 +80784,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the category", "properties": { "links": { "type": "object", @@ -80914,6 +80967,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -81137,13 +81191,15 @@ "$ref": "#/components/schemas/Category" }, "children": { + "description": "Child categories within this category for hierarchical navigation", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" }, "products": { "type": "array", @@ -81158,13 +81214,15 @@ } }, "tags": { + "description": "Tags for organizing and filtering categories", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" }, "productStream": { "$ref": "#/components/schemas/ProductStream" @@ -81194,6 +81252,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -81630,6 +81689,7 @@ "relationships": { "properties": { "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -81661,6 +81721,7 @@ "type": "object" }, "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -81721,6 +81782,7 @@ "type": "object" }, "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -81891,13 +81953,15 @@ "description": "Contains the translations of all translated fields." }, "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "previewMedia": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, "categories": { "type": "array", @@ -81906,6 +81970,7 @@ } }, "landingPages": { + "description": "Landing pages using this CMS layout", "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" @@ -82546,6 +82611,7 @@ "relationships": { "properties": { "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -82920,6 +82986,7 @@ "description": "Contains the translations of all translated fields." }, "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { "$ref": "#/components/schemas/CountryState" @@ -84783,6 +84850,7 @@ "relationships": { "properties": { "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -84841,6 +84909,7 @@ "type": "object" }, "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -84870,6 +84939,7 @@ "type": "object" }, "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -84899,6 +84969,7 @@ "type": "object" }, "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { "links": { "type": "object", @@ -84928,6 +84999,7 @@ "type": "object" }, "activeBillingAddress": { + "description": "Currently active billing address in the session", "properties": { "links": { "type": "object", @@ -84957,6 +85029,7 @@ "type": "object" }, "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -84986,6 +85059,7 @@ "type": "object" }, "activeShippingAddress": { + "description": "Currently active shipping address in the session", "properties": { "links": { "type": "object", @@ -85015,6 +85089,7 @@ "type": "object" }, "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -85044,6 +85119,7 @@ "type": "object" }, "addresses": { + "description": "All addresses saved for the customer", "properties": { "links": { "type": "object", @@ -85106,6 +85182,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -85581,33 +85658,42 @@ "readOnly": true }, "group": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" }, "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" }, "salutation": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, "addresses": { + "description": "All addresses saved for the customer", "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" @@ -85620,6 +85706,7 @@ } }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -89571,6 +89658,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -89631,6 +89719,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -89750,7 +89839,8 @@ } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", @@ -89759,6 +89849,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -89919,6 +90010,7 @@ "type": "object" }, "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -89948,6 +90040,7 @@ "type": "object" }, "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -89977,6 +90070,7 @@ "type": "object" }, "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -90376,12 +90470,15 @@ "$ref": "#/components/schemas/Language" }, "locale": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, "translationCode": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" }, "children": { + "description": "Child languages inheriting from this parent language", "type": "array", "items": { "$ref": "#/components/schemas/Language" @@ -91933,6 +92030,7 @@ "type": "object" }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "properties": { "links": { "type": "object", @@ -92826,6 +92924,7 @@ } }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" @@ -95473,6 +95572,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -95502,6 +95602,7 @@ "type": "object" }, "primaryOrderDelivery": { + "description": "Primary delivery information for the order", "properties": { "links": { "type": "object", @@ -95531,6 +95632,7 @@ "type": "object" }, "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", "properties": { "links": { "type": "object", @@ -95560,6 +95662,7 @@ "type": "object" }, "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -95589,6 +95692,7 @@ "type": "object" }, "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -95618,6 +95722,7 @@ "type": "object" }, "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -95676,6 +95781,7 @@ "type": "object" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -95707,6 +95813,7 @@ "type": "object" }, "billingAddress": { + "description": "Billing address for the order", "properties": { "links": { "type": "object", @@ -95736,6 +95843,7 @@ "type": "object" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", @@ -95767,6 +95875,7 @@ "type": "object" }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", @@ -95798,6 +95907,7 @@ "type": "object" }, "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -95829,6 +95939,7 @@ "type": "object" }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -95860,6 +95971,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -96298,60 +96410,73 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" }, "primaryOrderDelivery": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" }, "primaryOrderTransaction": { - "$ref": "#/components/schemas/OrderTransaction" + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" }, "orderCustomer": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } }, "transactions": { + "description": "Payment transactions for the order", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -97168,6 +97293,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -97226,6 +97352,7 @@ "type": "object" }, "shippingOrderAddress": { + "description": "Shipping address for this delivery", "properties": { "links": { "type": "object", @@ -97255,6 +97382,7 @@ "type": "object" }, "shippingMethod": { + "description": "Shipping method used for this delivery", "properties": { "links": { "type": "object", @@ -97284,6 +97412,7 @@ "type": "object" }, "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -97502,18 +97631,22 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -98038,6 +98171,7 @@ "relationships": { "properties": { "cover": { + "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", @@ -98096,6 +98230,7 @@ "type": "object" }, "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -98154,6 +98289,7 @@ "type": "object" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", @@ -98216,6 +98352,7 @@ "type": "object" }, "downloads": { + "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", @@ -98526,18 +98663,21 @@ "readOnly": true }, "cover": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, "product": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -98550,6 +98690,7 @@ } }, "downloads": { + "description": "Digital downloads associated with this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -98908,6 +99049,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -98966,6 +99108,7 @@ "type": "object" }, "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -98995,6 +99138,7 @@ "type": "object" }, "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -99180,15 +99324,18 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" }, "captures": { + "description": "Payment captures for this transaction", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" @@ -100409,6 +100556,7 @@ "relationships": { "properties": { "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -100745,7 +100893,8 @@ "description": "Contains the translations of all translated fields." }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" @@ -101360,6 +101509,7 @@ "relationships": { "properties": { "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -101420,6 +101570,7 @@ "type": "object" }, "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -101451,6 +101602,7 @@ "type": "object" }, "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -101480,6 +101632,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -101509,6 +101662,7 @@ "type": "object" }, "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -101538,6 +101692,7 @@ "type": "object" }, "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -101567,6 +101722,7 @@ "type": "object" }, "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", @@ -101625,6 +101781,7 @@ "type": "object" }, "cmsPage": { + "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", @@ -101654,6 +101811,7 @@ "type": "object" }, "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", @@ -101714,6 +101872,7 @@ "type": "object" }, "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -101745,6 +101904,7 @@ "type": "object" }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -101807,6 +101967,7 @@ "type": "object" }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -101900,6 +102061,7 @@ "type": "object" }, "productReviews": { + "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", @@ -101931,6 +102093,7 @@ "type": "object" }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -101962,6 +102125,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -102055,6 +102219,7 @@ "type": "object" }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -102086,6 +102251,7 @@ "type": "object" }, "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -102117,6 +102283,7 @@ "type": "object" }, "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -102148,6 +102315,7 @@ "type": "object" }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -102179,6 +102347,7 @@ "type": "object" }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -102210,6 +102379,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -102651,6 +102821,7 @@ "description": "Contains the translations of all translated fields." }, "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" @@ -102660,34 +102831,42 @@ "$ref": "#/components/schemas/Product" }, "children": { + "description": "Product variants that inherit from this parent product", "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, "unit": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, "cover": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" }, "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" }, "prices": { "type": "array", @@ -102696,12 +102875,14 @@ } }, "media": { + "description": "Product images and media gallery", "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" @@ -102714,6 +102895,7 @@ } }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -102732,18 +102914,21 @@ } }, "productReviews": { + "description": "Customer reviews and ratings for the product", "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -102762,36 +102947,42 @@ } }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "properties": { + "description": "Product properties and characteristics for filtering", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "categories": { + "description": "Categories this product is assigned to", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "tags": { + "description": "Tags for organizing and filtering products", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -110080,6 +110271,7 @@ "type": "object" }, "language": { + "description": "Default language for the sales channel", "properties": { "links": { "type": "object", @@ -110138,6 +110330,7 @@ "type": "object" }, "currency": { + "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", @@ -110167,6 +110360,7 @@ "type": "object" }, "paymentMethod": { + "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", @@ -110196,6 +110390,7 @@ "type": "object" }, "shippingMethod": { + "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", @@ -110225,6 +110420,7 @@ "type": "object" }, "country": { + "description": "Default country for the sales channel", "properties": { "links": { "type": "object", @@ -110345,6 +110541,7 @@ "type": "object" }, "domains": { + "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", @@ -110407,6 +110604,7 @@ "type": "object" }, "navigationCategory": { + "description": "Root category for navigation menu", "properties": { "links": { "type": "object", @@ -110436,6 +110634,7 @@ "type": "object" }, "footerCategory": { + "description": "Root category for footer navigation", "properties": { "links": { "type": "object", @@ -110465,6 +110664,7 @@ "type": "object" }, "serviceCategory": { + "description": "Root category for service pages", "properties": { "links": { "type": "object", @@ -111303,22 +111503,27 @@ "$ref": "#/components/schemas/SalesChannelType" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" }, "country": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" }, "orders": { "type": "array", @@ -111336,6 +111541,7 @@ "$ref": "#/components/schemas/CmsPage" }, "domains": { + "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -111348,13 +111554,16 @@ } }, "navigationCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" }, "footerCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" }, "serviceCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" }, "productVisibilities": { "type": "array", @@ -113201,6 +113410,7 @@ "relationships": { "properties": { "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -113230,6 +113440,7 @@ "type": "object" }, "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -113259,6 +113470,7 @@ "type": "object" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -113290,6 +113502,7 @@ "type": "object" }, "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -113319,6 +113532,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -113443,6 +113657,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -113589,21 +113804,26 @@ "description": "Contains the translations of all translated fields." }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -113628,7 +113848,8 @@ } }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" diff --git a/adminapi.summary.json b/adminapi.summary.json index f3719e3..dee72c7 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -21,6 +21,7 @@ "/_action/media/upload", "/_action/media/upload_by_url", "/_action/media/{mediaId}/upload", + "/_action/media/{mediaId}/video-cover", "/_action/message-queue/consume", "/_action/number-range/reserve/{type}/{saleschannel}", "/_action/order/document/download", From 016533b592795b5a51aea6b10c0793fe32542e21 Mon Sep 17 00:00:00 2001 From: Bojan Rajh <117360292+bojanrajh@users.noreply.github.com> Date: Fri, 20 Mar 2026 18:44:46 +0100 Subject: [PATCH 52/63] fix: latest descriptions (#453) --- descriptions.yml | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/descriptions.yml b/descriptions.yml index b351753..00e3493 100644 --- a/descriptions.yml +++ b/descriptions.yml @@ -16,7 +16,7 @@ ".components.schemas.Cart.properties.errors.properties.message": > A persistent error passed from the shopping cart calculation processes to the user end. -".components.schemas.Cart.properties.transactions.properties.paymentMethodId": > +".components.schemas.Cart.properties.transactions.items.properties.paymentMethodId": > Unique identity of payment method. ".components.schemas.Cart.properties.modified": > @@ -325,24 +325,15 @@ ".components.schemas.Criteria.properties.filter.properties.value": > To filter the results and aggregations by value. -".components.schemas.Criteria.properties.sort.properties.field": > +".components.schemas.Criteria.properties.sort.items.properties.field": > Sort the search results by field like an property identifier. -".components.schemas.Criteria.properties.sort.properties.order": > +".components.schemas.Criteria.properties.sort.items.properties.order": > Sort the search results of orders by ascending or descending. -".components.schemas.Criteria.properties.sort.properties.naturalSorting": > +".components.schemas.Criteria.properties.sort.items.properties.naturalSorting": > Sorting for special cases such as German letters with umlauts and similar characters etc. -".components.schemas.Criteria.properties.post-filter.properties.type": > - To filter only the results but not the aggregations with filter types like ==, >=, etc. - -".components.schemas.Criteria.properties.post-filter.properties.field": > - To filter only the results but not the aggregations by field like an property identifier. - -".components.schemas.Criteria.properties.post-filter.properties.value": > - To filter only the results but not the aggregations by value. - ".components.schemas.ProductListingCriteria.properties.filter.properties.type": > To filter the results and aggregations with filter types like ==, >=, etc. @@ -3709,19 +3700,19 @@ ".components.schemas.WebhookEventLog.properties.customFields": > Additional fields that offer a possibility to add own fields for the different program-areas. -".components.schemas.businessEventsResponse.properties.name": > +".components.schemas.businessEventsResponse.items.properties.name": > Unique name of the businessEventsResponse. -".components.schemas.businessEventsResponse.properties.class": > +".components.schemas.businessEventsResponse.items.properties.class": > Class name of business event. -".components.schemas.businessEventsResponse.properties.data": > +".components.schemas.businessEventsResponse.items.properties.data": > Internal field. -".components.schemas.businessEventsResponse.properties.aware": > +".components.schemas.businessEventsResponse.items.properties.aware": > Parameter that indicates the areas in which the business event is supported. -".components.schemas.businessEventsResponse.properties.extensions": > +".components.schemas.businessEventsResponse.items.properties.extensions": > Internal field. ".components.schemas.flowBulderActionsResponse.properties.name": > From 6e0306de895d25fd1036a9423a398e72bcb1a4e8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Mar 2026 11:39:57 +0200 Subject: [PATCH 53/63] [create-pull-request] automated change (#459) Co-authored-by: shopwareBot --- adminapi.json | 8797 +++++++++++++++++++++++------------------ adminapi.summary.json | 8 + 2 files changed, 5019 insertions(+), 3786 deletions(-) diff --git a/adminapi.json b/adminapi.json index d7489ae..b7430c9 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.6.2" + "version": "6.7.8.2" }, "servers": [ { @@ -74132,179 +74132,25 @@ } } }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" - } - } - } - } - } - } - }, - "/_info/config": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get public runtime config & feature metadata", - "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", - "operationId": "config", - "responses": { - "200": { - "description": "Public runtime configuration & feature metadata returned.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/infoConfigResponse" - }, - "example": { - "version": "6.7.2.0", - "shopId": "NoiU8PfJtu7NBY8M", - "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", - "adminWorker": { - "enableAdminWorker": true, - "enableQueueStatsWorker": true, - "enableNotificationWorker": true, - "transports": [ - "async", - "low_priority" - ] - }, - "bundles": { - "Administration": { - "css": [ - "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" - ], - "js": [ - "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" - ], - "baseUrl": null, - "type": "plugin" - }, - "Storefront": { - "css": [ - "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" - ], - "js": [ - "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" - ], - "baseUrl": null, - "type": "plugin" - } - }, - "settings": { - "enableUrlFeature": true, - "appUrlReachable": true, - "appsRequireAppUrl": false, - "private_allowed_extensions": [ - "jpg", - "jpeg", - "png", - "webp", - "avif", - "gif", - "svg", - "bmp", - "tiff", - "tif", - "eps", - "webm", - "mkv", - "flv", - "ogv", - "ogg", - "mov", - "mp4", - "avi", - "wmv", - "pdf", - "aac", - "mp3", - "wav", - "flac", - "oga", - "wma", - "txt", - "doc", - "docx", - "ico", - "glb", - "zip", - "rar", - "csv", - "xls", - "xlsx", - "html", - "xml" - ], - "enableHtmlSanitizer": true, - "enableStagingMode": false, - "disableExtensionManagement": false - }, - "inAppPurchases": [] - } - } - } - } - } - } - }, - "/_action/indexing": { + "/_action/index": { "post": { "tags": [ "System Operations" ], "summary": "Run indexer", "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", - "responses": { - "200": { - "description": "Returns an empty response indicating that the indexing process started." - } - } - } - }, - "/_action/indexing/{indexer}": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", - "parameters": [ - { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "operationId": "index", "requestBody": { "content": { "application/json": { "schema": { "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } } }, "type": "object" @@ -74312,41 +74158,9 @@ } } }, - "responses": { - "200": { - "description": "Returns information about the iteration.", - "content": { - "application/json": { - "schema": { - "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", "responses": { "204": { - "description": "Returns an empty response indicating that the message dispatched." + "description": "Returns a no content response indicating that the indexing progress startet." } } } @@ -74409,6 +74223,10 @@ "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" + }, + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" } }, "type": "object" @@ -74423,52 +74241,60 @@ } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { + "/oauth/token": { + "post": { "tags": [ - "Document Management" + "Authorization & Authentication" ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" + }, + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + } + ] + } } } - ], + }, "responses": { "200": { - "description": "The generated number", + "description": "Authorized successfully.", "content": { "application/json": { "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], "properties": { - "number": { - "description": "The generated (or previewed) document number.", + "token_type": { + "description": "Type of the token.", + "type": "string" + }, + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", "type": "string" } }, @@ -74478,425 +74304,175 @@ } }, "400": { - "description": "Number range not found" + "$ref": "#/components/responses/400" } } } }, - "/_action/increment/{pool}": { - "post": { + "/oauth/sso/config": { + "get": { "tags": [ - "Increment Storage" - ], - "summary": "Increment a value in the specified pool", - "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", - "operationId": "incrementValue", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Optional cluster identifier for the increment operation.", - "required": false, - "schema": { - "type": "string" - } - } + "Experimental", + "SSO Login configuration" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to increment in the pool." - } - } - } - } - } - }, + "summary": "Experimental: Loads SSO login configuration.", + "description": "Experimental: Loads the SSO login configuration to configure the forward to the Shopware SSO login page.", "responses": { "200": { - "description": "Successfully incremented the value", + "description": "Experimental: Returns the configuration for the SSO login page forward.", "content": { "application/json": { "schema": { "type": "object", "properties": { - "success": { - "type": "boolean", - "example": true + "useDefault": { + "description": "Experimental: Indicates which login is used. Default or SSO.", + "type": "boolean" + }, + "url": { + "description": "Experimental: Contains the return url for the Shopware SSO login.", + "type": "string" } } } } } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" } - } - }, + }, + "operationId": "loadSsoLoginConfig" + } + }, + "/oauth/sso/code": { "get": { "tags": [ - "Increment Storage" - ], - "summary": "List increment values from pool", - "description": "Retrieves a list of increment values from the specified pool with pagination support.", - "operationId": "getIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to list values from.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the increment operation.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "limit", - "in": "query", - "description": "Maximum number of items to return.", - "required": false, - "schema": { - "type": "integer", - "default": 5, - "minimum": 1 - } - }, - { - "name": "offset", - "in": "query", - "description": "Number of items to skip for pagination.", - "required": false, - "schema": { - "type": "integer", - "default": 0, - "minimum": 0 - } - } + "Experimental", + "SSO Login callback" ], + "summary": "Experimental: Callback for SSO login", + "description": "Experimental: Logs in the user into the Shopware shop and forwards to the admin", "responses": { "200": { - "description": "List of increment values", + "description": "Authorisation process continues", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The increment key" - }, - "count": { - "type": "integer", - "description": "The current count value" - } - } - } + "type": "object" } } } }, - "400": { - "description": "Bad request - cluster parameter missing" + "302": { + "description": "Experimental: Forwards to the Shopware admin" } - } + }, + "operationId": "callBackWithCode" } }, - "/_action/decrement/{pool}": { - "post": { + "/oauth/sso/auth": { + "get": { "tags": [ - "Increment Storage" + "Experimental", + "SSO Login forward" ], - "summary": "Decrement a value in the specified pool", - "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", - "operationId": "decrementValue", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Optional cluster identifier for the decrement operation.", - "required": false, - "schema": { - "type": "string" - } + "summary": "Experimental: Redirect to SSO login", + "description": "Experimental: Creates a redirection to the SSO login page", + "operationId": "ssoAuth", + "responses": { + "302": { + "description": "Experimental: Forwards to SSO login Page" } + } + } + }, + "/_info/is-sso": { + "get": { + "tags": [ + "Experimental", + "Is SSO environment" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to decrement in the pool." - } - } - } - } - } - }, + "summary": "Experimental: Is SSO environment", + "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", + "operationId": "isSso", "responses": { "200": { - "description": "Successfully decremented the value", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" + "description": "Experimental: Returns if it is a SSO environment or not" } } } }, - "/_action/reset-increment/{pool}": { + "/_action/sso/invite-user": { "post": { "tags": [ - "Increment Storage" + "Experimental", + "Invite a new SSO user" ], - "summary": "Reset increment values in pool", - "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", - "operationId": "resetIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to reset.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the reset operation.", - "required": true, - "schema": { - "type": "string" - } + "summary": "Experimental: Invite a new SSO user", + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", + "operationId": "inviteUser", + "responses": { + "200": { + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" } + } + } + }, + "/_info/message-stats.json": { + "get": { + "summary": "Get statistics message queue", + "description": "Get statistics for recently processed messages in the message queue", + "operationId": "getMessageStats", + "tags": [ + "System Info & Health Check" ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." - } - } - } - } - } - }, "responses": { "200": { - "description": "Successfully reset the increment values", + "description": "Statistics received", "content": { "application/json": { "schema": { "type": "object", + "required": [ + "enabled" + ], "properties": { - "success": { + "enabled": { "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - cluster parameter missing" - } - } - } - }, - "/_action/delete-increment/{pool}": { - "delete": { - "tags": [ - "Increment Storage" - ], - "summary": "Delete increment keys from pool", - "description": "Deletes specific increment keys from the specified pool.", - "operationId": "deleteIncrementKeys", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to delete keys from.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the delete operation.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "keys" - ], - "properties": { - "keys": { - "type": "array", - "items": { - "type": "string" + "description": "Whether message queue statistics are enabled in configuration" }, - "description": "Array of keys to delete from the pool." - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Successfully deleted the increment keys" - }, - "400": { - "description": "Bad request - invalid keys parameter or cluster parameter missing" - } - } - } - }, - "/_action/media/{mediaId}/upload": { - "post": { - "tags": [ - "Asset Management" - ], - "summary": "Upload a file to a media entity", - "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "upload", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "description": "Identifier of the media entity.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file. If not provided the media identifier will be used as name", - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `png`", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the media file that will be downloaded.", - "type": "string" + "stats": { + "type": [ + "object", + "null" + ], + "properties": { + "totalMessagesProcessed": { + "type": "integer" + }, + "processedSince": { + "type": "string", + "format": "date-time" + }, + "averageTimeInQueue": { + "type": "number", + "format": "float" + }, + "messageTypeStats": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "count": { + "type": "integer" + } + } + } + } + } + } } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "Media file uploaded successful", - "headers": { - "Location": { - "description": "Contains the url to the uploaded media for a redirect.", - "schema": { - "type": "string" } } } @@ -74904,272 +74480,149 @@ } } }, - "/_action/media/upload": { - "post": { + "/consents": { + "get": { "tags": [ - "Asset Management" + "Consent Management", + "Experimental" ], - "summary": "Upload a new media file", - "description": "Creates a new media entity and uploads a file to it using form-data file upload.", - "operationId": "uploadV2", - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The file to upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { - "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" - } - }, - "required": [ - "file" - ] - } - } - } - }, + "summary": "List all consents for current user", + "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "fetchConsents", "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "List of consents with their status", "content": { - "application\\/json": { + "application/json": { "schema": { "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "additionalProperties": { + "$ref": "#/components/schemas/ConsentState" + }, + "example": { + "product_analytics": { + "name": "product_analytics", + "scopeName": "admin_user", + "identifier": "userId-12345", + "status": "accepted", + "actor": "userId-12345", + "updatedAt": "2024-01-15T10:20:30Z" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "requested", + "actor": null, + "updatedAt": null } } } } } + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/media/upload_by_url": { + "/consents/accept": { "post": { "tags": [ - "Asset Management" + "Consent Management", + "Experimental" ], - "summary": "Upload a media file from URL", - "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", - "operationId": "uploadByUrl", + "summary": "Accept a consent", + "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "acceptConsent", "requestBody": { "content": { - "application\\/json": { + "application/json": { "schema": { "type": "object", "properties": { - "url": { - "type": "string", - "description": "URL of the file to download and upload" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the uploaded file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { + "consent": { "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on file hash" + "description": "The name of the consent to accept" } }, "required": [ - "url" - ] + "consent" + ], + "example": { + "consent": "product_analytics" + } } } } }, "responses": { "200": { - "description": "Media file uploaded successfully", + "description": "Consent status changed successfully. Returns the updated consent status.", "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" - } - } + "$ref": "#/components/schemas/ConsentState" } } } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/media/external-link": { + "/consents/revoke": { "post": { "tags": [ - "Asset Management" + "Consent Management", + "Experimental" ], - "summary": "Create external media link", - "description": "Creates a new media entity that links to an external URL without downloading the file.", - "operationId": "externalLink", + "summary": "Revoke a consent", + "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "revokeConsent", "requestBody": { "content": { - "application\\/json": { + "application/json": { "schema": { "type": "object", "properties": { - "url": { - "type": "string", - "description": "URL of the external media file" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Custom ID for the media entity" - }, - "fileName": { - "type": "string", - "description": "Name of the file" - }, - "private": { - "type": "boolean", - "description": "Whether the media should be private" - }, - "mediaFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the media folder" - }, - "mimeType": { + "consent": { "type": "string", - "description": "MIME type of the file" - }, - "deduplicate": { - "type": "boolean", - "description": "Whether to deduplicate based on path" + "description": "The name of the consent to accept" } }, "required": [ - "url", - "mimeType" - ] + "consent" + ], + "example": { + "consent": "product_analytics" + } } } } }, "responses": { "200": { - "description": "External media link created successfully", + "description": "Consent status changed successfully. Returns the updated consent status.", "content": { - "application\\/json": { + "application/json": { "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" - } - } - } - } - } - } - } - } - }, - "/_action/media/{mediaId}/video-cover": { - "post": { - "tags": [ - "Asset Management" - ], - "summary": "Assign or remove a video cover image", - "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", - "operationId": "assignVideoCover", - "parameters": [ - { - "name": "mediaId", - "in": "path", - "required": true, - "description": "ID of the video media entity", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "coverMediaId": { - "type": [ - "string", - "null" - ], - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the image media entity to use as cover. Set to null to remove the cover." - } + "$ref": "#/components/schemas/ConsentState" } } } - } - }, - "responses": { - "204": { - "description": "Video cover assigned or removed successfully" }, - "400": { - "description": "Invalid request" + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } @@ -75210,51 +74663,36 @@ } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/order/document/download": { "post": { "tags": [ - "Customer impersonation" + "Document Management" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", "requestBody": { - "required": true, + "description": "documentIds", "content": { "application/json": { "schema": { - "required": [ - "customerId", - "salesChannelId" - ], - "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" - }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" - } - }, - "type": "object" + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } } } }, "responses": { "200": { - "description": "The generated customer impersonation token.", + "description": "The documents.", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" - } - }, - "type": "object" + "type": "string", + "format": "binary" } } } @@ -75262,225 +74700,153 @@ } } }, - "/_action/order/{orderId}/order-address": { + "/_action/order/document/{documentTypeName}/create": { "post": { "tags": [ - "Order address" + "Document Management" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", - "parameters": [ - { - "name": "orderId", + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", + "parameters": [ + { + "name": "documentTypeName", "in": "path", - "description": "Identifier of the order.", + "description": "The type of document to create", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], "requestBody": { + "description": "test", + "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "description": "The ID of the delivery (optional)", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "customerAddressId", - "type" - ] + "type": "array", + "items": { + "type": "object", + "required": [ + "orderId", + "type" + ], + "properties": { + "orderId": { + "description": "Identifier of the order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": "The mapping of order addresses" + "type": { + "description": "Type of the document to be generated.", + "type": "string" + }, + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" + }, + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", + "type": "string", + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" + } } } } } - }, - "required": true - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." } - } - } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", + }, "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." + "200": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, - "/_action/container_cache": { - "delete": { + "/_action/order/{orderId}/state/{transition}": { + "post": { "tags": [ - "System Operations" + "Order Management" ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } } - } - } - }, - "/oauth/sso/config": { - "get": { - "tags": [ - "Authorization & Authentication", - "SSO Login configuration" ], - "summary": "Loads configuration for the admin login", - "description": "Loads the configuration for the admin login. This configuration is used to load and configure the default or Single Sign On (SSO) login for the admin.", - "operationId": "loadSsoLoginConfig", - "responses": { - "200": { - "description": "Config loaded successfully.", - "content": { - "application/json": { - "schema": { - "properties": { - "useDefault": { - "description": "Experimental: Indicates which login is used. Default or SSO.", - "type": "boolean" - }, - "url": { - "description": "Experimental: Contains the return url for the Shopware SSO login.", - "type": "string" + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "type": "object" - } - } - } - } - } - } - }, - "/oauth/sso/code": { - "get": { - "tags": [ - "Authorization & Authentication", - "SSO Login callback" - ], - "summary": "Callback function. Fetch an authorization code", - "description": "Fetch an authorization code log in the user.", - "operationId": "callBackWithCode", - "responses": { - "302": { - "description": "Experimental: Forwards to the Shopware admin" - }, - "200": { - "description": "Authorisation process continues", - "content": { - "application/json": { - "schema": { - "type": "object" - } + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + }, + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" + } + }, + "type": "object" } } } - } - } - }, - "/oauth/sso/auth": { - "get": { - "tags": [ - "Experimental", - "SSO Login forward" - ], - "summary": "Experimental: Redirect to SSO login", - "description": "Experimental: Creates a redirection to the SSO login page", - "operationId": "ssoAuth", - "responses": { - "302": { - "description": "Experimental: Forwards to SSO login Page" - } - } - } - }, - "/_info/is-sso": { - "get": { - "tags": [ - "Experimental", - "Is SSO environment" - ], - "summary": "Experimental: Is SSO environment", - "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", - "operationId": "isSso", - "responses": { - "200": { - "description": "Experimental: Returns if it is a SSO environment or not" - } - } - } - }, - "/_action/sso/invite-user": { - "post": { - "tags": [ - "Experimental", - "Invite a new SSO user" - ], - "summary": "Experimental: Invite a new SSO user", - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", - "operationId": "inviteUser", + }, "responses": { "200": { - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" + "description": "Todo: Use ref of `state_machine_transition` here" } } } @@ -75532,233 +74898,228 @@ } } }, - "/_action/sync": { - "post": { + "/_info/health-check": { + "get": { "tags": [ - "Bulk Operations" - ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", - "parameters": [ - { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", - "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] - } - } + "System Info & Health Check" ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], - "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", - "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } - }, - "filter": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - } - }, - "type": "object" - } - } - } - } - }, + "summary": "Check that the Application is running", + "operationId": "healthCheck", "responses": { "200": { - "description": "Returns a sync result containing information about the updated entities", - "content": { - "application/json": { - "schema": { - "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" - }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" - }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" - } - }, - "type": "object" - } - } - } + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/document/{documentId}/{deepLinkCode}": { + "/_info/system-health-check": { "get": { "tags": [ - "Document Management" + "System Info & Health Check" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", "parameters": [ { - "name": "documentId", - "in": "path", - "description": "Identifier of the document to be downloaded.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "download", + "name": "verbose", "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "required": false, "schema": { "type": "boolean", "default": false - } + }, + "description": "Include detailed information in the response" } ], "responses": { "200": { - "description": "The document.", + "description": "Returns the system health check results", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "properties": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + } } } } + }, + "500": { + "description": "Application is not working properly" } } } }, - "/_action/document/{documentId}/upload": { + "/_action/mail-template/send": { "post": { "tags": [ - "Document Management" - ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", - "parameters": [ - { - "name": "documentId", - "in": "path", - "description": "Identifier of the document the new file should be added to.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", - "required": true, - "schema": { - "type": "string" - } - } + "Mail Operations" ], + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", "requestBody": { + "required": true, "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { + "application/json": { "schema": { "required": [ - "url" + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" ], "properties": { - "url": { - "description": "The url of the document that will be downloaded.", + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } } }, "type": "object" @@ -75768,19 +75129,14 @@ }, "responses": { "200": { - "description": "Document uploaded successful", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" + "size": { + "description": "Length of the email message", + "type": "integer" } }, "type": "object" @@ -75791,25 +75147,30 @@ } } }, - "/_action/message-queue/consume": { + "/_action/mail-template/validate": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "receiver" + "contentHtml", + "contentPlain" ], "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", "type": "string" } }, @@ -75818,19 +75179,73 @@ } } }, + "responses": { + "204": { + "description": "Returns a no content response indicating the mail content was rendered successfully." + } + } + } + }, + "/_action/mail-template/build": { + "post": { + "tags": [ + "Mail Operations" + ], + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { - "description": "Returns information about handled messages", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { - "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" - } - }, - "type": "object" + "type": "string" } } } @@ -75838,6 +75253,68 @@ } } }, + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", + "parameters": [ + { + "name": "refundId", + "in": "path", + "description": "Identifier of the order transaction capture refund.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_info/openapi3.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/OpenApi3" + } + } + } + }, "/_info/events.json": { "get": { "tags": [ @@ -75860,210 +75337,111 @@ } } }, - "/_info/message-stats.json": { - "get": { - "summary": "Get statistics message queue", - "description": "Get statistics for recently processed messages in the message queue", - "operationId": "getMessageStats", + "/_action/index-products": { + "post": { "tags": [ - "System Info & Health Check" + "System Operations" ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", "responses": { - "200": { - "description": "Statistics received", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether message queue statistics are enabled in configuration" - }, - "stats": { - "type": [ - "object", - "null" - ], - "properties": { - "totalMessagesProcessed": { - "type": "integer" - }, - "processedSince": { - "type": "string", - "format": "date-time" - }, - "averageTimeInQueue": { - "type": "number", - "format": "float" - }, - "messageTypeStats": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "count": { - "type": "integer" - } - } - } - } - } - } - } - } - } - } + "204": { + "description": "Returns an empty response indicating that the message dispatched." } } } }, - "/app-system/privileges/requested": { - "get": { + "/_action/container_cache": { + "delete": { "tags": [ - "App System" - ], - "summary": "Get requested privileges for all apps", - "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", - "operationId": "getRequestedPrivileges", - "security": [ - { - "oAuth": [ - "admin" - ] - } + "System Operations" ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "responses": { - "200": { - "description": "A JSON object containing requested privileges.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - }, - "example": { - "privileges": { - "SwagAnalytics": [ - "customer:read", - "order:read" - ], - "SwagExample": [ - "product:write" - ] - } - } - } - } - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." } } } }, - "/app-system/{appName}/privileges/accepted": { - "get": { + "/_action/message-queue/consume": { + "post": { "tags": [ - "App System" + "System Operations" ], - "summary": "Get accepted privileges for an app", - "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", - "operationId": "getAcceptedPrivileges", - "parameters": [ - { - "name": "appName", - "in": "path", - "required": true, - "schema": { - "type": "string" + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "receiver" + ], + "properties": { + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" + } + }, + "type": "object" + } } } - ], - "security": [ - { - "oAuth": [ - "admin" - ] - } - ], + }, "responses": { "200": { - "description": "A JSON object containing accepted privileges.", + "description": "Returns information about handled messages", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "boolean" - } + "handledMessages": { + "description": "The number of messages processed.", + "type": "integer" } - } - }, - "example": { - "privileges": { - "customer:read": true, - "order:read": true - } + }, + "type": "object" } } } - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." } } } }, - "/app-system/{appName}/privileges": { - "patch": { + "/_action/sync": { + "post": { "tags": [ - "App System" + "Bulk Operations" ], - "summary": "Accept or revoke privileges for an app", - "description": "Accepts or revokes specified privileges for the given app.", - "operationId": "managePrivileges", + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", "parameters": [ { - "name": "appName", - "in": "path", - "required": true, + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { - "type": "string" + "type": "boolean", + "default": true + } + }, + { + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", + "schema": { + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] } } ], @@ -76072,131 +75450,213 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "accept": { - "type": "array", - "items": { - "type": "string" + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "criteria": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } } }, - "revoke": { - "type": "array", - "items": { - "type": "string" - } - } + "type": "object" } - }, - "example": { - "accept": [ - "customer:read", - "order:read" - ], - "revoke": [ - "product:write" - ] } } } }, "responses": { - "204": { - "description": "Returns no content if privileges were managed successfully." - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] - } - ] - } - }, - "/_action/cleanup": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "200": { + "description": "Returns a sync result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" + } + }, + "type": "object" + } + } + } } } } }, - "/_action/order_transaction_capture_refund/{refundId}": { + "/_action/media/{mediaId}/upload": { "post": { "tags": [ - "Order Management" + "Asset Management" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", + "summary": "Upload a file to a media entity", + "description": "Adds a new file to a media entity. If the entity has an existing file, it will be replaced.\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "upload", "parameters": [ { - "name": "refundId", + "name": "mediaId", "in": "path", - "description": "Identifier of the order transaction capture refund.", + "description": "Identifier of the media entity.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file. If not provided the media identifier will be used as name", + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `png`", + "required": true, + "schema": { + "type": "string" + } } ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the media file that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" + "description": "Media file uploaded successful", + "headers": { + "Location": { + "description": "Contains the url to the uploaded media for a redirect.", + "schema": { + "type": "string" + } + } + } } } } }, - "/oauth/token": { + "/_action/media/upload": { "post": { "tags": [ - "Authorization & Authentication" + "Asset Management" ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", + "summary": "Upload a new media file", + "description": "Creates a new media entity and uploads a file to it using form-data file upload.", + "operationId": "uploadV2", "requestBody": { - "required": true, "content": { - "application/json": { + "multipart/form-data": { "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" + "type": "object", + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The file to upload" }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + "fileName": { + "type": "string", + "description": "Name of the uploaded file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" } + }, + "required": [ + "file" ] } } @@ -76204,98 +75664,91 @@ }, "responses": { "200": { - "description": "Authorized successfully.", + "description": "Media file uploaded successfully", "content": { - "application/json": { + "application\\/json": { "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], + "type": "object", "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" } - }, - "type": "object" + } } } } - }, - "400": { - "$ref": "#/components/responses/400" } } } }, - "/_action/index": { + "/_action/media/upload_by_url": { "post": { "tags": [ - "System Operations" + "Asset Management" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", + "summary": "Upload a media file from URL", + "description": "Creates a new media entity by downloading and uploading a file from the provided URL. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.", + "operationId": "uploadByUrl", "requestBody": { "content": { - "application/json": { + "application\\/json": { "schema": { + "type": "object", "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string", + "description": "URL of the file to download and upload" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the uploaded file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on file hash" } }, - "type": "object" + "required": [ + "url" + ] } } } }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the indexing progress startet." - } - } - } - }, - "/_action/scheduled-task/run": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", "responses": { "200": { - "description": "Returns a success message indicating a successful run.", + "description": "Media file uploaded successfully", "content": { - "application/json": { + "application\\/json": { "schema": { + "type": "object", "properties": { - "message": { - "description": "Success message", - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" } - }, - "type": "object" + } } } } @@ -76303,27 +75756,73 @@ } } }, - "/_action/scheduled-task/min-run-interval": { - "get": { + "/_action/media/external-link": { + "post": { "tags": [ - "System Operations" + "Asset Management" ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + "summary": "Create external media link", + "description": "Creates a new media entity that links to an external URL without downloading the file.", + "operationId": "externalLink", + "requestBody": { + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL of the external media file" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Custom ID for the media entity" + }, + "fileName": { + "type": "string", + "description": "Name of the file" + }, + "private": { + "type": "boolean", + "description": "Whether the media should be private" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "deduplicate": { + "type": "boolean", + "description": "Whether to deduplicate based on path" + } + }, + "required": [ + "url", + "mimeType" + ] + } + } + } + }, "responses": { "200": { - "description": "Returns the minimum interval.", + "description": "External media link created successfully", "content": { - "application/json": { + "application\\/json": { "schema": { + "type": "object", "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" } - }, - "type": "object" + } } } } @@ -76331,124 +75830,184 @@ } } }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/_action/media/{mediaId}/video-cover": { "post": { "tags": [ - "Order Management" + "Asset Management" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", + "summary": "Assign or remove a video cover image", + "description": "Assigns an image as a cover for a video media entity, or removes the cover if `coverMediaId` is null.", + "operationId": "assignVideoCover", "parameters": [ { - "name": "orderTransactionId", + "name": "mediaId", "in": "path", - "description": "Identifier of the order transaction.", "required": true, + "description": "ID of the video media entity", "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { - "required": false, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - } - }, - "type": "object" + "coverMediaId": { + "type": [ + "string", + "null" + ], + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the image media entity to use as cover. Set to null to remove the cover." + } + } } } } }, "responses": { - "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" + "204": { + "description": "Video cover assigned or removed successfully" + }, + "400": { + "description": "Invalid request" } } } }, - "/_info/openapi3.json": { + "/_action/document/{documentId}/{deepLinkCode}": { "get": { "tags": [ - "System Info & Health Check" + "Document Management" ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", "parameters": [ { - "name": "type", - "in": "query", - "description": "Type of the api", + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, "schema": { "type": "string", - "enum": [ - "jsonapi", - "json" - ] + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false } } ], "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "The document.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } } } } }, - "/_info/version": { - "get": { + "/_action/document/{documentId}/upload": { + "post": { "tags": [ - "System Info & Health Check" + "Document Management" ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { - "description": "Returns the version of the Shopware instance.", + "description": "Document uploaded successful", "content": { "application/json": { "schema": { "properties": { - "version": { - "description": "The Shopware version.", + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", "type": "string" } }, @@ -76460,228 +76019,110 @@ } } }, - "/_info/health-check": { - "get": { + "/_action/cache": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_info/system-health-check": { - "get": { + "/_action/cache-delayed": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", "parameters": [ { - "name": "verbose", + "name": "refreshOpenSearch", "in": "query", "required": false, + "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", "schema": { "type": "boolean", "default": false - }, - "description": "Include detailed information in the response" + } } ], "responses": { - "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Application is not working properly" + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_action/mail-template/send": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ - "Mail Operations" + "Order Management" + ], + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", + "parameters": [ + { + "name": "orderTransactionId", + "in": "path", + "description": "Identifier of the order transaction.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" + "sendMail": { + "description": "Controls if a mail should be sent to the customer." }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", + "documentIds": { + "description": "A list of document identifiers that should be attached", "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{32}$" } }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], + "mediaIds": { + "description": "A list of media identifiers that should be attached", "type": "array", "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "stateFieldName": { + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" } }, "type": "object" @@ -76691,109 +76132,69 @@ }, "responses": { "200": { - "description": "The mail was sent successful", - "content": { - "application/json": { - "schema": { - "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" - } - }, - "type": "object" - } - } - } + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/_action/mail-template/validate": { - "post": { + "/_action/cleanup": { + "delete": { "tags": [ - "Mail Operations" + "System Operations" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", "responses": { "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "description": "Returns a no content response indicating that the cleanup finished." } } } }, - "/_action/mail-template/build": { + "/_action/indexing": { "post": { "tags": [ - "Mail Operations" + "System Operations" + ], + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", + "parameters": [ + { + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" + "offset": { + "description": "The offset for the iteration.", + "type": "integer" } }, "type": "object" @@ -76803,11 +76204,836 @@ }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "Returns information about the iteration.", + "content": { + "application/json": { + "schema": { + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/state-machine/{entityName}/{entityId}/state": { + "get": { + "tags": [ + "State Machine" + ], + "summary": "Get available transitions for an entity", + "description": "Retrieves the available state transitions for the specified entity.", + "operationId": "getEntityState", + "parameters": [ + { + "name": "entityName", + "in": "path", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } + } + ], + "responses": { + "200": { + "description": "Available transitions for the current state.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "transitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the transition." + }, + "technicalName": { + "type": "string", + "description": "The technical name of the transition." + }, + "actionName": { + "type": "string", + "description": "The action name of the transition." + }, + "fromStateName": { + "type": "string", + "description": "The technical name of the state the transition starts from." + }, + "toStateName": { + "type": "string", + "description": "The technical name of the state the transition goes to." + }, + "url": { + "type": "string", + "description": "The URL to trigger the transition." + } + }, + "required": [ + "name", + "technicalName", + "actionName", + "fromStateName", + "toStateName", + "url" + ] + } + } + }, + "required": [ + "transitions" + ] + } + } + } + }, + "400": { + "description": "Unable to read the entity or entity field." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." + } + } + } + }, + "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Transition an entity to a new state", + "description": "Changes the entity state by applying the given transition.", + "operationId": "transitionEntityState", + "parameters": [ + { + "name": "entityName", + "in": "path", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } + } + ], + "requestBody": { + "description": "Optional internal comment for the state transition.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "internalComment": { + "type": "string", + "description": "An optional internal comment that will be saved with the state transition." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "State transition applied successfully." + }, + "400": { + "description": "Unable to read the entity or entity field, or invalid transition." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." + } + } + } + }, + "/_proxy/generate-imitate-customer-token": { + "post": { + "tags": [ + "Customer impersonation" + ], + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" + }, + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/scheduled-task/run": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", + "responses": { + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/scheduled-task/min-run-interval": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", + "responses": { + "200": { + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/increment/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Increment a value in the specified pool", + "description": "Increments a value by key in the specified increment pool. This operation increments the counter for the given key and returns a success response.", + "operationId": "incrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool (e.g., 'user_activity', 'message_queue').", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the increment operation.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to increment in the pool." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully incremented the value", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" + } + } + }, + "get": { + "tags": [ + "Increment Storage" + ], + "summary": "List increment values from pool", + "description": "Retrieves a list of increment values from the specified pool with pagination support.", + "operationId": "getIncrementValues", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to list values from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the increment operation.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "limit", + "in": "query", + "description": "Maximum number of items to return.", + "required": false, + "schema": { + "type": "integer", + "default": 5, + "minimum": 1 + } + }, + { + "name": "offset", + "in": "query", + "description": "Number of items to skip for pagination.", + "required": false, + "schema": { + "type": "integer", + "default": 0, + "minimum": 0 + } + } + ], + "responses": { + "200": { + "description": "List of increment values", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The increment key" + }, + "count": { + "type": "integer", + "description": "The current count value" + } + } + } + } + } + } + }, + "400": { + "description": "Bad request - cluster parameter missing" + } + } + } + }, + "/_action/decrement/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Decrement a value in the specified pool", + "description": "Decrements a value by key in the specified increment pool. This operation decrements the counter for the given key and returns a success response.", + "operationId": "decrementValue", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Optional cluster identifier for the decrement operation.", + "required": false, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to decrement in the pool." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully decremented the value", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - key parameter missing or cluster parameter missing" + } + } + } + }, + "/_action/reset-increment/{pool}": { + "post": { + "tags": [ + "Increment Storage" + ], + "summary": "Reset increment values in pool", + "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", + "operationId": "resetIncrementValues", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to reset.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the reset operation.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Successfully reset the increment values", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "success": { + "type": "boolean", + "example": true + } + } + } + } + } + }, + "400": { + "description": "Bad request - cluster parameter missing" + } + } + } + }, + "/_action/delete-increment/{pool}": { + "delete": { + "tags": [ + "Increment Storage" + ], + "summary": "Delete increment keys from pool", + "description": "Deletes specific increment keys from the specified pool.", + "operationId": "deleteIncrementKeys", + "parameters": [ + { + "name": "pool", + "in": "path", + "description": "The name of the increment pool to delete keys from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the delete operation.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "keys" + ], + "properties": { + "keys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of keys to delete from the pool." + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Successfully deleted the increment keys" + }, + "400": { + "description": "Bad request - invalid keys parameter or cluster parameter missing" + } + } + } + }, + "/_action/order/{orderId}/order-address": { + "post": { + "tags": [ + "Order address" + ], + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "description": "The ID of the delivery (optional)", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, + "/_info/version": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", + "responses": { + "200": { + "description": "Returns the version of the Shopware instance.", + "content": { + "application/json": { + "schema": { + "properties": { + "version": { + "description": "The Shopware version.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/flow-actions.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", + "responses": { + "200": { + "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } @@ -76815,141 +77041,143 @@ } } }, - "/_action/order/document/download": { - "post": { + "/app-system/privileges/requested": { + "get": { "tags": [ - "Document Management" + "App System" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", - "requestBody": { - "description": "documentIds", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - } + "summary": "Get requested privileges for all apps", + "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", + "operationId": "getRequestedPrivileges", + "security": [ + { + "oAuth": [ + "admin" + ] } - }, + ], "responses": { "200": { - "description": "The documents.", + "description": "A JSON object containing requested privileges.", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "example": { + "privileges": { + "SwagAnalytics": [ + "customer:read", + "order:read" + ], + "SwagExample": [ + "product:write" + ] + } } } } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." } } } }, - "/_action/order/document/{documentTypeName}/create": { - "post": { + "/app-system/{appName}/privileges/accepted": { + "get": { "tags": [ - "Document Management" + "App System" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Get accepted privileges for an app", + "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", + "operationId": "getAcceptedPrivileges", "parameters": [ { - "name": "documentTypeName", + "name": "appName", "in": "path", - "description": "The type of document to create", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "description": "test", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { + "security": [ + { + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing accepted privileges.", + "content": { + "application/json": { + "schema": { "type": "object", - "required": [ - "orderId", - "type" - ], "properties": { - "orderId": { - "description": "Identifier of the order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "description": "Type of the document to be generated.", - "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", - "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", - "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" + "privileges": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } } } + }, + "example": { + "privileges": { + "customer:read": true, + "order:read": true + } } } } - } - }, - "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." } } } }, - "/_action/order/{orderId}/state/{transition}": { - "post": { + "/app-system/{appName}/privileges": { + "patch": { "tags": [ - "Order Management" + "App System" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Accept or revoke privileges for an app", + "description": "Accepts or revokes specified privileges for the given app.", + "operationId": "managePrivileges", "parameters": [ { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", + "name": "appName", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -76957,44 +77185,251 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", + "accept": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", + "revoke": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } - }, - "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" } - }, - "type": "object" + } + }, + "example": { + "accept": [ + "customer:read", + "order:read" + ], + "revoke": [ + "product:write" + ] } } } }, + "responses": { + "204": { + "description": "Returns no content if privileges were managed successfully." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/_action/app-system/secret/rotate": { + "post": { + "tags": [ + "App System" + ], + "summary": "Initiate secret rotation for the calling app", + "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", + "operationId": "appSecretRotation", + "responses": { + "202": { + "description": "Returns \"Accepted\" when secret rotation was scheduled." + }, + "400": { + "description": "Malformed request, e.g. when requested with non app integration source." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/_info/queue.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get message queue statistics (deprecated)", + "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", + "operationId": "queue", + "deprecated": true, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "description": "Message queue statistics returned.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Fully qualified class name of the message." + }, + "size": { + "type": "integer", + "description": "Number of pending messages of this type." + } + }, + "required": [ + "name", + "size" + ] + } + }, + "example": [ + { + "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", + "size": 150 + }, + { + "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", + "size": 25 + } + ] + } + } + } + } + } + }, + "/_info/config": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get public runtime config & feature metadata", + "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", + "operationId": "config", + "responses": { + "200": { + "description": "Public runtime configuration & feature metadata returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/infoConfigResponse" + }, + "example": { + "version": "6.7.2.0", + "shopId": "NoiU8PfJtu7NBY8M", + "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", + "adminWorker": { + "enableAdminWorker": true, + "enableNotificationWorker": true, + "transports": [ + "async", + "low_priority" + ] + }, + "bundles": { + "Administration": { + "css": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" + ], + "js": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" + ], + "baseUrl": null, + "type": "plugin" + }, + "Storefront": { + "css": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" + ], + "js": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" + ], + "baseUrl": null, + "type": "plugin" + } + }, + "settings": { + "enableUrlFeature": true, + "appUrlReachable": true, + "appsRequireAppUrl": false, + "private_allowed_extensions": [ + "jpg", + "jpeg", + "png", + "webp", + "avif", + "gif", + "svg", + "bmp", + "tiff", + "tif", + "eps", + "webm", + "mkv", + "flv", + "ogv", + "ogg", + "mov", + "mp4", + "avi", + "wmv", + "pdf", + "aac", + "mp3", + "wav", + "flac", + "oga", + "wma", + "txt", + "doc", + "docx", + "ico", + "glb", + "zip", + "rar", + "csv", + "xls", + "xlsx", + "html", + "xml" + ], + "enableHtmlSanitizer": true, + "enableStagingMode": false, + "disableExtensionManagement": false + }, + "inAppPurchases": [] + } + } + } } } } @@ -77874,9 +78309,11 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { @@ -77886,6 +78323,7 @@ } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -78013,12 +78451,12 @@ "description": "Unique identity of ACL role." }, "name": { - "type": "string", - "description": "Name of the ACL role defined." + "description": "Name of the ACL role defined.", + "type": "string" }, "description": { - "type": "string", - "description": "A short description of the ACL role." + "description": "A short description of the ACL role.", + "type": "string" }, "privileges": { "type": "array", @@ -78028,9 +78466,9 @@ "description": "Privileges like read, write, delete, etc." }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", - "format": "date-time", - "description": "Time and date when the ACL role was deleted." + "format": "date-time" }, "createdAt": { "type": "string", @@ -78123,34 +78561,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -78170,9 +78617,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -78182,6 +78631,7 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, @@ -78222,10 +78672,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78638,40 +79090,40 @@ "description": "Unique identity of App." }, "name": { - "type": "string", - "description": "Name of the app." + "description": "Name of the app.", + "type": "string" }, "path": { - "type": "string", - "description": "A relative URL to the app." + "description": "A relative URL to the app.", + "type": "string" }, "author": { - "type": "string", - "description": "Creator of the App." + "description": "Creator of the App.", + "type": "string" }, "copyright": { - "type": "string", - "description": "Legal rights on the created app." + "description": "Legal rights on the created app.", + "type": "string" }, "license": { - "type": "string", - "description": "Software license's like MIT, etc." + "description": "Software license's like MIT, etc.", + "type": "string" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the app is enabled for selection." + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" }, "configurable": { - "type": "boolean", - "description": "When boolean value is `true`, the app is configurable for further customizations." + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" }, "privacy": { - "type": "string", - "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app." + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" }, "version": { - "type": "string", - "description": "Version of the plugin." + "description": "Version of the plugin.", + "type": "string" }, "icon": { "description": "Icon for the app.", @@ -78697,12 +79149,12 @@ "description": "Configuration properties or settings related to cookies of an app." }, "allowDisable": { - "type": "boolean", - "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app." + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" }, "baseAppUrl": { - "type": "string", - "description": "Root URL for an app." + "description": "Root URL for an app.", + "type": "string" }, "allowedHosts": { "type": "array", @@ -78712,9 +79164,9 @@ "description": "Indicates the allowed or permitted hosts that the application can communicate with or accept requests from." }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize one of the templates from the list." + "format": "int64" }, "checkoutGatewayUrl": { "type": "string" @@ -78757,14 +79209,14 @@ "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of integration." + "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of ACL Role." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -78871,21 +79323,26 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78959,29 +79416,29 @@ "description": "Unique identity of app's action button." }, "entity": { - "type": "string", - "description": "Indicates in which particular entity." + "description": "Indicates in which particular entity.", + "type": "string" }, "view": { - "type": "string", - "description": "Indicates whether it is detail page view or listing page view." + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" }, "url": { - "type": "string", - "description": "An url associated with the AppActionButton." + "description": "An url associated with the AppActionButton.", + "type": "string" }, "action": { - "type": "string", - "description": "Indicates the action or functionality that the button performs when clicked or interacted with." + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" }, "label": { "type": "string", "description": "Label given to AppActionButton." }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -79110,21 +79567,25 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object" }, "template": { + "description": "Template that defines app CMS block.", "type": "string" }, "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -79198,29 +79659,29 @@ "description": "Unique identity of app's CMS block." }, "name": { - "type": "string", - "description": "Name of app's CMS block." + "description": "Name of app's CMS block.", + "type": "string" }, "block": { "type": "object", "description": "CMS block." }, "template": { - "type": "string", - "description": "Template that defines app CMS block." + "description": "Template that defines app CMS block.", + "type": "string" }, "styles": { - "type": "string", - "description": "Parameter that relates to the styles or formatting within CMS block." + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" }, "label": { "type": "string", "description": "Label given to AppCmsBlock." }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -79262,10 +79723,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app flow action.", "type": "string" }, "badge": { @@ -79290,7 +79753,7 @@ "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -79298,6 +79761,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -79414,13 +79878,13 @@ "description": "Unique identity of app's flow action." }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "name": { - "type": "string", - "description": "Name of app flow action." + "description": "Name of app flow action.", + "type": "string" }, "badge": { "type": "string" @@ -79455,8 +79919,8 @@ "type": "string" }, "url": { - "type": "string", - "description": "An URL to app flow action." + "description": "An URL to app flow action.", + "type": "string" }, "delayable": { "type": "boolean" @@ -79522,10 +79986,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, "aware": { @@ -79632,13 +80098,13 @@ "description": "Unique identity of app flow event." }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "name": { - "type": "string", - "description": "Unique name of the AppFlowEvent." + "description": "Unique name of the AppFlowEvent.", + "type": "string" }, "aware": { "type": "array", @@ -79692,38 +80158,49 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Name of the app.", "type": "string" }, "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -79849,51 +80326,51 @@ "description": "Unique identity of app's payment method." }, "appName": { - "type": "string", - "description": "Name of the app." + "description": "Name of the app.", + "type": "string" }, "identifier": { - "type": "string", - "description": "It is a unique identity of an AppPaymentMethod." + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" }, "payUrl": { - "type": "string", - "description": "A URL sending the pay request." + "description": "A URL sending the pay request.", + "type": "string" }, "finalizeUrl": { - "type": "string", - "description": "A URL that redirects the user back to the shop." + "description": "A URL that redirects the user back to the shop.", + "type": "string" }, "validateUrl": { - "type": "string", - "description": "A validate URL confirms the authenticity of a payment reference when accessed." + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" }, "captureUrl": { - "type": "string", - "description": "A capture URL allows the payments to be processed and completed once validated." + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" }, "refundUrl": { - "type": "string", - "description": "A refund URL is used to initiate the refund process for a purchase." + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" }, "recurringUrl": { - "type": "string", - "description": "A URL to payment to handle recurring orders like subscriptions." + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of original media." + "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of payment method." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -79937,24 +80414,29 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, "script": { + "description": "Internal field.", "type": "string" }, "config": { "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80057,33 +80539,33 @@ "description": "Unique identity of app's script condition." }, "identifier": { - "type": "string", - "description": "It is a unique identity of an AppScriptCondition." + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" }, "name": { "type": "string", "description": "Unique name of app's script condition." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, defined app script conditions are available for selection." + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" }, "group": { - "type": "string", - "description": "Categorizes script conditions within a specific group." + "description": "Categorizes script conditions within a specific group.", + "type": "string" }, "script": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -80327,15 +80809,19 @@ "pattern": "^[0-9a-f]{32}$" }, "template": { + "description": "Template for an app.", "type": "string" }, "path": { + "description": "A relative URL to the app template.", "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80407,21 +80893,21 @@ "description": "Unique identity of App template." }, "template": { - "type": "string", - "description": "Template for an app." + "description": "Template for an app.", + "type": "string" }, "path": { - "type": "string", - "description": "A relative URL to the app template." + "description": "A relative URL to the app template.", + "type": "string" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, defined app templates are available for selection." + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "hash": { "type": "string" @@ -80471,6 +80957,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80479,10 +80966,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -80499,11 +80988,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -80513,15 +81004,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -80568,6 +81063,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80576,6 +81072,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80599,6 +81096,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -81034,9 +81532,9 @@ "description": "Unique identity of parent category's version." }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the category under which the new category is to be created." + "pattern": "^[0-9a-f]{32}$" }, "afterCategoryVersionId": { "type": "string", @@ -81044,13 +81542,13 @@ "description": "Unique identity of the category's version under which the new category is to be created." }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media added to identify category." + "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { - "type": "boolean", - "description": "Shows nested categories on a product category page." + "description": "Shows nested categories on a product category page.", + "type": "boolean" }, "autoIncrement": { "type": "integer", @@ -81067,15 +81565,15 @@ "description": "Breadcrumbs offer the users on the website the option to quickly find their way back to the homepage or another level of the website using internal links." }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree. ", "type": "integer", "format": "int64", - "readOnly": true, - "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree. " + "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", - "readOnly": true, - "description": "A relative URL to the category." + "readOnly": true }, "childCount": { "type": "integer", @@ -81084,20 +81582,20 @@ "description": "Number of categories below the main category." }, "type": { - "type": "string", - "description": "Type of categories like `page`, `folder`, `link`." + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string" }, "productAssignmentType": { - "type": "string", - "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`." + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "type": "string" }, "visible": { - "type": "boolean", - "description": "Displays categories on category page when true." + "description": "Displays categories on category page when true.", + "type": "boolean" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the category is listed for selection." + "description": "When boolean value is `true`, the category is listed for selection.", + "type": "boolean" }, "cmsPageIdSwitched": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -81154,9 +81652,9 @@ "description": "Keywords that help to search the category." }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page." + "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", @@ -81164,9 +81662,9 @@ "description": "Unique identity of CMS page's version." }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream." + "pattern": "^[0-9a-f]{32}$" }, "customEntityTypeId": { "type": "string", @@ -81188,7 +81686,8 @@ "description": "Contains the translations of all translated fields." }, "parent": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." }, "children": { "description": "Child categories within this category for hierarchical navigation", @@ -81324,44 +81823,56 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -81379,6 +81890,7 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -81519,58 +82031,58 @@ "description": "Unique identity of CMS Section version." }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", - "format": "int64", - "description": "Order of the block indicated by number like 0, 1, 2,..." + "format": "int64" }, "type": { - "type": "string", - "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc." + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" }, "locked": { "type": "boolean", "description": "When locked, then CmsBlock cannot be configured." }, "name": { - "type": "string", - "description": "Unique name of the CMS Block." + "description": "Unique name of the CMS Block.", + "type": "string" }, "sectionPosition": { - "type": "string", - "description": "Position of the section. It can either be `main` or `sidebar`." + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" }, "marginTop": { - "type": "string", - "description": "Defines the margin area on the top of an element." + "description": "Defines the margin area on the top of an element.", + "type": "string" }, "marginBottom": { - "type": "string", - "description": "Defines for the margin area on the bottom of an element." + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" }, "marginLeft": { - "type": "string", - "description": "Defines for the margin area on the left of an element." + "description": "Defines for the margin area on the left of an element.", + "type": "string" }, "marginRight": { - "type": "string", - "description": "Defines the margin area on the right of an element." + "description": "Defines the margin area on the right of an element.", + "type": "string" }, "backgroundColor": { - "type": "string", - "description": "Defines the background color of an element." + "description": "Defines the background color of an element.", + "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of background media." + "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { - "type": "string", - "description": "Background media mode accept values `cover`, `auto`, `contain`." + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" }, "cssClass": { - "type": "string", - "description": "One or more CSS classes added and separated by spaces." + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, "visibility": { "properties": { @@ -81590,9 +82102,9 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of section." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -81647,12 +82159,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -81664,6 +82179,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -81905,16 +82421,16 @@ "description": "Name of the CMS page." }, "type": { - "type": "string", - "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`." + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" }, "entity": { - "type": "string", - "description": "This field will be implemented in the future." + "description": "This field will be implemented in the future.", + "type": "string" }, "cssClass": { - "type": "string", - "description": "One or more CSS classes added and separated by spaces." + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, "config": { "properties": { @@ -81926,9 +82442,9 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media to be previewed." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -82018,38 +82534,48 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -82204,51 +82730,51 @@ "description": "Unique identity of CMS page version." }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", - "format": "int64", - "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2..." + "format": "int64" }, "type": { - "type": "string", - "description": "Types of sections can be `sidebar` or `fullwidth`." + "description": "Types of sections can be `sidebar` or `fullwidth`.", + "type": "string" }, "locked": { "type": "boolean", "description": "When locked, then CmsSection cannot be configured." }, "name": { - "type": "string", - "description": "Name of the CMS section defined." + "description": "Name of the CMS section defined.", + "type": "string" }, "sizingMode": { - "type": "string", - "description": "Sizing mode can be `boxed` or `full_width`." + "description": "Sizing mode can be `boxed` or `full_width`.", + "type": "string" }, "mobileBehavior": { - "type": "string", - "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset." + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" }, "backgroundColor": { - "type": "string", - "description": "Background color of CMS page." + "description": "Background color of CMS page.", + "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS section's background media." + "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { - "type": "string", - "description": "Background media mode can be `cover`, `auto` or `contain`." + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" }, "cssClass": { - "type": "string", - "description": "One or more CSS classes added and separated by spaces." + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of page where CMS section is defined." + "pattern": "^[0-9a-f]{32}$" }, "visibility": { "properties": { @@ -82326,9 +82852,11 @@ "type": "object" }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -82345,6 +82873,7 @@ "readOnly": true }, "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -82428,12 +82957,12 @@ "description": "Con info of cms slot" }, "type": { - "type": "string", - "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc." + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "type": "string" }, "slot": { - "type": "string", - "description": "Key-value pair to configure which element to be shown in which slot." + "description": "Key-value pair to configure which element to be shown in which slot.", + "type": "string" }, "locked": { "type": "boolean", @@ -82453,9 +82982,9 @@ "description": "Each cms slot (element) has a config that has values defined in the admin. When cms loads, each Resolver class adds the resolved config data to this value." }, "blockId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS block where slot is defined." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -82501,34 +83030,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -82575,21 +83114,26 @@ "type": "object" }, "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", "type": "boolean" }, "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", "type": "boolean" }, "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", "type": "boolean" }, "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, "isEu": { @@ -82854,45 +83398,45 @@ "description": "Name of the country." }, "iso": { - "type": "string", - "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc." + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", - "format": "int64", - "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend." + "format": "int64" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the country is available for selection in the storefront." + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" }, "shippingAvailable": { - "type": "boolean", - "description": "The shipping availability for a country is enabled when boolean value is `true`." + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" }, "iso3": { - "type": "string", - "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc." + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" }, "displayStateInRegistration": { - "type": "boolean", - "description": "The country's state is displayed in the address when boolean value is `true`." + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" }, "forceStateInRegistration": { - "type": "boolean", - "description": "State details in the address are force included when boolean value is `true`." + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" }, "checkVatIdPattern": { - "type": "boolean", - "description": "Verify if VAT ID is valid or not." + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" }, "vatIdRequired": { - "type": "boolean", - "description": "Set to true, if VAT ID is to be made mandatory." + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" }, "vatIdPattern": { - "type": "string", - "description": "Unique VAT ID with country code and numbers, for example - GB999 9999" + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" }, "customFields": { "type": "object", @@ -82945,28 +83489,28 @@ "type": "object" }, "postalCodeRequired": { - "type": "boolean", - "description": "The postal code is made mandatory specification in the address, when boolean value is `true`." + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" }, "checkPostalCodePattern": { - "type": "boolean", - "description": "Verify for valid postal code pattern." + "description": "Verify for valid postal code pattern.", + "type": "boolean" }, "checkAdvancedPostalCodePattern": { - "type": "boolean", - "description": "Verify for advanced postal code pattern." + "description": "Verify for advanced postal code pattern.", + "type": "boolean" }, "advancedPostalCodePattern": { - "type": "string", - "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**." + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" }, "addressFormat": { "type": "object", "description": "The address format with recipient's name, building number, street name, city, state and ZIP code on different lines as required." }, "defaultPostalCodePattern": { - "type": "string", - "description": "Default pattern of postal or zip code." + "description": "Default pattern of postal or zip code.", + "type": "string" }, "isEu": { "type": "boolean" @@ -83050,20 +83594,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -83198,26 +83746,26 @@ "description": "Unique identity of the country's state." }, "countryId": { + "description": "Unique identity of the country.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the country." + "pattern": "^[0-9a-f]{32}$" }, "shortCode": { - "type": "string", - "description": "An abbreviation for the country's state." + "description": "An abbreviation for the country's state.", + "type": "string" }, "name": { "type": "string", "description": "Name of the country's state." }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", - "format": "int64", - "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend." + "format": "int64" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the country's state is available for selection in the storefront." + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "type": "boolean" }, "customFields": { "type": "object", @@ -83278,13 +83826,16 @@ "pattern": "^[0-9a-f]{32}$" }, "factor": { + "description": "Currency exchange rate.", "type": "number", "format": "float" }, "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, "shortName": { @@ -83294,6 +83845,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -83302,6 +83854,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -83609,17 +84162,17 @@ "description": "Unique identity of currency." }, "factor": { + "description": "Currency exchange rate.", "type": "number", - "format": "float", - "description": "Currency exchange rate." + "format": "float" }, "symbol": { - "type": "string", - "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $" + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "type": "string" }, "isoCode": { - "type": "string", - "description": "Standard international three digit code to represent currency. For example, USD." + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" }, "shortName": { "type": "string", @@ -83630,18 +84183,18 @@ "description": "Full name of the currency. For example, US-Dollar." }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", - "format": "int64", - "description": "The order of the tabs for multiple currencies defined." + "format": "int64" }, "isSystemDefault": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", - "format": "float", - "description": "The value from which the tax must be exempted." + "format": "float" }, "customFields": { "type": "object", @@ -84011,6 +84564,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -84020,10 +84574,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -84036,9 +84592,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -84074,8 +84632,8 @@ "description": "Unique identity of a custom entity." }, "name": { - "type": "string", - "description": "Unique name of the entity." + "description": "Unique name of the entity.", + "type": "string" }, "fields": { "type": "object", @@ -84086,14 +84644,14 @@ "description": "Indicators used to specify certain settings or characteristics associated with the custom entity." }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of plugin." + "pattern": "^[0-9a-f]{32}$" }, "cmsAware": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -84104,12 +84662,12 @@ "type": "boolean" }, "customFieldsAware": { - "type": "boolean", - "description": "Parameter that indicates the areas in which the custom field is supported." + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" }, "labelProperty": { - "type": "string", - "description": "Specifies which property or attribute of the custom entity is used." + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" }, "deletedAt": { "type": "string", @@ -84146,30 +84704,39 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, + "includeInSearch": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -84264,37 +84831,40 @@ "description": "Unique identity of a custom field." }, "name": { - "type": "string", - "description": "Unique name of a custom field." + "description": "Unique name of a custom field.", + "type": "string" }, "type": { - "type": "string", - "description": "Custom field type can be selection, media , etc" + "description": "Custom field type can be selection, media , etc", + "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the custom field is enabled for use." + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of customFieldSet." + "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { - "type": "boolean", - "description": "When boolean value is `true`, then customers have permission to write data in the custom field." + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" }, "allowCartExpose": { - "type": "boolean", - "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process." + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" }, "storeApiAware": { "type": "boolean" }, + "includeInSearch": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -84334,22 +84904,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -84508,30 +85083,30 @@ "description": "Unique identity of a custom field set." }, "name": { - "type": "string", - "description": "Unique name of a custom field set." + "description": "Unique name of a custom field set.", + "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the custom field set is enabled for use." + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" }, "global": { - "type": "boolean", - "description": "When set to `true`, the custom field set can be used across all sales channels." + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined custom field set to be displayed." + "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of an app." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -84585,10 +85160,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -84654,13 +85231,13 @@ "description": "Unique identity of a custom field set relation." }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a custom field set." + "pattern": "^[0-9a-f]{32}$" }, "entityName": { - "type": "string", - "description": "Name of the entity." + "description": "Name of the entity.", + "type": "string" }, "createdAt": { "type": "string", @@ -84703,26 +85280,32 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -84732,77 +85315,98 @@ "readOnly": true }, "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for customer recovery.", "type": "string" }, "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", "format": "date-time" }, "birthday": { + "description": "To capture customer's birthday details.", "type": "string" }, "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { + "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true @@ -84811,6 +85415,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -84822,10 +85427,12 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -85480,34 +86087,34 @@ "description": "Unique identity of the customer." }, "groupId": { + "description": "Unique identity of customer group.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of customer group." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language." + "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of previous payment method." + "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of default billing address." + "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of default shipping address." + "pattern": "^[0-9a-f]{32}$" }, "autoIncrement": { "type": "integer", @@ -85516,109 +86123,109 @@ "description": "Internal field." }, "customerNumber": { - "type": "string", - "description": "Unique number assigned to identity a customer." + "description": "Unique number assigned to identity a customer.", + "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of salutation." + "pattern": "^[0-9a-f]{32}$" }, "firstName": { - "type": "string", - "description": "First name of the customer." + "description": "First name of the customer.", + "type": "string" }, "lastName": { - "type": "string", - "description": "Last name of the customer." + "description": "Last name of the customer.", + "type": "string" }, "email": { - "type": "string", - "description": "Email ID of the customer." + "description": "Email ID of the customer.", + "type": "string" }, "title": { - "type": "string", - "description": "Titles or honorifics like Mr, Mrs, etc." + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" }, "affiliateCode": { - "type": "string", - "description": "An affiliate code is an identification option with which website operators can mark outgoing links." + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" }, "campaignCode": { - "type": "string", - "description": "A campaign code is the globally unique identifier for a campaign." + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" }, "active": { - "type": "boolean", - "description": "To keep the status of the customer active, the boolean value is set to `true`." + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" }, "doubleOptInRegistration": { - "type": "boolean", - "description": "Set to `true` to allow user subscriptions to an email marketing list." + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", - "format": "date-time", - "description": "Date and time when the double opt-in email was sent." + "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", - "format": "date-time", - "description": "Date and time when the double opt-in email was confirmed." + "format": "date-time" }, "hash": { - "type": "string", - "description": "Password hash for customer recovery." + "description": "Password hash for customer recovery.", + "type": "string" }, "guest": { - "type": "boolean", - "description": "Boolean value is `true` if it is to be a guest account." + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" }, "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", - "format": "date-time", - "description": "To capture date and time of customer's first login." + "format": "date-time" }, "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", - "format": "date-time", - "description": "To capture date and time of customer's last login." + "format": "date-time" }, "birthday": { - "type": "string", - "description": "To capture customer's birthday details." + "description": "To capture customer's birthday details.", + "type": "string" }, "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", - "readOnly": true, - "description": "Captures last order date." + "readOnly": true }, "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "Captures the number of orders placed." + "readOnly": true }, "orderTotalAmount": { + "description": "Sum of total amount to be paid.", "type": "number", "format": "float", - "readOnly": true, - "description": "Sum of total amount to be paid." + "readOnly": true }, "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "Number of reviews the customer has given." + "readOnly": true }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "remoteAddress": { - "type": "string", - "description": "Anonymous IP address of the customer for last session." + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, "tagIds": { "type": "array", @@ -85630,14 +86237,14 @@ "description": "Unique identity of tag." }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of requested group." + "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of bonus sales channel." + "pattern": "^[0-9a-f]{32}$" }, "createdById": { "type": "string", @@ -85782,52 +86389,67 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, "city": { + "description": "Name of customer's city.", "type": "string" }, "company": { + "description": "Name of customer's company.", "type": "string" }, "street": { + "description": "Name of customer's street.", "type": "string" }, "department": { + "description": "Name of customer's department.", "type": "string" }, "title": { + "description": "Titles given to customer like Dr. , Prof., etc", "type": "string" }, "phoneNumber": { + "description": "Customer's phone number.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional customer's address information.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional customer's address information.", "type": "string" }, "hash": { @@ -85991,68 +86613,68 @@ "description": "Unique identity of customer's address." }, "customerId": { + "description": "Unique identity of customer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of customer." + "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of country." + "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of country's state." + "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of salutation." + "pattern": "^[0-9a-f]{32}$" }, "firstName": { - "type": "string", - "description": "First name of the customer." + "description": "First name of the customer.", + "type": "string" }, "lastName": { - "type": "string", - "description": "Last name of the customer." + "description": "Last name of the customer.", + "type": "string" }, "zipcode": { - "type": "string", - "description": "Postal or zip code of customer's address." + "description": "Postal or zip code of customer's address.", + "type": "string" }, "city": { - "type": "string", - "description": "Name of customer's city." + "description": "Name of customer's city.", + "type": "string" }, "company": { - "type": "string", - "description": "Name of customer's company." + "description": "Name of customer's company.", + "type": "string" }, "street": { - "type": "string", - "description": "Name of customer's street." + "description": "Name of customer's street.", + "type": "string" }, "department": { - "type": "string", - "description": "Name of customer's department." + "description": "Name of customer's department.", + "type": "string" }, "title": { - "type": "string", - "description": "Titles given to customer like Dr. , Prof., etc" + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" }, "phoneNumber": { - "type": "string", - "description": "Customer's phone number." + "description": "Customer's phone number.", + "type": "string" }, "additionalAddressLine1": { - "type": "string", - "description": "Additional customer's address information." + "description": "Additional customer's address information.", + "type": "string" }, "additionalAddressLine2": { - "type": "string", - "description": "Additional customer's address information." + "description": "Additional customer's address information.", + "type": "string" }, "hash": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -86107,12 +86729,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -86260,16 +86884,16 @@ "description": "Name of the customer group." }, "displayGross": { - "type": "boolean", - "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer." + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "registrationActive": { - "type": "boolean", - "description": "To enable the registration of partner customer group." + "description": "To enable the registration of partner customer group.", + "type": "boolean" }, "registrationTitle": { "type": "string", @@ -86376,9 +87000,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -86445,13 +87071,13 @@ "description": "Unique identity of the customer recovery account." }, "hash": { - "type": "string", - "description": "Password hash for customer's account recovery." + "description": "Password hash for customer's account recovery.", + "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -86518,10 +87144,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -86651,14 +87279,14 @@ "description": "Unique identity of the customer's wishlist." }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -86707,6 +87335,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -86715,6 +87344,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -86810,9 +87440,9 @@ "description": "Unique identity of the product in customer wishlist." }, "productId": { + "description": "Unique identity of the product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -86820,9 +87450,9 @@ "description": "Unique identity of the product's version." }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the wishlist." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -86866,14 +87496,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -86984,18 +87617,18 @@ "description": "Name given to delivery time." }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", - "format": "int64", - "description": "Minimum delivery time taken." + "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", - "format": "int64", - "description": "Maximum delivery time taken." + "format": "int64" }, "unit": { - "type": "string", - "description": "Unit in which the delivery time is defined. For example, days or hours." + "description": "Unit in which the delivery time is defined. For example, days or hours.", + "type": "string" }, "customFields": { "type": "object", @@ -87409,26 +88042,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the document.", "type": "string" }, "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", "type": "string" }, "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, "documentNumber": { + "description": "Unique number associated with every document.", "type": "string" }, "config": { @@ -87479,6 +88119,7 @@ "type": "object" }, "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -87560,34 +88201,34 @@ "description": "Unique identity of the document base config." }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the document type." + "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the company logo." + "pattern": "^[0-9a-f]{32}$" }, "name": { - "type": "string", - "description": "Name of the document." + "description": "Name of the document.", + "type": "string" }, "filenamePrefix": { - "type": "string", - "description": "A prefix name added to the file name separated by an underscore." + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" }, "filenameSuffix": { - "type": "string", - "description": "A suffix name added to the file name separated by an underscore." + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" }, "global": { - "type": "boolean", - "description": "When set to `true`, the document can be used across all sales channels." + "description": "When set to `true`, the document can be used across all sales channels.", + "type": "boolean" }, "documentNumber": { - "type": "string", - "description": "Unique number associated with every document." + "description": "Unique number associated with every document.", + "type": "string" }, "config": { "type": "object", @@ -87640,14 +88281,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -87771,19 +88415,19 @@ "description": "Unique identity of document's base config sales channel." }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document's base config." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of document type." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -87828,6 +88472,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -87967,8 +88612,8 @@ "description": "Name of the document type." }, "technicalName": { - "type": "string", - "description": "Technical name of document type." + "description": "Technical name of document type.", + "type": "string" }, "createdAt": { "type": "string", @@ -88027,29 +88672,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -88147,39 +88799,39 @@ "description": "Unique identity of flow." }, "name": { - "type": "string", - "description": "Name of the flow." + "description": "Name of the flow.", + "type": "string" }, "eventName": { - "type": "string", - "description": "Name of the event." + "description": "Name of the event.", + "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize one of the flows from the list." + "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", - "readOnly": true, - "description": "When the boolean value is `true`, the flow is no more available for usage." + "readOnly": true }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the flow is available for selection." + "description": "When boolean value is `true`, the flow is available for selection.", + "type": "boolean" }, "description": { - "type": "string", - "description": "A short description of the defined flow." + "description": "A short description of the defined flow.", + "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app flow event." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -88220,24 +88872,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -88326,6 +88983,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -88435,32 +89093,32 @@ "description": "Unique identity of flow sequence." }, "flowId": { + "description": "Unique identity of flow.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of flow." + "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule." + "pattern": "^[0-9a-f]{32}$" }, "actionName": { - "type": "string", - "description": "Unique name of the action in the flow sequence." + "description": "Unique name of the action in the flow sequence.", + "type": "string" }, "config": { "type": "object", "description": "Specifies detailed information about the component." }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined flow sequence is to be displayed." + "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", - "format": "int64", - "description": "The group to which the flow sequence is visible." + "format": "int64" }, "trueCase": { "type": "boolean" @@ -88495,7 +89153,8 @@ "$ref": "#/components/schemas/Rule" }, "parent": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "children": { "type": "array", @@ -88529,6 +89188,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -88562,8 +89222,8 @@ "description": "Unique identity of flow template." }, "name": { - "type": "string", - "description": "Name of the flow template." + "description": "Name of the flow template.", + "type": "string" }, "config": { "type": "object", @@ -88601,20 +89261,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -88681,26 +89346,26 @@ "description": "Unique identity of import-export file." }, "originalName": { - "type": "string", - "description": "Original name of the import-export file." + "description": "Original name of the import-export file.", + "type": "string" }, "path": { - "type": "string", - "description": "A relative URL to the import-export file." + "description": "A relative URL to the import-export file.", + "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", - "format": "date-time", - "description": "Date and time of import-export file expiry." + "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", - "format": "int64", - "description": "Size of the import-export file." + "format": "int64" }, "accessToken": { - "type": "string", - "description": "Secret key to access import-export file." + "description": "Secret key to access import-export file.", + "type": "string" }, "createdAt": { "type": "string", @@ -89060,21 +89725,26 @@ "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -89165,27 +89835,27 @@ "description": "Label given to ImportExportProfile." }, "type": { - "type": "string", - "description": "Import-export type can be orders, customers, categories." + "description": "Import-export type can be orders, customers, categories.", + "type": "string" }, "systemDefault": { - "type": "boolean", - "description": "When boolean value is true `true`, then its a system default profile." + "description": "When boolean value is true `true`, then its a system default profile.", + "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { - "type": "string", - "description": "Type of file like PDF." + "description": "Type of file like PDF.", + "type": "string" }, "delimiter": { - "type": "string", - "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations." + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", + "type": "string" }, "enclosure": { - "type": "string", - "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters." + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", + "type": "string" }, "mapping": { "type": "object", @@ -89243,25 +89913,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -89427,34 +90103,34 @@ "description": "Unique identity of Integration." }, "label": { - "type": "string", - "description": "Label given to Integration." + "description": "Label given to Integration.", + "type": "string" }, "accessKey": { - "type": "string", - "description": "Access key to store api." + "description": "Access key to store api.", + "type": "string" }, "secretAccessKey": { - "type": "string", - "description": "Secret key required for secure communication." + "description": "Secret key required for secure communication.", + "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", - "format": "date-time", - "description": "Date and time when teh integration was last used." + "format": "date-time" }, "admin": { - "type": "boolean", - "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions." + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", + "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", - "format": "date-time", - "description": "Date and time when the integration was deleted." + "format": "date-time" }, "createdAt": { "type": "string", @@ -89952,14 +90628,17 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, "active": { @@ -89981,6 +90660,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -90436,18 +91116,18 @@ "description": "Unique identity of parent language." }, "localeId": { + "description": "Unique identity of locale.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of locale." + "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of translation code." + "pattern": "^[0-9a-f]{32}$" }, "name": { - "type": "string", - "description": "Name of the language." + "description": "Name of the language.", + "type": "string" }, "active": { "type": "boolean" @@ -90467,7 +91147,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, "locale": { "$ref": "#/components/schemas/Locale", @@ -90563,6 +91244,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -90674,8 +91356,8 @@ "description": "Unique identity of locale." }, "code": { - "type": "string", - "description": "Code given to the locale. For example: en-CA." + "description": "Code given to the locale. For example: en-CA.", + "type": "string" }, "name": { "type": "string", @@ -90734,9 +91416,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -90776,13 +91460,13 @@ "description": "Unique identity of log entry." }, "message": { - "type": "string", - "description": "Indicates text or content of a log entry." + "description": "Indicates text or content of a log entry.", + "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", - "format": "int64", - "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc." + "format": "int64" }, "channel": { "type": "string" @@ -91227,6 +91911,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -91310,8 +91995,8 @@ "description": "Name of the mail template." }, "technicalName": { - "type": "string", - "description": "Technical name of mail template." + "description": "Technical name of mail template.", + "type": "string" }, "availableEntities": { "type": "object", @@ -91367,6 +92052,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -91375,6 +92061,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -91383,6 +92070,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -91508,9 +92196,9 @@ "description": "Unique identity of main category." }, "productId": { + "description": "Unique identity of the product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -91518,9 +92206,9 @@ "description": "Unique identity of the product's version." }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the category." + "pattern": "^[0-9a-f]{32}$" }, "categoryVersionId": { "type": "string", @@ -91528,9 +92216,9 @@ "description": "Unique identity of the category's version." }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -91853,28 +92541,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -91908,6 +92603,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -92759,38 +93455,38 @@ "description": "Unique identity of the media." }, "userId": { + "description": "Unique identity of the user", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the user" + "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media folder." + "pattern": "^[0-9a-f]{32}$" }, "mimeType": { - "type": "string", - "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg." + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" }, "fileExtension": { - "type": "string", - "description": "Type of file indication. For example: jpeg, png." + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", - "readOnly": true, - "description": "Date and time at which media was added." + "readOnly": true }, "fileName": { - "type": "string", - "description": "Name of the media file uploaded." + "description": "Name of the media file uploaded.", + "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "Size of the file media file uploaded." + "readOnly": true }, "metaData": { "type": "object", @@ -92825,8 +93521,8 @@ "type": "boolean" }, "private": { - "type": "boolean", - "description": "When `true`, the media display is kept private." + "description": "When `true`, the media display is kept private.", + "type": "boolean" }, "customFields": { "type": "object", @@ -93076,6 +93772,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -93143,8 +93840,8 @@ "description": "Unique identity of media default folder." }, "entity": { - "type": "string", - "description": "Indicates in which particular entity." + "description": "Indicates in which particular entity.", + "type": "string" }, "customFields": { "type": "object", @@ -93184,13 +93881,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -93204,10 +93904,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -93226,6 +93928,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -93396,18 +94099,18 @@ "description": "Unique identity of media folder." }, "useParentConfiguration": { - "type": "boolean", - "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder. " + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder. ", + "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of configuration." + "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of default folder." + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -93421,13 +94124,13 @@ "description": "Number of media within the media folder." }, "path": { + "description": "A relative URL to the media folder.", "type": "string", - "readOnly": true, - "description": "A relative URL to the media folder." + "readOnly": true }, "name": { - "type": "string", - "description": "Name of media folder." + "description": "Name of media folder.", + "type": "string" }, "customFields": { "type": "object", @@ -93444,7 +94147,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." }, "children": { "type": "array", @@ -93483,16 +94187,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -93595,21 +94303,21 @@ "description": "Unique identity of media folder configuration." }, "createThumbnails": { - "type": "boolean", - "description": "When boolean value is `true`, it enables thumbnail creation automatically." + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", + "type": "boolean" }, "keepAspectRatio": { - "type": "boolean", - "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating." + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", + "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", - "format": "int64", - "description": "Parameter that controls the balance between image quality and size when creating thumbnail images." + "format": "int64" }, "private": { - "type": "boolean", - "description": "When boolean value is `true`, the folder contents are restricted from public access." + "description": "When boolean value is `true`, the folder contents are restricted from public access.", + "type": "boolean" }, "noAssociation": { "type": "boolean" @@ -93721,6 +94429,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -93729,17 +94438,19 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -93841,25 +94552,25 @@ "description": "Unique identity of media thumbnail." }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "Width of the thumbnail." + "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "Height of the thumbnail." + "readOnly": true }, "url": { "description": "Public url of media thumbnail.", @@ -93909,10 +94620,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -94015,14 +94728,14 @@ "description": "Unique identity of media thumbnail size defined." }, "width": { + "description": "Width of the thumbnail.", "type": "integer", - "format": "int64", - "description": "Width of the thumbnail." + "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", - "format": "int64", - "description": "Height of the thumbnail." + "format": "int64" }, "customFields": { "type": "object", @@ -94074,48 +94787,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -94274,64 +95000,64 @@ "description": "Unique identity of newsletter recipient." }, "email": { - "type": "string", - "description": "Email of the recipient." + "description": "Email of the recipient.", + "type": "string" }, "title": { - "type": "string", - "description": "Title of the recipient's newsletter." + "description": "Title of the recipient's newsletter.", + "type": "string" }, "firstName": { - "type": "string", - "description": "First name of the recipient." + "description": "First name of the recipient.", + "type": "string" }, "lastName": { - "type": "string", - "description": "Last name of the recipient." + "description": "Last name of the recipient.", + "type": "string" }, "zipCode": { - "type": "string", - "description": "Zipcode of the recipient's address." + "description": "Zipcode of the recipient's address.", + "type": "string" }, "city": { - "type": "string", - "description": "City of the recipient." + "description": "City of the recipient.", + "type": "string" }, "street": { - "type": "string", - "description": "Street of the recipient." + "description": "Street of the recipient.", + "type": "string" }, "status": { - "type": "string", - "description": "When status is set, the NewsletterRecipient is made visible." + "description": "When status is set, the NewsletterRecipient is made visible.", + "type": "string" }, "hash": { - "type": "string", - "description": "Password hash for account recovery." + "description": "Password hash for account recovery.", + "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", - "format": "date-time", - "description": "Date and time when the Newsletter was received." + "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of salutation." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -94410,12 +95136,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -94426,10 +95155,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -94525,16 +95256,16 @@ "description": "Unique identity of notification." }, "status": { - "type": "string", - "description": "When status is set, the Notification is made visible." + "description": "When status is set, the Notification is made visible.", + "type": "string" }, "message": { - "type": "string", - "description": "Indicates text or content of a notification message. " + "description": "Indicates text or content of a notification message. ", + "type": "string" }, "adminOnly": { - "type": "boolean", - "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only." + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" }, "requiredPrivileges": { "type": "array", @@ -94545,14 +95276,14 @@ "description": "Parameter within a notification configuration that specifies the required user privileges or permissions to access or view a particular notification." }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of createdByIntegration." + "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of createdByUser." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -94594,10 +95325,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -94607,9 +95340,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -94745,13 +95480,13 @@ "description": "Unique identity of number range." }, "typeId": { + "description": "Unique identity of type.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of type." + "pattern": "^[0-9a-f]{32}$" }, "global": { - "type": "boolean", - "description": "When set to `true`, the defined number range is used across all sales channels." + "description": "When set to `true`, the defined number range is used across all sales channels.", + "type": "boolean" }, "name": { "type": "string", @@ -94762,13 +95497,13 @@ "description": "A short description of number range." }, "pattern": { - "type": "string", - "description": "Custom formatting in order to include for example, the date in the number range." + "description": "Custom formatting in order to include for example, the date in the number range.", + "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", - "format": "int64", - "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019" + "format": "int64" }, "customFields": { "type": "object", @@ -94821,14 +95556,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -94953,19 +95691,19 @@ "description": "Unique identity of Sales channels's number rage." }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number rage." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Sales channels." + "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number rage type." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -95007,6 +95745,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -95077,9 +95816,9 @@ "description": "Unique identity of number range's state." }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of number range." + "pattern": "^[0-9a-f]{32}$" }, "lastValue": { "type": "integer", @@ -95119,12 +95858,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -95229,16 +95970,16 @@ "description": "Unique identity of number range's type." }, "technicalName": { - "type": "string", - "description": "Name of the number range type." + "description": "Name of the number range type.", + "type": "string" }, "typeName": { "type": "string", "description": "Name of the type." }, "global": { - "type": "boolean", - "description": "When set to `true`, the defined number range type is used across all sales channels." + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "type": "boolean" }, "customFields": { "type": "object", @@ -95307,9 +96048,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -95334,22 +96077,27 @@ "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -95391,21 +96139,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -95467,36 +96219,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", "type": "string" }, "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -95510,10 +96270,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -96100,13 +96862,13 @@ "description": "Internal field." }, "orderNumber": { - "type": "string", - "description": "Unique number associated with every order." + "description": "Unique number associated with every order.", + "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the billing address." + "pattern": "^[0-9a-f]{32}$" }, "billingAddressVersionId": { "type": "string", @@ -96130,29 +96892,29 @@ "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the currency." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the language." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", - "format": "date-time", - "description": "Timestamp when the order was placed." + "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", - "readOnly": true, - "description": "Date when the order was placed." + "readOnly": true }, "price": { "required": [ @@ -96199,27 +96961,27 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", - "readOnly": true, - "description": "Gross price of the order." + "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", - "readOnly": true, - "description": "Net price of the order." + "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", - "readOnly": true, - "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc." + "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", - "readOnly": true, - "description": "TaxStatus takes `Free`, `Net` or `Gross` as values." + "readOnly": true }, "shippingCosts": { "required": [ @@ -96289,46 +97051,46 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", - "readOnly": true, - "description": "Total shipping cost of the ordered product." + "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", - "format": "float", - "description": "Rate at which currency is exchanged." + "format": "float" }, "deepLinkCode": { - "type": "string", - "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers." + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", + "type": "string" }, "affiliateCode": { - "type": "string", - "description": "An affiliate code is an identification option with which website operators can mark outgoing links." + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" }, "campaignCode": { - "type": "string", - "description": "A campaign code is the globally unique identifier for a campaign." + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" }, "customerComment": { - "type": "string", - "description": "Comments given by comments." + "description": "Comments given by comments.", + "type": "string" }, "internalComment": { "type": "string" }, "source": { - "type": "string", - "description": "Source of orders either via normal order placement or subscriptions." + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state." + "pattern": "^[0-9a-f]{32}$" }, "ruleIds": { "type": "array", @@ -96342,14 +97104,14 @@ "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of createdBy." + "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of updatedBy." + "pattern": "^[0-9a-f]{32}$" }, "itemRounding": { "required": [ @@ -96517,14 +97279,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -96533,43 +97298,52 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "street": { + "description": "Street address", "type": "string" }, "zipcode": { + "description": "Zip code of the country.", "type": "string" }, "city": { + "description": "Name of the city.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "department": { + "description": "Name of the department.", "type": "string" }, "title": { - "type": "string" - }, - "vatId": { + "description": "Title name given to customer like DR. , Prof., etc.", "type": "string" }, "phoneNumber": { + "description": "Phone number of the customer.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional address input if necessary.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional address input if necessary.", "type": "string" }, "hash": { @@ -96579,6 +97353,11 @@ "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -96769,19 +97548,19 @@ "description": "Unique identity of OrderAddresses version." }, "countryId": { + "description": "Unique identity of country.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of country." + "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state." + "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", @@ -96789,57 +97568,53 @@ "description": "Unique identity of order's version." }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of salutation." + "pattern": "^[0-9a-f]{32}$" }, "firstName": { - "type": "string", - "description": "First name of the customer." + "description": "First name of the customer.", + "type": "string" }, "lastName": { - "type": "string", - "description": "Last name of the customer." + "description": "Last name of the customer.", + "type": "string" }, "street": { - "type": "string", - "description": "Street address" + "description": "Street address", + "type": "string" }, "zipcode": { - "type": "string", - "description": "Zip code of the country." + "description": "Zip code of the country.", + "type": "string" }, "city": { - "type": "string", - "description": "Name of the city." + "description": "Name of the city.", + "type": "string" }, "company": { - "type": "string", - "description": "Name of the company." + "description": "Name of the company.", + "type": "string" }, "department": { - "type": "string", - "description": "Name of the department." + "description": "Name of the department.", + "type": "string" }, "title": { - "type": "string", - "description": "Title name given to customer like DR. , Prof., etc." - }, - "vatId": { - "type": "string", - "description": "Unique identity of VAT." + "description": "Title name given to customer like DR. , Prof., etc.", + "type": "string" }, "phoneNumber": { - "type": "string", - "description": "Phone number of the customer." + "description": "Phone number of the customer.", + "type": "string" }, "additionalAddressLine1": { - "type": "string", - "description": "Additional address input if necessary." + "description": "Additional address input if necessary.", + "type": "string" }, "additionalAddressLine2": { - "type": "string", - "description": "Additional address input if necessary." + "description": "Additional address input if necessary.", + "type": "string" }, "hash": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -96849,6 +97624,11 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -96904,10 +97684,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -96916,22 +97698,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -96941,12 +97729,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -97077,14 +97867,14 @@ "description": "Unique identity of OrderCustomer's version." }, "customerId": { + "description": "Unique identity of customer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of customer." + "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", @@ -97092,29 +97882,29 @@ "description": "Unique identity of order's version." }, "email": { - "type": "string", - "description": "Email address of the customer." + "description": "Email address of the customer.", + "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of salutation." + "pattern": "^[0-9a-f]{32}$" }, "firstName": { - "type": "string", - "description": "First name of the customer." + "description": "First name of the customer.", + "type": "string" }, "lastName": { - "type": "string", - "description": "Last name of the customer." + "description": "Last name of the customer.", + "type": "string" }, "company": { - "type": "string", - "description": "Name of the company." + "description": "Name of the company.", + "type": "string" }, "title": { - "type": "string", - "description": "Title name given to the customer like Dr, prof. etc." + "description": "Title name given to the customer like Dr, prof. etc.", + "type": "string" }, "vatIds": { "type": "array", @@ -97124,16 +97914,16 @@ "description": "Unique identity of VAT." }, "customerNumber": { - "type": "string", - "description": "Unique number assigned to the customer." + "description": "Unique number assigned to the customer.", + "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "remoteAddress": { - "type": "string", - "description": "Anonymous IP address of the customer for last session." + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, "createdAt": { "type": "string", @@ -97183,6 +97973,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -97191,6 +97982,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -97199,10 +97991,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -97213,10 +98007,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -97503,9 +98299,9 @@ "description": "Unique identity of OrderDelivery's version." }, "orderId": { + "description": "Unique identity of order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", @@ -97513,9 +98309,9 @@ "description": "Unique identity of order's version." }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order's shipping address." + "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressVersionId": { "type": "string", @@ -97523,14 +98319,14 @@ "description": "Unique identity of order's shipping address version." }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method." + "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state." + "pattern": "^[0-9a-f]{32}$" }, "trackingCodes": { "type": "array", @@ -97540,14 +98336,14 @@ "description": "Tracking code is a unique URL code assigned to each package, which allows you to monitor the movement of the parcel." }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", - "format": "date-time", - "description": "Date and time of earliest delivery of products." + "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", - "format": "date-time", - "description": "Date and time of latest delivery of products." + "format": "date-time" }, "shippingCosts": { "required": [ @@ -97680,6 +98476,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -97688,6 +98485,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -97753,14 +98551,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -97864,9 +98665,9 @@ "description": "Unique identity of OrderDeliveryPosition's version." }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order delivery." + "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryVersionId": { "type": "string", @@ -97874,9 +98675,9 @@ "description": "Unique identity of order delivery's version." }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of line items in an order." + "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", @@ -97951,19 +98752,19 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." + "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", - "format": "float", - "description": "Cost of product based on quantity." + "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", - "format": "int64", - "description": "Number of items of each product." + "format": "int64" }, "customFields": { "type": "object", @@ -98001,9 +98802,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -98015,6 +98816,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -98023,6 +98825,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -98031,6 +98834,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -98043,44 +98847,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -98142,22 +98949,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -98459,9 +99277,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -98475,9 +99293,9 @@ "description": "Unique identity of OrderLineItem's version." }, "orderId": { + "description": "Unique identity of order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order." + "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", @@ -98485,9 +99303,9 @@ "description": "Unique identity of order's version." }, "productId": { + "description": "Unique identity of product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -98495,9 +99313,9 @@ "description": "Unique identity of products's version." }, "promotionId": { + "description": "Unique identity of product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product." + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -98510,54 +99328,47 @@ "description": "Unique identity of parent's version." }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of cover image." + "pattern": "^[0-9a-f]{32}$" }, "identifier": { - "type": "string", - "description": "It is a unique identity of an item in cart before its converted to an order." + "description": "It is a unique identity of an item in cart before its converted to an order.", + "type": "string" }, "referencedId": { - "type": "string", - "description": "Unique identity of type of entity." + "description": "Unique identity of type of entity.", + "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", - "format": "int64", - "description": "Number of items of product." + "format": "int64" }, "label": { - "type": "string", - "description": "It is a typical product name given to the line item." + "description": "It is a typical product name given to the line item.", + "type": "string" }, "payload": { "type": "object", "description": "Any data related to product is passed." }, "good": { - "type": "boolean", - "description": "When set to true, it indicates the line item is physical else it is virtual." + "description": "When set to true, it indicates the line item is physical else it is virtual.", + "type": "boolean" }, "removable": { - "type": "boolean", - "description": "Allows the line item to be removable from the cart when set to true." + "description": "Allows the line item to be removable from the cart when set to true.", + "type": "boolean" }, "stackable": { - "type": "boolean", - "description": "Allows to change the quantity of the line item when set to true." + "description": "Allows to change the quantity of the line item when set to true.", + "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", - "format": "int64", - "description": "Position of line items placed in an order." - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Internal field." + "format": "int64" }, "price": { "required": [ @@ -98631,27 +99442,35 @@ "description": "Description of how the price has to be calculated. For example, in percentage or absolute value, etc." }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", - "format": "float", - "description": "Price of product per item (where, quantity=1)." + "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", - "format": "float", - "description": "Cost of product based on quantity." + "format": "float" }, "description": { - "type": "string", - "description": "Description of line items in an order." + "description": "Description of line items in an order.", + "type": "string" }, "type": { - "type": "string", - "description": "Type refers to the entity type of an item whether it is product or promotion for instance." + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true, + "description": "Internal field." + }, "createdAt": { "type": "string", "format": "date-time", @@ -98732,6 +99551,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -98740,14 +99560,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -98852,9 +99675,9 @@ "description": "Unique identity of Order line item downloaded version." }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Order line item." + "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", @@ -98862,18 +99685,18 @@ "description": "Unique identity of Order line item's version." }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc." + "format": "int64" }, "accessGranted": { - "type": "boolean", - "description": "When boolean value is `true`, the digital product is allowed to download." + "description": "When boolean value is `true`, the digital product is allowed to download.", + "type": "boolean" }, "customFields": { "type": "object", @@ -98958,6 +99781,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -98966,6 +99790,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -99030,6 +99855,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -99227,9 +100053,9 @@ "description": "Unique identity of OrderTransaction's version." }, "orderId": { + "description": "Unique identity of an order.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of an order." + "pattern": "^[0-9a-f]{32}$" }, "orderVersionId": { "type": "string", @@ -99237,9 +100063,9 @@ "description": "Unique identity of an order's version." }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of payment method." + "pattern": "^[0-9a-f]{32}$" }, "amount": { "required": [ @@ -99305,9 +100131,9 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -99403,6 +100229,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -99411,10 +100238,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -99606,9 +100435,9 @@ "description": "Unique identity of order transaction capture's version." }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction." + "pattern": "^[0-9a-f]{32}$" }, "orderTransactionVersionId": { "type": "string", @@ -99616,13 +100445,13 @@ "description": "Unique identity of order transaction version." }, "stateId": { + "description": "Unique identity of order state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order state." + "pattern": "^[0-9a-f]{32}$" }, "externalReference": { - "type": "string", - "description": "External payment provider token." + "description": "External payment provider token.", + "type": "string" }, "amount": { "required": [ @@ -99769,6 +100598,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -99777,13 +100607,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -99975,9 +100808,9 @@ "description": "Unique identity of order transaction capture refund's version." }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture." + "pattern": "^[0-9a-f]{32}$" }, "captureVersionId": { "type": "string", @@ -99985,17 +100818,17 @@ "description": "Unique identity of order transaction capture's version." }, "stateId": { + "description": "Unique identity of order state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order state." + "pattern": "^[0-9a-f]{32}$" }, "externalReference": { - "type": "string", - "description": "External payment provider token. " + "description": "External payment provider token. ", + "type": "string" }, "reason": { - "type": "string", - "description": "Reason for refunding the amount for an order." + "description": "Reason for refunding the amount for an order.", + "type": "string" }, "amount": { "required": [ @@ -100142,6 +100975,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -100150,6 +100984,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -100158,12 +100993,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -100325,9 +101163,9 @@ "description": "Unique identity of order transaction capture refund position's version." }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order transaction capture refund." + "pattern": "^[0-9a-f]{32}$" }, "refundVersionId": { "type": "string", @@ -100335,9 +101173,9 @@ "description": "Unique identity of order transaction capture refund's version." }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of order line item." + "pattern": "^[0-9a-f]{32}$" }, "orderLineItemVersionId": { "type": "string", @@ -100345,17 +101183,17 @@ "description": "Unique identity of order line item version." }, "externalReference": { - "type": "string", - "description": "External payment provider token." + "description": "External payment provider token.", + "type": "string" }, "reason": { - "type": "string", - "description": "Reason for refunding the amount for an order." + "description": "Reason for refunding the amount for an order.", + "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", - "format": "int64", - "description": "Quantity of line item to be refunded." + "format": "int64" }, "amount": { "required": [ @@ -100491,10 +101329,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -100508,23 +101348,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -100818,13 +101663,13 @@ "description": "Unique identity of payment method." }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of plugin." + "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { - "type": "string", - "description": "Internal field that contains system identifier details for payment methods like Paypal." + "description": "Internal field that contains system identifier details for payment methods like Paypal.", + "type": "string" }, "name": { "type": "string", @@ -100840,31 +101685,31 @@ "description": "A short description about the payment method." }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc." + "format": "int64" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the payment methods are available for selection in the storefront." + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "type": "boolean" }, "afterOrderEnabled": { - "type": "boolean", - "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure." + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "type": "boolean" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule." + "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "formattedHandlerIdentifier": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -100953,46 +101798,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -101087,62 +101945,62 @@ "description": "Unique identity of a plugin." }, "baseClass": { - "type": "string", - "description": "Name of the new class that extends from Shopware's abstract Plugin class." + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", + "type": "string" }, "name": { - "type": "string", - "description": "Unique name of the plugin." + "description": "Unique name of the plugin.", + "type": "string" }, "composerName": { - "type": "string", - "description": "Name of the composer package name." + "description": "Name of the composer package name.", + "type": "string" }, "autoload": { "type": "object", "description": "This ensures to automatically load all class files of a project before using them." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the plugin is available." + "description": "When boolean value is `true`, the plugin is available.", + "type": "boolean" }, "managedByComposer": { - "type": "boolean", - "description": "A property to check whether it is installed via composer or not." + "description": "A property to check whether it is installed via composer or not.", + "type": "boolean" }, "path": { - "type": "string", - "description": "A relative URL to the plugin." + "description": "A relative URL to the plugin.", + "type": "string" }, "author": { - "type": "string", - "description": "Creator of the plugin." + "description": "Creator of the plugin.", + "type": "string" }, "copyright": { - "type": "string", - "description": "Legal rights on the created plugin." + "description": "Legal rights on the created plugin.", + "type": "string" }, "license": { - "type": "string", - "description": "Software license's like MIT, etc." + "description": "Software license's like MIT, etc.", + "type": "string" }, "version": { - "type": "string", - "description": "Version of the plugin." + "description": "Version of the plugin.", + "type": "string" }, "upgradeVersion": { - "type": "string", - "description": "Update version available for upgrading plugins." + "description": "Update version available for upgrading plugins.", + "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", - "format": "date-time", - "description": "Date and time when the plugin was installed." + "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", - "format": "date-time", - "description": "Date and time when the plugin was upgraded." + "format": "date-time" }, "icon": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -101228,6 +102086,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -101236,14 +102095,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -101252,14 +102114,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -101268,6 +102133,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -101282,9 +102148,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -101294,21 +102162,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "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", "format": "int64" }, @@ -101319,6 +102192,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -101329,32 +102203,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -101364,29 +102246,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -101445,20 +102334,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -101493,6 +102377,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -101541,6 +102437,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -102481,9 +103378,9 @@ "description": "Unique identity of the parent product's version." }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the manufacturer." + "pattern": "^[0-9a-f]{32}$" }, "productManufacturerVersionId": { "type": "string", @@ -102491,19 +103388,19 @@ "description": "Unique identity of the product's manufacturer version." }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the unit." + "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax." + "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of a ProductMedia item used as product cover." + "pattern": "^[0-9a-f]{32}$" }, "productMediaVersionId": { "type": "string", @@ -102511,28 +103408,28 @@ "description": "Unique identity of product's media version." }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of delivery time." + "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of feature set." + "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of canonical product." + "pattern": "^[0-9a-f]{32}$" }, "canonicalProductVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of CMS page." + "pattern": "^[0-9a-f]{32}$" }, "cmsPageVersionId": { "type": "string", @@ -102547,13 +103444,13 @@ "description": "Price of the product." }, "productNumber": { - "type": "string", - "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range." + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", + "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", - "format": "int64", - "description": "The restock time in days indicates how long it will take until a sold out item is back in stock." + "format": "int64" }, "autoIncrement": { "type": "integer", @@ -102562,28 +103459,28 @@ "description": "Internal field." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase." + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", + "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", - "readOnly": true, - "description": "Indicates weather the product is available or not." + "readOnly": true }, "isCloseout": { - "type": "boolean", - "description": "When the value is set to true, the product is hidden when sold out." + "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, - "description": "Indicates the number of products still available. This value results from the stock minus the open orders." + "readOnly": true }, "stock": { + "description": "Indicates the number of products available.", "type": "integer", - "format": "int64", - "description": "Indicates the number of products available." + "format": "int64" }, "variation": { "type": "array", @@ -102593,9 +103490,9 @@ "description": "Internal field." }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", - "readOnly": true, - "description": "Runtime field, cannot be used as part of the criteria." + "readOnly": true }, "variantListingConfig": { "type": "object", @@ -102606,41 +103503,41 @@ "description": "Configuration about which variants and its combination are not available like red shirt in medium size in not available." }, "manufacturerNumber": { - "type": "string", - "description": "Unique number that describes the manufacturer." + "description": "Unique number that describes the manufacturer.", + "type": "string" }, "ean": { - "type": "string", - "description": "Indicates EAN of the product." + "description": "Indicates EAN of the product.", + "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", - "format": "int64", - "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5." + "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", - "format": "int64", - "description": "Maximum number of items that can be purchased." + "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", - "format": "int64", - "description": "Minimum number of items that can be purchased." + "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", - "format": "float", - "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc." + "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml. ", "type": "number", - "format": "float", - "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml. " + "format": "float" }, "shippingFree": { - "type": "boolean", - "description": "Indicates weather the shipping price is free or not." + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" }, "purchasePrices": { "type": "array", @@ -102650,39 +103547,39 @@ "description": "Actual/cost price of the product." }, "markAsTopseller": { - "type": "boolean", - "description": "Indicates weather the product is top seller or not." + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", - "format": "float", - "description": "The weight of the product." + "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", - "format": "float", - "description": "The width of the product." + "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", - "format": "float", - "description": "The height of the product." + "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", - "format": "float", - "description": "The length of the product." + "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", - "format": "date-time", - "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product." + "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", - "readOnly": true, - "description": "Average of all the ratings." + "readOnly": true }, "categoryTree": { "type": "array", @@ -102745,22 +103642,14 @@ "description": "Number of variants the product has." }, "customFieldSetSelectionActive": { - "type": "boolean", - "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled." + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", + "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "Frequency of the product sales." - }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Internal field." + "readOnly": true }, "metaDescription": { "type": "string", @@ -102806,6 +103695,19 @@ }, "description": "List of additional keywords in the search." }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true, + "description": "Internal field." + }, "createdAt": { "type": "string", "format": "date-time", @@ -102828,7 +103730,8 @@ } }, "parent": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, "children": { "description": "Product variants that inherit from this parent product", @@ -103101,6 +104004,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -103109,10 +104013,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -103120,6 +104026,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -103252,9 +104159,9 @@ "description": "Unique identity of Product configurator setting version." }, "productId": { + "description": "Unique identity of product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -103262,23 +104169,23 @@ "description": "Unique identity of product version." }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of option." + "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "object", "description": "Price of the Product." }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc." + "format": "int64" }, "customFields": { "type": "object", @@ -103327,26 +104234,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -103355,6 +104269,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -103488,35 +104403,35 @@ "description": "Name defined for Product cross selling." }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc." + "format": "int64" }, "sortBy": { - "type": "string", - "description": "To sort the display of products by name, price or publication (descending, ascending) date." + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", + "type": "string" }, "sortDirection": { - "type": "string", - "description": "To sort the display of products by ascending or descending order." + "description": "To sort the display of products by ascending or descending order.", + "type": "string" }, "type": { - "type": "string", - "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment." + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", + "type": "string" }, "active": { - "type": "boolean", - "description": "When set to active, the cross-selling feature is enabled." + "description": "When set to active, the cross-selling feature is enabled.", + "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", - "format": "int64", - "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item." + "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -103524,9 +104439,9 @@ "description": "Unique identity of product's version." }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -103575,10 +104490,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -103587,6 +104504,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -103682,14 +104600,14 @@ "description": "Unique identity of Product CrossSelling Assigned Products." }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product CrossSelling." + "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -103697,9 +104615,9 @@ "description": "Unique identity of Product's version." }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc." + "format": "int64" }, "createdAt": { "type": "string", @@ -103778,6 +104696,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -103786,10 +104705,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -103893,9 +104814,9 @@ "description": "Unique identity of downloaded product's version." }, "productId": { + "description": "Unique identity of Product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -103903,14 +104824,14 @@ "description": "Unique identity of Product version." }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", - "format": "int64", - "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display." + "format": "int64" }, "customFields": { "type": "object", @@ -103962,64 +104883,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -104210,83 +105149,83 @@ "description": "Unique identity of Exported Product." }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream ." + "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of storefront's Sales Channel." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of salesChannel." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales Channel Domain." + "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of currency." + "pattern": "^[0-9a-f]{32}$" }, "fileName": { - "type": "string", - "description": "Name of the file." + "description": "Name of the file.", + "type": "string" }, "accessKey": { - "type": "string", - "description": "Access key to admin api." + "description": "Access key to admin api.", + "type": "string" }, "encoding": { - "type": "string", - "description": "Type of encoding like UTF-8 or ASCII." + "description": "Type of encoding like UTF-8 or ASCII.", + "type": "string" }, "fileFormat": { - "type": "string", - "description": "Type of file formats or extensions like CSV or JSON." + "description": "Type of file formats or extensions like CSV or JSON.", + "type": "string" }, "includeVariants": { - "type": "boolean", - "description": "Toggling the product export settings to determine whether or not to include the variants." + "description": "Toggling the product export settings to determine whether or not to include the variants.", + "type": "boolean" }, "generateByCronjob": { - "type": "boolean", - "description": "To determine whether the product exports are generated by cron jobs or live." + "description": "To determine whether the product exports are generated by cron jobs or live.", + "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", - "format": "date-time", - "description": "Date and time when the product exports was last generated." + "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", - "format": "int64", - "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc." + "format": "int64" }, "headerTemplate": { - "type": "string", - "description": "Property to specify the custom content displayed for the header section." + "description": "Property to specify the custom content displayed for the header section.", + "type": "string" }, "bodyTemplate": { - "type": "string", - "description": "Property to specify the custom content displayed for the body section." + "description": "Property to specify the custom content displayed for the body section.", + "type": "string" }, "footerTemplate": { - "type": "string", - "description": "Property to specify the custom content displayed for the footer section." + "description": "Property to specify the custom content displayed for the footer section.", + "type": "string" }, "pausedSchedule": { - "type": "boolean", - "description": "ProductExport generation is paused." + "description": "ProductExport generation is paused.", + "type": "boolean" }, "isRunning": { - "type": "boolean", - "description": "ProductExport is right now generating or not." + "description": "ProductExport is right now generating or not.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -104460,13 +105399,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { @@ -104522,17 +105464,17 @@ "description": "Unique identity of product keyword." }, "languageId": { + "description": "Unique identity of the language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the language." + "pattern": "^[0-9a-f]{32}$" }, "keyword": { - "type": "string", - "description": "The keywords that help to search the product." + "description": "The keywords that help to search the product.", + "type": "string" }, "reversed": { - "type": "string", - "description": "The keywords are revered for the search." + "description": "The keywords are revered for the search.", + "type": "string" }, "language": { "$ref": "#/components/schemas/Language" @@ -104561,6 +105503,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -104677,9 +105620,9 @@ "description": "Unique identity of the ProductManufacturer's version." }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media." + "pattern": "^[0-9a-f]{32}$" }, "link": { "type": "string", @@ -104745,6 +105688,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -104753,10 +105697,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -104891,9 +105837,9 @@ "description": "Unique identity of the ProductMedia version." }, "productId": { + "description": "Unique identity of the product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -104901,14 +105847,14 @@ "description": "Unique identity of the product's version." }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the media." + "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", - "format": "int64", - "description": "The order of the images to be displayed for a product." + "format": "int64" }, "customFields": { "type": "object", @@ -104999,6 +105945,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -105007,6 +105954,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -105017,10 +105965,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -105126,9 +106076,9 @@ "description": "Unique identity of the product price's version." }, "productId": { + "description": "Unique identity of the product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -105136,9 +106086,9 @@ "description": "Unique identity of the product's version." }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the rule." + "pattern": "^[0-9a-f]{32}$" }, "price": { "type": "array", @@ -105148,14 +106098,14 @@ "description": "Price of the Product." }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", - "format": "int64", - "description": "Starting range of quantity of an item." + "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", - "format": "int64", - "description": "Ending range of quantity of an item." + "format": "int64" }, "customFields": { "type": "object", @@ -105237,6 +106187,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -105245,37 +106196,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -105434,9 +106395,9 @@ "description": "Unique identity of the product's review." }, "productId": { + "description": "Unique identity of the product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -105444,48 +106405,48 @@ "description": "Unique identity of the product's version." }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the customer." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the language." + "pattern": "^[0-9a-f]{32}$" }, "externalUser": { - "type": "string", - "description": "External user name." + "description": "External user name.", + "type": "string" }, "externalEmail": { - "type": "string", - "description": "External user email address." + "description": "External user email address.", + "type": "string" }, "title": { - "type": "string", - "description": "Title of product review." + "description": "Title of product review.", + "type": "string" }, "content": { - "type": "string", - "description": "Short description or subject of the project review." + "description": "Short description or subject of the project review.", + "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", - "format": "float", - "description": "A floating point number given to rate a product." + "format": "float" }, "status": { - "type": "boolean", - "description": "When status is set, the rating is made visible." + "description": "When status is set, the rating is made visible.", + "type": "boolean" }, "comment": { - "type": "string", - "description": "Detailed review about the product." + "description": "Detailed review about the product.", + "type": "string" }, "customFields": { "type": "object", @@ -105533,13 +106494,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -105642,18 +106606,18 @@ "description": "Unique identity of Product Search Configuration." }, "languageId": { + "description": "Unique identity of language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language." + "pattern": "^[0-9a-f]{32}$" }, "andLogic": { - "type": "boolean", - "description": "Product search configuration with add logic." + "description": "Product search configuration with add logic.", + "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", - "format": "int64", - "description": "Minimum number of characters used for product search." + "format": "int64" }, "excludedTerms": { "type": "array", @@ -105702,23 +106666,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -105814,31 +106784,31 @@ "description": "Unique identity of Product Search Configuration field." }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Search Configuration." + "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of custom field." + "pattern": "^[0-9a-f]{32}$" }, "field": { - "type": "string", - "description": "Configuration of search field." + "description": "Configuration of search field.", + "type": "string" }, "tokenize": { - "type": "boolean", - "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks." + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", + "type": "boolean" }, "searchable": { - "type": "boolean", - "description": "To configure whether the field can be used for searching." + "description": "To configure whether the field can be used for searching.", + "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", - "format": "int64", - "description": "Search ranking." + "format": "int64" }, "createdAt": { "type": "string", @@ -105883,10 +106853,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -105895,9 +106867,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -106000,14 +106974,14 @@ "description": "Unique identity of ProductSearchKeyword's version." }, "languageId": { + "description": "Unique identity of language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language." + "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of Product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -106015,13 +106989,13 @@ "description": "Unique identity of Product's version." }, "keyword": { - "type": "string", - "description": "The keywords that help to search the product." + "description": "The keywords that help to search the product.", + "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", - "format": "float", - "description": "Search ranking." + "format": "float" }, "createdAt": { "type": "string", @@ -106178,6 +107152,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -106190,6 +107165,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -106355,9 +107334,9 @@ "description": "Internal field." }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", - "readOnly": true, - "description": "When the boolean value is `true`, the ProductStream is no more available for usage." + "readOnly": true }, "name": { "type": "string", @@ -106371,6 +107350,10 @@ "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -106430,6 +107413,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -106438,21 +107422,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -106501,6 +107490,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -106582,9 +107572,9 @@ "description": "Unique identity of product stream filter." }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of product stream." + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -106592,29 +107582,29 @@ "description": "Unique identity of product's parent." }, "type": { - "type": "string", - "description": "Type is either `static` or `stream`." + "description": "Type is either `static` or `stream`.", + "type": "string" }, "field": { - "type": "string", - "description": "Filter by field." + "description": "Filter by field.", + "type": "string" }, "operator": { - "type": "string", - "description": "Filter by operator like >, ==, < , >=, etc." + "description": "Filter by operator like >, ==, < , >=, etc.", + "type": "string" }, "value": { - "type": "string", - "description": "Filter by ProductStreamFilter value." + "description": "Filter by ProductStreamFilter value.", + "type": "string" }, "parameters": { "type": "object", "description": "Additional parameters, such as specifying a date starting from a particular point." }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined product stream filter to be displayed." + "format": "int64" }, "customFields": { "type": "object", @@ -106634,7 +107624,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -106738,6 +107729,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -106746,10 +107738,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -106846,9 +107840,9 @@ "description": "Unique identity of product visibility." }, "productId": { + "description": "Unique identity of the product.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the product." + "pattern": "^[0-9a-f]{32}$" }, "productVersionId": { "type": "string", @@ -106856,14 +107850,14 @@ "description": "Unique identity of the product's version." }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the sales channel." + "pattern": "^[0-9a-f]{32}$" }, "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", - "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." + "format": "int64" }, "createdAt": { "type": "string", @@ -106904,53 +107898,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -107288,71 +108297,71 @@ "description": "Name of the promotion." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase." + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", + "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", - "format": "date-time", - "description": "Date and time from when the promotion code gets valid." + "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", - "format": "date-time", - "description": "Date and time until when the promotion code is valid." + "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", - "format": "int64", - "description": "The frequency at which the voucher can be redeemed worldwide." + "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", - "format": "int64", - "description": "The frequency at which the voucher can be redeemed worldwide per customer." + "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize one of the promotions from the list." + "format": "int64" }, "exclusive": { - "type": "boolean", - "description": "Parameter to exclude the promotion codes on certain products" + "description": "Parameter to exclude the promotion codes on certain products", + "type": "boolean" }, "code": { - "type": "string", - "description": "Promotion code." + "description": "Promotion code.", + "type": "string" }, "useCodes": { - "type": "boolean", - "description": "A boolean value that indicates whether the promotion uses code or not." + "description": "A boolean value that indicates whether the promotion uses code or not.", + "type": "boolean" }, "useIndividualCodes": { - "type": "boolean", - "description": "Indicates either an individual code or generic code for all users." + "description": "Indicates either an individual code or generic code for all users.", + "type": "boolean" }, "individualCodePattern": { - "type": "string", - "description": "Promotion code pattern." + "description": "Promotion code pattern.", + "type": "string" }, "useSetGroups": { - "type": "boolean", - "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered." + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", + "type": "boolean" }, "customerRestriction": { - "type": "boolean", - "description": "Indicates who cannot a use the code." + "description": "Indicates who cannot a use the code.", + "type": "boolean" }, "preventCombination": { - "type": "boolean", - "description": "Indicates which combination of codes are allowed." + "description": "Indicates which combination of codes are allowed.", + "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", - "readOnly": true, - "description": "The number of times the promotion was used." + "readOnly": true }, "ordersPerCustomerCount": { "type": "object", @@ -107493,36 +108502,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -107652,47 +108671,47 @@ "description": "Unique identity of promotion discount." }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion." + "pattern": "^[0-9a-f]{32}$" }, "scope": { - "type": "string", - "description": "Cart or shipping cost." + "description": "Cart or shipping cost.", + "type": "string" }, "type": { - "type": "string", - "description": "Discount is either `absolute` or `percentage`." + "description": "Discount is either `absolute` or `percentage`.", + "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", - "format": "float", - "description": "To filter by PromotionDiscount value." + "format": "float" }, "considerAdvancedRules": { - "type": "boolean", - "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules." + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", + "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", - "format": "float", - "description": "Discount in terms of absolute value." + "format": "float" }, "sorterKey": { - "type": "string", - "description": "Price from `low to high` or `high to low` to sort the product accordingly." + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", + "type": "string" }, "applierKey": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "usageKey": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "pickerKey": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "createdAt": { "type": "string", @@ -107741,14 +108760,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -107845,19 +108867,19 @@ "description": "Unique identity of promotion discount price." }, "discountId": { + "description": "Unique identity of discount.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of discount." + "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of currency." + "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", - "format": "float", - "description": "Price of the discount." + "format": "float" }, "createdAt": { "type": "string", @@ -107927,10 +108949,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -107999,13 +109023,13 @@ "description": "Unique identity of promotion individual code." }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion." + "pattern": "^[0-9a-f]{32}$" }, "code": { - "type": "string", - "description": "Promotion code." + "description": "Promotion code.", + "type": "string" }, "payload": { "type": "object", @@ -108139,14 +109163,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -108243,19 +109270,19 @@ "description": "Unique identity of promotion on sales channel." }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion." + "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize one of the promotion saleschannels from the list." + "format": "int64" }, "createdAt": { "type": "string", @@ -108296,16 +109323,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -108405,22 +109436,22 @@ "description": "Unique identity of promotion set group." }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of promotion." + "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "sorterKey": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", - "format": "float", - "description": "To filter by PromotionSetgroup value." + "format": "float" }, "createdAt": { "type": "string", @@ -108498,15 +109529,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -108591,20 +109626,20 @@ "description": "Description on property group." }, "displayType": { - "type": "string", - "description": "Property groups can be displayed in the form of text, image, dropdown or color." + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", + "type": "string" }, "sortingType": { - "type": "string", - "description": "Sorting the property group by name or position." + "description": "Sorting the property group by name or position.", + "type": "string" }, "filterable": { - "type": "boolean", - "description": "When set to true, the property will be displayed in the product filter of product lists." + "description": "When set to true, the property will be displayed in the product filter of product lists.", + "type": "boolean" }, "visibleOnProductDetailPage": { - "type": "boolean", - "description": "When set to true, the property groups are displayed on product detail page." + "description": "When set to true, the property groups are displayed on product detail page.", + "type": "boolean" }, "position": { "type": "integer", @@ -108656,6 +109691,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -108667,9 +109703,11 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -108868,9 +109906,9 @@ "description": "Unique identity of property group option." }, "groupId": { + "description": "Unique identity of property group.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of property group." + "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string", @@ -108882,13 +109920,13 @@ "description": "The order of the tabs of your defined property group options. Enter numerical values like 1,2,3, etc.to adjust their order of display." }, "colorHexCode": { - "type": "string", - "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff." + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", + "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "combinable": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -108957,16 +109995,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -109452,22 +110494,22 @@ "description": "Unique identity of rule." }, "name": { - "type": "string", - "description": "Name of the rule defined." + "description": "Name of the rule defined.", + "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize one of the rules from the list." + "format": "int64" }, "description": { - "type": "string", - "description": "Description of the rule." + "description": "Description of the rule.", + "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", - "readOnly": true, - "description": "When the boolean value is `true`, the rule is no more available for usage." + "readOnly": true }, "areas": { "type": "array", @@ -109604,13 +110646,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -109622,6 +110667,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -109699,6 +110745,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -109780,18 +110827,18 @@ "description": "Unique identity of rule condition." }, "type": { - "type": "string", - "description": "Different rule types. " + "description": "Different rule types. ", + "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule." + "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of script." + "pattern": "^[0-9a-f]{32}$" }, "parentId": { "type": "string", @@ -109803,9 +110850,9 @@ "description": "Value of the RuleCondition." }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc." + "format": "int64" }, "customFields": { "type": "object", @@ -109828,7 +110875,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -109897,38 +110945,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -109937,10 +110994,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -109949,6 +111008,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -109957,10 +111017,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -109971,24 +111033,30 @@ "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -110010,6 +111078,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -111245,49 +112314,49 @@ "description": "Unique identity of sales channel." }, "typeId": { + "description": "Unique identity of type.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of type." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language used." + "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of customer group." + "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of currency used." + "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of payment method used." + "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method." + "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of country." + "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of country." + "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of navigation category." + "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryVersionId": { "type": "string", @@ -111295,14 +112364,14 @@ "description": "Unique identity of navigation category's version." }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", - "format": "int64", - "description": "It determines the number of levels of subcategories in the storefront category menu." + "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of footer category." + "pattern": "^[0-9a-f]{32}$" }, "footerCategoryVersionId": { "type": "string", @@ -111310,9 +112379,9 @@ "description": "Unique identity of footer category's version." }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of service category." + "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryVersionId": { "type": "string", @@ -111320,14 +112389,14 @@ "description": "Unique identity of service category's version." }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of mail header and footer." + "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of hreflangDefaultDomain." + "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" @@ -111337,32 +112406,32 @@ "description": "Name of the sales channel." }, "shortName": { - "type": "string", - "description": "A short name for sales channel." + "description": "A short name for sales channel.", + "type": "string" }, "taxCalculationType": { - "type": "string", - "description": "Tax calculation types are `horizontal` and `vertical`." + "description": "Tax calculation types are `horizontal` and `vertical`.", + "type": "string" }, "accessKey": { - "type": "string", - "description": "Access key to store api." + "description": "Access key to store api.", + "type": "string" }, "configuration": { "type": "object", "description": "Internal field." }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the sales channel is enabled." + "description": "When boolean value is `true`, the sales channel is enabled.", + "type": "boolean" }, "hreflangActive": { - "type": "boolean", - "description": "When set to true, the sales channel pages are available in different languages." + "description": "When set to true, the sales channel pages are available in different languages.", + "type": "boolean" }, "maintenance": { - "type": "boolean", - "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period." + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", + "type": "boolean" }, "maintenanceIpWhitelist": { "type": "array", @@ -111386,9 +112455,9 @@ "description": "Unique identity of payment method." }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of home CMS page." + "pattern": "^[0-9a-f]{32}$" }, "homeCmsPageVersionId": { "type": "string", @@ -111677,15 +112746,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Unique identity for tracking.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "createdAt": { @@ -111738,9 +112815,14 @@ ] }, "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "description": "Sales channel analytics configuration", "required": [ - "id" + "id", + "active", + "trackOrders", + "anonymizeIp", + "trackOffcanvasCart", + "createdAt" ], "properties": { "id": { @@ -111749,20 +112831,24 @@ "description": "Unique identity of sales channel analytics." }, "trackingId": { - "type": "string", - "description": "Unique identity for tracking." + "description": "Unique identity for tracking.", + "type": "string" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the sales channel analytics are enabled." + "description": "When boolean value is `true`, the sales channel analytics are enabled.", + "type": "boolean" }, "trackOrders": { - "type": "boolean", - "description": "When boolean value is `true`, it enables Google Analytics to track orders." + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", + "type": "boolean" }, "anonymizeIp": { - "type": "boolean", - "description": "Unique identity of anonymize." + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "Track off-canvas cart interactions in Google Analytics", + "type": "boolean" }, "createdAt": { "type": "string", @@ -111770,7 +112856,10 @@ "readOnly": true }, "updatedAt": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "readOnly": true }, @@ -111863,21 +112952,26 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -111885,6 +112979,7 @@ "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -112103,35 +113198,35 @@ "description": "Unique identity of sales channel domain." }, "url": { - "type": "string", - "description": "URL of the sales channel domain." + "description": "URL of the sales channel domain.", + "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language used." + "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of currency." + "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of snippet set." + "pattern": "^[0-9a-f]{32}$" }, "measurementUnits": { "$ref": "#/components/schemas/MeasurementUnits" }, "hreflangUseOnlyLocale": { - "type": "boolean", - "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance." + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", + "type": "boolean" }, "customFields": { "type": "object", @@ -112281,9 +113376,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -112374,12 +113471,12 @@ "description": "Unique identity of sales channel type." }, "coverUrl": { - "type": "string", - "description": "A url for the sales channel type." + "description": "A url for the sales channel type.", + "type": "string" }, "iconName": { - "type": "string", - "description": "An icon for sales channel type." + "description": "An icon for sales channel type.", + "type": "string" }, "screenshotUrls": { "type": "array", @@ -112449,6 +113546,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -112653,8 +113751,8 @@ "description": "Unique identity of salutation." }, "salutationKey": { - "type": "string", - "description": "Technical name given to salutation. For example: mr" + "description": "Technical name given to salutation. For example: mr", + "type": "string" }, "displayName": { "type": "string", @@ -112736,27 +113834,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -112792,36 +113897,36 @@ "description": "Unique identity of scheduled task." }, "name": { - "type": "string", - "description": "Name of the scheduled task." + "description": "Name of the scheduled task.", + "type": "string" }, "scheduledTaskClass": { - "type": "string", - "description": "Unique identity of scheduled task." + "description": "Unique identity of scheduled task.", + "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", - "format": "int64", - "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc" + "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", - "format": "int64", - "description": "Default run interval setting." + "format": "int64" }, "status": { - "type": "string", - "description": "When status is set, the ScheduledTask is made visible." + "description": "When status is set, the ScheduledTask is made visible.", + "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed. ", "type": "string", - "format": "date-time", - "description": "Time when the scheduled task was last executed. " + "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next. ", "type": "string", - "format": "date-time", - "description": "Time when the scheduled task will execute next. " + "format": "date-time" }, "createdAt": { "type": "string", @@ -112856,15 +113961,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -112936,20 +114045,20 @@ "description": "Unique identity of a script." }, "script": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "hook": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "name": { - "type": "string", - "description": "Internal field." + "description": "Internal field.", + "type": "string" }, "active": { - "type": "boolean", - "description": "Internal field." + "description": "Internal field.", + "type": "boolean" }, "appId": { "type": "string", @@ -112992,33 +114101,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -113127,43 +114245,43 @@ "description": "Unique identity of Seo Url." }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of language." + "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The key that references to product or category entity ID." + "pattern": "^[0-9a-f]{32}$" }, "routeName": { - "type": "string", - "description": "A destination routeName that has been registered somewhere in the app's router. For example: \"frontend.detail.page\"" + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \"frontend.detail.page\"", + "type": "string" }, "pathInfo": { - "type": "string", - "description": "Path to product URL. For example: \"/detail/bbf36734504741c79a3bbe3795b91564\"" + "description": "Path to product URL. For example: \"/detail/bbf36734504741c79a3bbe3795b91564\"", + "type": "string" }, "seoPathInfo": { - "type": "string", - "description": "Seo path to product. For example: \"Pepper-white-ground-pearl/SW10098\"" + "description": "Seo path to product. For example: \"Pepper-white-ground-pearl/SW10098\"", + "type": "string" }, "isCanonical": { - "type": "boolean", - "description": "When set to true, search redirects to the main URL." + "description": "When set to true, search redirects to the main URL.", + "type": "boolean" }, "isModified": { - "type": "boolean", - "description": "When boolean value is `true`, the seo url is changed." + "description": "When boolean value is `true`, the seo url is changed.", + "type": "boolean" }, "isDeleted": { - "type": "boolean", - "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later." + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", + "type": "boolean" }, "error": { "description": "Runtime field, cannot be used as part of the criteria.", @@ -113214,19 +114332,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -113295,25 +114418,25 @@ "description": "Unique identity of Seo Url template." }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "entityName": { - "type": "string", - "description": "Name of the entity." + "description": "Name of the entity.", + "type": "string" }, "routeName": { - "type": "string", - "description": "Name of the route." + "description": "Name of the route.", + "type": "string" }, "template": { - "type": "string", - "description": "Template to generate an URL." + "description": "Template to generate an URL.", + "type": "string" }, "isValid": { - "type": "boolean", - "description": "Created SEO URL template can be made usable by setting `isValid` to true." + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", + "type": "boolean" }, "customFields": { "type": "object", @@ -113360,9 +114483,11 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -113370,21 +114495,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -113745,41 +114875,41 @@ "type": "string" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront." + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", + "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc." + "format": "int64" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of availability rule." + "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of media." + "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of deliveryTime." + "pattern": "^[0-9a-f]{32}$" }, "taxType": { - "type": "string", - "description": "Refers `Free`, `Net` or `Gross` type of taxes." + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", + "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax." + "pattern": "^[0-9a-f]{32}$" }, "description": { "type": "string", @@ -113874,26 +115004,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -114026,34 +115162,34 @@ "description": "Unique identity of shipping method price." }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of shipping method." + "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule." + "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", - "format": "int64", - "description": "Shipping price calculated based on quantity, price, weight or volume of items." + "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of rule calculation." + "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", - "format": "float", - "description": "Starting range of quantity of an item." + "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", - "format": "float", - "description": "Ending range of quantity of an item." + "format": "float" }, "currencyPrice": { "type": "array", @@ -114139,16 +115275,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -114219,21 +115359,21 @@ "description": "Unique identity of snippet." }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity od snippet set." + "pattern": "^[0-9a-f]{32}$" }, "translationKey": { - "type": "string", - "description": "Reference to the snippet in the template." + "description": "Reference to the snippet in the template.", + "type": "string" }, "value": { - "type": "string", - "description": "Value of the key." + "description": "Value of the key.", + "type": "string" }, "author": { - "type": "string", - "description": "Creator of the Snippet" + "description": "Creator of the Snippet", + "type": "string" }, "customFields": { "type": "object", @@ -114274,12 +115414,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -114382,15 +115524,15 @@ "description": "Unique identity of snippet set." }, "name": { - "type": "string", - "description": "Name of snippet set." + "description": "Name of snippet set.", + "type": "string" }, "baseFile": { "type": "string" }, "iso": { - "type": "string", - "description": "ISO nomenclature used to classify languages." + "description": "ISO nomenclature used to classify languages.", + "type": "string" }, "customFields": { "type": "object", @@ -114439,6 +115581,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -114581,8 +115724,8 @@ "description": "Unique identity of state machine." }, "technicalName": { - "type": "string", - "description": "Technical name of state machine." + "description": "Technical name of state machine.", + "type": "string" }, "name": { "type": "string", @@ -114652,32 +115795,40 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -114685,6 +115836,9 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -114868,47 +116022,50 @@ "description": "Unique identity of state machine history." }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of reference." + "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of reference's version." + "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine." + "pattern": "^[0-9a-f]{32}$" }, "entityName": { - "type": "string", - "description": "Name of the entity." + "description": "Name of the entity.", + "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of fromState." + "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of toState." + "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { - "type": "string", - "description": "Unique name of transition action." + "description": "Unique name of transition action.", + "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user." + "pattern": "^[0-9a-f]{32}$" }, "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -114959,12 +116116,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -115317,17 +116476,17 @@ "description": "Unique identity of state machine state." }, "technicalName": { - "type": "string", - "description": "Technical name of StateMachineState." + "description": "Technical name of StateMachineState.", + "type": "string" }, "name": { "type": "string", "description": "Display name of StateMachineState." }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of StateMachine." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -115427,17 +116586,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -115567,23 +116730,23 @@ "description": "Unique identity of state machine transition." }, "actionName": { - "type": "string", - "description": "Unique name of the action." + "description": "Unique name of the action.", + "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of state machine." + "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of from state." + "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of to state." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -115629,6 +116792,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -115640,6 +116804,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -115706,8 +116871,8 @@ "description": "Unique identity of system configuration." }, "configurationKey": { - "type": "string", - "description": "Config key for shop configurations." + "description": "Config key for shop configurations.", + "type": "string" }, "configurationValue": { "properties": { @@ -115719,9 +116884,9 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of sales channel." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -116158,14 +117323,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -116299,13 +117466,13 @@ "description": "Unique identity of tax." }, "taxRate": { + "description": "Rate of tax.", "type": "number", - "format": "float", - "description": "Rate of tax." + "format": "float" }, "name": { - "type": "string", - "description": "Name defined for a Tax." + "description": "Name defined for a Tax.", + "type": "string" }, "position": { "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc.", @@ -116366,26 +117533,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -116488,35 +117661,35 @@ "description": "Unique identity of tax provider." }, "identifier": { - "type": "string", - "description": "Unique identity of tax provider." + "description": "Unique identity of tax provider.", + "type": "string" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the tax providers are available for selection in the storefront." + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", + "type": "boolean" }, "name": { "type": "string", "description": "Name of the tax provider." }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", - "format": "int64", - "description": "A numerical value to prioritize one of the tax providers from the list." + "format": "int64" }, "processUrl": { - "type": "string", - "description": "External URL makes request to get tax info." + "description": "External URL makes request to get tax info.", + "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of availability Rule." + "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of app." + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object", @@ -116565,14 +117738,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -116598,10 +117774,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -116728,19 +117906,19 @@ "description": "Unique identity of tax rule." }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax rule type." + "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of country." + "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", - "format": "float", - "description": "Rate of tax defined for a tax rule." + "format": "float" }, "data": { "properties": { @@ -116768,14 +117946,14 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of tax." + "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", - "format": "date-time", - "description": "Date and time when the tax rule is enabled." + "format": "date-time" }, "createdAt": { "type": "string", @@ -116818,10 +117996,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -116897,14 +118077,14 @@ "description": "Unique identity of tax rule type." }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", - "readOnly": true, - "description": "Unique name of tax rule type." + "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", - "format": "int64", - "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc." + "format": "int64" }, "typeName": { "type": "string", @@ -117485,41 +118665,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -117993,55 +119184,55 @@ "description": "Unique identity of the user." }, "localeId": { + "description": "Unique identity of locale.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of locale." + "pattern": "^[0-9a-f]{32}$" }, "username": { - "type": "string", - "description": "Username of the user." + "description": "Username of the user.", + "type": "string" }, "firstName": { - "type": "string", - "description": "First name of the user." + "description": "First name of the user.", + "type": "string" }, "lastName": { - "type": "string", - "description": "Last name of the user." + "description": "Last name of the user.", + "type": "string" }, "title": { - "type": "string", - "description": "Title of the user." + "description": "Title of the user.", + "type": "string" }, "email": { - "type": "string", - "description": "Email of the user." + "description": "Email of the user.", + "type": "string" }, "active": { - "type": "boolean", - "description": "When boolean value is `true`, the user is enabled." + "description": "When boolean value is `true`, the user is enabled.", + "type": "boolean" }, "admin": { - "type": "boolean", - "description": "Parameter that indicates if the user is an admin." + "description": "Parameter that indicates if the user is an admin.", + "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", - "format": "date-time", - "description": "Parameter that indicates when the password was last updated by the user." + "format": "date-time" }, "timeZone": { - "type": "string", - "description": "Time configuration in the user's profile." + "description": "Time configuration in the user's profile.", + "type": "string" }, "customFields": { "type": "object", "description": "Additional fields that offer a possibility to add own fields for the different program-areas." }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of the avatar." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -118180,16 +119371,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -118260,22 +119455,22 @@ "description": "Unique identity of user access key." }, "userId": { + "description": "Unique identity of user.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user." + "pattern": "^[0-9a-f]{32}$" }, "accessKey": { - "type": "string", - "description": "Access key to admin api." + "description": "Access key to admin api.", + "type": "string" }, "secretAccessKey": { - "type": "string", - "description": "Secret key to admin api." + "description": "Secret key to admin api.", + "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", - "format": "date-time", - "description": "Parameter that indicates when the access key was last accessed." + "format": "date-time" }, "customFields": { "type": "object", @@ -118315,10 +119510,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -118387,13 +119584,13 @@ "description": "Unique identity of user configuration." }, "userId": { + "description": "Unique identity of user.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user." + "pattern": "^[0-9a-f]{32}$" }, "key": { - "type": "string", - "description": "Unique key for every userconfig." + "description": "Unique key for every userconfig.", + "type": "string" }, "value": { "type": "object", @@ -118433,9 +119630,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -118502,13 +119701,13 @@ "description": "Unique identity of user recovery." }, "hash": { - "type": "string", - "description": "Password hash for user recovery." + "description": "Password hash for user recovery.", + "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Unique identity of user." + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -118697,26 +119896,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -118726,13 +119932,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -118772,34 +119981,34 @@ "description": "Unique identity of webhook event log." }, "appName": { - "type": "string", - "description": "Unique name of app." + "description": "Unique name of app.", + "type": "string" }, "webhookName": { - "type": "string", - "description": "Unique name of webhook." + "description": "Unique name of webhook.", + "type": "string" }, "eventName": { - "type": "string", - "description": "Unique name of event." + "description": "Unique name of event.", + "type": "string" }, "deliveryStatus": { - "type": "string", - "description": "Parameter that records \"success or failed\" status of the event." + "description": "Parameter that records \"success or failed\" status of the event.", + "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", - "format": "int64", - "description": "Time at which the event occurred." + "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", - "format": "int64", - "description": "Time the event took to process." + "format": "int64" }, "appVersion": { - "type": "string", - "description": "Version of teh app." + "description": "Version of teh app.", + "type": "string" }, "requestContent": { "type": "object", @@ -118810,17 +120019,17 @@ "description": "Represents the content sent as part of the Response." }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", - "format": "int64", - "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses." + "format": "int64" }, "responseReasonPhrase": { - "type": "string", - "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event." + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", + "type": "string" }, "url": { - "type": "string", - "description": "A URL for the webhook event log." + "description": "A URL for the webhook event log.", + "type": "string" }, "onlyLiveVersion": { "type": "boolean" @@ -118842,56 +120051,213 @@ }, "type": "object" }, - "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" - } - } - } - }, + "infoConfigResponse": { + "type": "object", "properties": { - "name": { - "description": "Unique name of the businessEventsResponse." + "version": { + "type": "string", + "description": "Shopware version." }, - "class": { - "description": "Class name of business event." + "shopId": { + "type": "string", + "description": "Unique shop identifier." }, - "data": { - "description": "Internal field." + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." }, - "aware": { - "description": "Parameter that indicates the areas in which the business event is supported." + "adminWorker": { + "type": "object", + "description": "Admin worker feature flags and transport configuration.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." + }, + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", + "deprecated": true + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." + }, + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false }, - "extensions": { - "description": "Internal field." + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { + "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." + }, + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." + }, + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + } + }, + "additionalProperties": false + }, + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true + } } - } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false }, "Price": { "type": "object", @@ -118975,32 +120341,6 @@ "linked" ] }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", @@ -119125,46 +120465,28 @@ } ] }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "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" } } } @@ -119219,29 +120541,21 @@ "type": "object", "properties": { "field": { - "type": "string" + "type": "string", + "description": "Sort the search results by field like an property identifier." }, "order": { - "type": "string" + "type": "string", + "description": "Sort the search results of orders by ascending or descending." }, "naturalSorting": { - "type": "boolean" + "type": "boolean", + "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." } }, "required": [ "field" ] - }, - "properties": { - "field": { - "description": "Sort the search results by field like an property identifier." - }, - "order": { - "description": "Sort the search results of orders by ascending or descending." - }, - "naturalSorting": { - "description": "Sorting for special cases such as German letters with umlauts and similar characters etc." - } } }, "post-filter": { @@ -119262,17 +120576,6 @@ "$ref": "#/components/schemas/RangeFilter" } ] - }, - "properties": { - "type": { - "description": "To filter only the results but not the aggregations with filter types like ==, >=, etc." - }, - "field": { - "description": "To filter only the results but not the aggregations by field like an property identifier." - }, - "value": { - "description": "To filter only the results but not the aggregations by value." - } } }, "associations": { @@ -119908,212 +121211,132 @@ "field" ] }, - "infoConfigResponse": { + "MeasurementUnits": { "type": "object", + "description": "Configuration of the measurement system", "properties": { - "version": { - "type": "string", - "description": "Shopware version." - }, - "shopId": { - "type": "string", - "description": "Unique shop identifier." - }, - "versionRevision": { + "system": { "type": "string", - "description": "Shopware version revision (build hash/revision)." + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "adminWorker": { + "units": { "type": "object", - "description": "Admin worker feature flags and transport configuration.", + "description": "Units used in the measurement system.", "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "Whether the admin background worker is enabled." - }, - "enableQueueStatsWorker": { - "type": "boolean", - "description": "Whether the queue statistics worker is enabled." - }, - "enableNotificationWorker": { - "type": "boolean", - "description": "Whether the notification worker is enabled." + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." }, - "transports": { - "type": "array", - "description": "Configured Symfony Messenger transports used by the admin workers.", - "items": { - "type": "string" - } + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - }, - "additionalProperties": false - }, - "bundles": { - "type": "object", - "description": "Active extension assets (plugins & apps) keyed by technical name.", - "additionalProperties": { - "oneOf": [ - { - "type": "object", - "description": "Plugin bundle asset descriptor.", - "properties": { - "type": { - "type": "string", - "enum": [ - "plugin" - ] - }, - "css": { - "type": "array", - "items": { - "type": "string", - "description": "URL to a CSS asset." - } - }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "URL to a JS asset." - } - }, - "baseUrl": { - "type": [ - "string", - "null" - ], - "description": "Base URL to a (micro frontend) admin entry point, if provided." - } - }, - "required": [ - "type" - ], - "additionalProperties": false - }, - { - "type": "object", - "description": "App bundle descriptor.", - "properties": { - "type": { - "type": "string", - "enum": [ - "app" - ] - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "integrationId": { - "type": "string", - "description": "Lowercase hex integration id." - }, - "baseUrl": { - "type": "string" - }, - "version": { - "type": "string" - }, - "permissions": { - "type": "object", - "description": "Grouped privileges: key = privilege scope, value = list of entities.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "css": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional CSS assets if provided." - }, - "js": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Optional JS assets if provided." - } - }, - "required": [ - "type", - "name", - "active", - "integrationId", - "baseUrl", - "version", - "permissions" - ], - "additionalProperties": false - } - ] } - }, - "settings": { - "type": "object", - "description": "Selected environment and feature settings consumed by the administration.", - "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the URL upload feature." - }, - "appUrlReachable": { - "type": "boolean", - "description": "Whether configured APP_URL is externally reachable." - }, - "appsRequireAppUrl": { - "type": "boolean", - "description": "True if at least one installed app requires a reachable APP_URL." - }, - "private_allowed_extensions": { - "type": "array", - "description": "Whitelisted file extensions for private filesystem uploads.", - "items": { - "type": "string" - } - }, - "enableHtmlSanitizer": { - "type": "boolean", - "description": "Whether HTML sanitizer is enabled." - }, - "enableStagingMode": { - "type": "boolean", - "description": "Whether staging mode banner is enabled." - }, - "disableExtensionManagement": { - "type": "boolean", - "description": "True if runtime extension management is disabled." - } + } + } + }, + "businessEventsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Unique name of the businessEventsResponse." }, - "additionalProperties": false - }, - "inAppPurchases": { - "type": "array", - "description": "In-app purchase meta data (structure may vary).", - "items": { + "class": { + "type": "string", + "description": "Class name of business event." + }, + "data": { "type": "object", - "description": "Purchase entry.", - "additionalProperties": true + "description": "Internal field." + }, + "aware": { + "type": "array", + "description": "Parameter that indicates the areas in which the business event is supported.", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "description": "Internal field.", + "items": { + "type": "string" + } } } - }, + } + }, + "ConsentState": { + "type": "object", "required": [ - "version", - "shopId", - "versionRevision", - "adminWorker", - "bundles", - "settings", - "inAppPurchases" + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt" ], - "additionalProperties": false + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + } + } }, "Cart": { "properties": { @@ -120134,9 +121357,11 @@ } }, "transactions": { - "properties": { - "paymentMethodId": { - "description": "Unique identity of payment method." + "items": { + "properties": { + "paymentMethodId": { + "description": "Unique identity of payment method." + } } } }, diff --git a/adminapi.summary.json b/adminapi.summary.json index dee72c7..c92927b 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -1,5 +1,6 @@ { "paths": [ + "/_action/app-system/secret/rotate", "/_action/cache", "/_action/cache-delayed", "/_action/cache_info", @@ -35,6 +36,8 @@ "/_action/scheduled-task/min-run-interval", "/_action/scheduled-task/run", "/_action/sso/invite-user", + "/_action/state-machine/{entityName}/{entityId}/state", + "/_action/state-machine/{entityName}/{entityId}/state/{transition}", "/_action/sync", "/_action/theme/{themeId}", "/_action/theme/{themeId}/assign/{salesChannelId}", @@ -48,6 +51,7 @@ "/_info/is-sso", "/_info/message-stats.json", "/_info/openapi3.json", + "/_info/queue.json", "/_info/routes", "/_info/system-health-check", "/_info/version", @@ -224,6 +228,9 @@ "/cms-section/{id}", "/cms-slot", "/cms-slot/{id}", + "/consents", + "/consents/accept", + "/consents/revoke", "/country", "/country-state", "/country-state/{id}", @@ -656,6 +663,7 @@ "CmsSectionJsonApi", "CmsSlot", "CmsSlotJsonApi", + "ConsentState", "Country", "CountryJsonApi", "CountryState", From 6edc2035e1a42502f037efa2cd167918950d6010 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Mar 2026 12:00:20 +0200 Subject: [PATCH 54/63] [create-pull-request] automated change (#466) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 71688 +++++++++++++++++-------- SwagCommercial-adminapi.summary.json | 25 +- 2 files changed, 48876 insertions(+), 22837 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 44ffa0c..65da824 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.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`.", @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.7.0" + "version": "6.7.8.2" }, "servers": [ { @@ -150,23 +150,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchAction" @@ -227,14 +210,24 @@ "summary": "Search for the Advanced Search Action resources.", "description": "", "operationId": "searchAdvancedSearchAction", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -428,23 +421,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Action resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchAction" @@ -500,6 +476,86 @@ } } }, + "/aggregate/advanced-search-action": { + "post": { + "tags": [ + "Advanced Search Action" + ], + "summary": "Aggregate for the Advanced Search Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchAction", + "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 AdvancedSearchAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-action-search-term": { "get": { "tags": [ @@ -635,23 +691,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" @@ -712,14 +751,24 @@ "summary": "Search for the Advanced Search Action Search Term resources.", "description": "", "operationId": "searchAdvancedSearchActionSearchTerm", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -913,23 +962,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Action Search Term resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" @@ -985,6 +1017,86 @@ } } }, + "/aggregate/advanced-search-action-search-term": { + "post": { + "tags": [ + "Advanced Search Action Search Term" + ], + "summary": "Aggregate for the Advanced Search Action Search Term resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchActionSearchTerm", + "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 AdvancedSearchActionSearchTerm", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-boosting": { "get": { "tags": [ @@ -1120,23 +1232,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchBoosting" @@ -1197,14 +1292,24 @@ "summary": "Search for the Advanced Search Boosting resources.", "description": "", "operationId": "searchAdvancedSearchBoosting", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1398,23 +1503,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Boosting resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchBoosting" @@ -1470,6 +1558,86 @@ } } }, + "/aggregate/advanced-search-boosting": { + "post": { + "tags": [ + "Advanced Search Boosting" + ], + "summary": "Aggregate for the Advanced Search Boosting resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchBoosting", + "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 AdvancedSearchBoosting", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-config": { "get": { "tags": [ @@ -1605,23 +1773,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfig" @@ -1682,14 +1833,24 @@ "summary": "Search for the Advanced Search Config resources.", "description": "", "operationId": "searchAdvancedSearchConfig", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -1883,23 +2044,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Config resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchConfig" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfig" @@ -1955,6 +2099,86 @@ } } }, + "/aggregate/advanced-search-config": { + "post": { + "tags": [ + "Advanced Search Config" + ], + "summary": "Aggregate for the Advanced Search Config resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchConfig", + "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 AdvancedSearchConfig", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-config-field": { "get": { "tags": [ @@ -2090,23 +2314,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfigField" @@ -2167,14 +2374,24 @@ "summary": "Search for the Advanced Search Config Field resources.", "description": "", "operationId": "searchAdvancedSearchConfigField", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2368,23 +2585,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Config Field resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchConfigField" @@ -2440,6 +2640,86 @@ } } }, + "/aggregate/advanced-search-config-field": { + "post": { + "tags": [ + "Advanced Search Config Field" + ], + "summary": "Aggregate for the Advanced Search Config Field resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchConfigField", + "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 AdvancedSearchConfigField", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-entity-stream": { "get": { "tags": [ @@ -2575,23 +2855,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" @@ -2652,14 +2915,24 @@ "summary": "Search for the Advanced Search Entity Stream resources.", "description": "", "operationId": "searchAdvancedSearchEntityStream", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -2853,23 +3126,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Entity Stream resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStream" @@ -2925,6 +3181,86 @@ } } }, + "/aggregate/advanced-search-entity-stream": { + "post": { + "tags": [ + "Advanced Search Entity Stream" + ], + "summary": "Aggregate for the Advanced Search Entity Stream resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchEntityStream", + "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 AdvancedSearchEntityStream", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-entity-stream-filter": { "get": { "tags": [ @@ -3060,23 +3396,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" @@ -3137,14 +3456,24 @@ "summary": "Search for the Advanced Search Entity Stream Filter resources.", "description": "", "operationId": "searchAdvancedSearchEntityStreamFilter", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3338,23 +3667,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Entity Stream Filter resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" @@ -3410,6 +3722,86 @@ } } }, + "/aggregate/advanced-search-entity-stream-filter": { + "post": { + "tags": [ + "Advanced Search Entity Stream Filter" + ], + "summary": "Aggregate for the Advanced Search Entity Stream Filter resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchEntityStreamFilter", + "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 AdvancedSearchEntityStreamFilter", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/advanced-search-synonym": { "get": { "tags": [ @@ -3545,23 +3937,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchSynonym" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchSynonym" @@ -3622,14 +3997,24 @@ "summary": "Search for the Advanced Search Synonym resources.", "description": "", "operationId": "searchAdvancedSearchSynonym", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -3823,23 +4208,6 @@ "requestBody": { "description": "Partially update information about a Advanced Search Synonym resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/AdvancedSearchSynonym" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/AdvancedSearchSynonym" @@ -3895,6 +4263,86 @@ } } }, + "/aggregate/advanced-search-synonym": { + "post": { + "tags": [ + "Advanced Search Synonym" + ], + "summary": "Aggregate for the Advanced Search Synonym resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateAdvancedSearchSynonym", + "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 AdvancedSearchSynonym", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchSynonym" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, "/b2b-business-partner": { "get": { "tags": [ @@ -4030,23 +4478,6 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/B2bBusinessPartner" @@ -4107,14 +4538,24 @@ "summary": "Search for the B2b Business Partner resources.", "description": "", "operationId": "searchB2bBusinessPartner", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4308,23 +4749,6 @@ "requestBody": { "description": "Partially update information about a B2b Business Partner resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bBusinessPartner" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/B2bBusinessPartner" @@ -4380,14 +4804,94 @@ } } }, - "/b2b-components-approval-rule": { + "/aggregate/b2b-business-partner": { + "post": { + "tags": [ + "B2b Business Partner" + ], + "summary": "Aggregate for the B2b Business Partner resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bBusinessPartner", + "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 B2bBusinessPartner", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bBusinessPartner" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-advanced-product-catalogs": { "get": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "List with basic information of B2b Components Approval Rule resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsApprovalRuleList", + "summary": "List with basic information of B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "getB2bComponentsAdvancedProductCatalogsList", "parameters": [ { "name": "limit", @@ -4416,7 +4920,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Approval Rule resources.", + "description": "List of B2b Components Advanced Product Catalogs resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4435,7 +4939,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } ] @@ -4449,16 +4953,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-approval-rule?limit=25" + "example": "/b2b-components-advanced-product-catalogs?limit=25" }, "last": { - "example": "/b2b-components-approval-rule?limit=25&page=11" + "example": "/b2b-components-advanced-product-catalogs?limit=25&page=11" }, "next": { - "example": "/b2b-components-approval-rule?limit=25&page=4" + "example": "/b2b-components-advanced-product-catalogs?limit=25&page=4" }, "prev": { - "example": "/b2b-components-approval-rule?limit=25&page=2" + "example": "/b2b-components-advanced-product-catalogs?limit=25&page=2" } } } @@ -4479,7 +4983,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4494,11 +4998,11 @@ }, "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Create a new B2b Components Approval Rule resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsApprovalRule", + "summary": "Create a new B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "createB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "_response", @@ -4515,33 +5019,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -4553,7 +5040,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4568,7 +5055,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4584,22 +5071,32 @@ } } }, - "/search/b2b-components-approval-rule": { + "/search/b2b-components-advanced-product-catalogs": { "post": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" + ], + "summary": "Search for the B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "searchB2bComponentsAdvancedProductCatalogs", + "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" + } + } ], - "summary": "Search for the B2b Components Approval Rule resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsApprovalRule", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -4609,7 +5106,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRule", + "description": "List of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -4623,7 +5120,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4641,7 +5138,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4658,19 +5155,19 @@ } } }, - "/b2b-components-approval-rule/{id}": { + "/b2b-components-advanced-product-catalogs/{id}": { "get": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Detailed information about a B2b Components Approval Rule resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsApprovalRule", + "summary": "Detailed information about a B2b Components Advanced Product Catalogs resource.", + "description": "Available since: 6.7.1.0", + "operationId": "getB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", @@ -4680,7 +5177,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -4692,7 +5189,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4707,7 +5204,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4724,16 +5221,16 @@ }, "delete": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Delete a B2b Components Approval Rule resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsApprovalRule", + "summary": "Delete a B2b Components Advanced Product Catalogs resource.", + "description": "Available since: 6.7.1.0", + "operationId": "deleteB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", @@ -4764,16 +5261,16 @@ }, "patch": { "tags": [ - "B2b Components Approval Rule" + "B2b Components Advanced Product Catalogs" ], - "summary": "Partially update information about a B2b Components Approval Rule resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsApprovalRule", + "summary": "Partially update information about a B2b Components Advanced Product Catalogs resource.", + "description": "Available since: 6.7.1.0", + "operationId": "updateB2bComponentsAdvancedProductCatalogs", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule", + "description": "Identifier for the b2b_components_advanced_product_catalogs", "required": true, "schema": { "type": "string", @@ -4791,35 +5288,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Partially update information about a B2b Components Advanced Product Catalogs resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRule", + "description": "Detail of B2bComponentsAdvancedProductCatalogs", "content": { "application/vnd.api+json": { "schema": { @@ -4831,7 +5311,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4846,7 +5326,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" } } } @@ -4865,14 +5345,94 @@ } } }, - "/b2b-components-approval-rule-app-script-condition": { + "/aggregate/b2b-components-advanced-product-catalogs": { + "post": { + "tags": [ + "B2b Components Advanced Product Catalogs" + ], + "summary": "Aggregate for the B2b Components Advanced Product Catalogs resources.", + "description": "Available since: 6.7.1.0", + "operationId": "aggregateB2bComponentsAdvancedProductCatalogs", + "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 B2bComponentsAdvancedProductCatalogs", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-approval-rule": { "get": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", + "summary": "List with basic information of B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRuleList", "parameters": [ { "name": "limit", @@ -4901,7 +5461,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Approval Rule App Script Condition resources.", + "description": "List of B2b Components Approval Rule resources.", "content": { "application/vnd.api+json": { "schema": { @@ -4920,7 +5480,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } ] @@ -4934,16 +5494,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25" + "example": "/b2b-components-approval-rule?limit=25" }, "last": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" + "example": "/b2b-components-approval-rule?limit=25&page=11" }, "next": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" + "example": "/b2b-components-approval-rule?limit=25&page=4" }, "prev": { - "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" + "example": "/b2b-components-approval-rule?limit=25&page=2" } } } @@ -4964,7 +5524,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -4979,11 +5539,11 @@ }, "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Create a new B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsApprovalRule", "parameters": [ { "name": "_response", @@ -5000,33 +5560,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5038,7 +5581,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5053,7 +5596,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5069,22 +5612,32 @@ } } }, - "/search/b2b-components-approval-rule-app-script-condition": { + "/search/b2b-components-approval-rule": { "post": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" + ], + "summary": "Search for the B2b Components Approval Rule resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsApprovalRule", + "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" + } + } ], - "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", - "description": "Available since: 6.6.3.0", - "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -5094,7 +5647,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsApprovalRuleAppScriptCondition", + "description": "List of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5108,7 +5661,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5126,7 +5679,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5143,19 +5696,19 @@ } } }, - "/b2b-components-approval-rule-app-script-condition/{id}": { + "/b2b-components-approval-rule/{id}": { "get": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Detailed information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -5165,7 +5718,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5177,7 +5730,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5192,7 +5745,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5209,16 +5762,16 @@ }, "delete": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Delete a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -5249,16 +5802,16 @@ }, "patch": { "tags": [ - "B2b Components Approval Rule App Script Condition" + "B2b Components Approval Rule" ], - "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", - "description": "Available since: 6.6.3.0", - "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", + "summary": "Partially update information about a B2b Components Approval Rule resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsApprovalRule", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_approval_rule_app_script_condition", + "description": "Identifier for the b2b_components_approval_rule", "required": true, "schema": { "type": "string", @@ -5276,35 +5829,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Partially update information about a B2b Components Approval Rule resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", + "description": "Detail of B2bComponentsApprovalRule", "content": { "application/vnd.api+json": { "schema": { @@ -5316,7 +5852,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5331,7 +5867,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + "$ref": "#/components/schemas/B2bComponentsApprovalRule" } } } @@ -5350,14 +5886,94 @@ } } }, - "/b2b-components-pending-order": { + "/aggregate/b2b-components-approval-rule": { + "post": { + "tags": [ + "B2b Components Approval Rule" + ], + "summary": "Aggregate for the B2b Components Approval Rule resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsApprovalRule", + "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 B2bComponentsApprovalRule", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-approval-rule-app-script-condition": { "get": { "tags": [ - "B2b Components Pending Order" + "B2b Components Approval Rule App Script Condition" ], - "summary": "List with basic information of B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderList", + "summary": "List with basic information of B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptConditionList", "parameters": [ { "name": "limit", @@ -5386,7 +6002,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Pending Order resources.", + "description": "List of B2b Components Approval Rule App Script Condition resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5405,7 +6021,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } ] @@ -5419,16 +6035,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-pending-order?limit=25" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25" }, "last": { - "example": "/b2b-components-pending-order?limit=25&page=11" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=11" }, "next": { - "example": "/b2b-components-pending-order?limit=25&page=4" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=4" }, "prev": { - "example": "/b2b-components-pending-order?limit=25&page=2" + "example": "/b2b-components-approval-rule-app-script-condition?limit=25&page=2" } } } @@ -5449,7 +6065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5464,11 +6080,11 @@ }, "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Create a new B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsPendingOrder", + "summary": "Create a new B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "createB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "_response", @@ -5485,33 +6101,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5523,7 +6122,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5538,7 +6137,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5554,22 +6153,32 @@ } } }, - "/search/b2b-components-pending-order": { + "/search/b2b-components-approval-rule-app-script-condition": { "post": { "tags": [ - "B2b Components Pending Order" + "B2b Components Approval Rule App Script Condition" + ], + "summary": "Search for the B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.3.0", + "operationId": "searchB2bComponentsApprovalRuleAppScriptCondition", + "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" + } + } ], - "summary": "Search for the B2b Components Pending Order resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsPendingOrder", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -5579,7 +6188,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrder", + "description": "List of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5593,7 +6202,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5611,7 +6220,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5628,19 +6237,19 @@ } } }, - "/b2b-components-pending-order/{id}": { + "/b2b-components-approval-rule-app-script-condition/{id}": { "get": { "tags": [ - "B2b Components Pending Order" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Detailed information about a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrder", + "summary": "Detailed information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "getB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -5650,7 +6259,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5662,7 +6271,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5677,7 +6286,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5694,16 +6303,16 @@ }, "delete": { "tags": [ - "B2b Components Pending Order" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Delete a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsPendingOrder", + "summary": "Delete a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "deleteB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -5734,16 +6343,16 @@ }, "patch": { "tags": [ - "B2b Components Pending Order" + "B2b Components Approval Rule App Script Condition" ], - "summary": "Partially update information about a B2b Components Pending Order resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsPendingOrder", + "summary": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", + "description": "Available since: 6.6.3.0", + "operationId": "updateB2bComponentsApprovalRuleAppScriptCondition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order", + "description": "Identifier for the b2b_components_approval_rule_app_script_condition", "required": true, "schema": { "type": "string", @@ -5761,35 +6370,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Pending Order resource.", + "description": "Partially update information about a B2b Components Approval Rule App Script Condition resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrder", + "description": "Detail of B2bComponentsApprovalRuleAppScriptCondition", "content": { "application/vnd.api+json": { "schema": { @@ -5801,7 +6393,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5816,7 +6408,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" } } } @@ -5835,14 +6427,94 @@ } } }, - "/b2b-components-pending-order-address": { + "/aggregate/b2b-components-approval-rule-app-script-condition": { + "post": { + "tags": [ + "B2b Components Approval Rule App Script Condition" + ], + "summary": "Aggregate for the B2b Components Approval Rule App Script Condition resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsApprovalRuleAppScriptCondition", + "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 B2bComponentsApprovalRuleAppScriptCondition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsApprovalRuleAppScriptCondition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-budget": { "get": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Budget" ], - "summary": "List with basic information of B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderAddressList", + "summary": "List with basic information of B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "getB2bComponentsBudgetList", "parameters": [ { "name": "limit", @@ -5871,7 +6543,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Pending Order Address resources.", + "description": "List of B2b Components Budget resources.", "content": { "application/vnd.api+json": { "schema": { @@ -5890,7 +6562,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } ] @@ -5904,16 +6576,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-pending-order-address?limit=25" + "example": "/b2b-components-budget?limit=25" }, "last": { - "example": "/b2b-components-pending-order-address?limit=25&page=11" + "example": "/b2b-components-budget?limit=25&page=11" }, "next": { - "example": "/b2b-components-pending-order-address?limit=25&page=4" + "example": "/b2b-components-budget?limit=25&page=4" }, "prev": { - "example": "/b2b-components-pending-order-address?limit=25&page=2" + "example": "/b2b-components-budget?limit=25&page=2" } } } @@ -5934,7 +6606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -5949,11 +6621,11 @@ }, "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Budget" ], - "summary": "Create a new B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "createB2bComponentsPendingOrderAddress", + "summary": "Create a new B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "createB2bComponentsBudget", "parameters": [ { "name": "_response", @@ -5970,33 +6642,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6008,7 +6663,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6023,7 +6678,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6039,22 +6694,32 @@ } } }, - "/search/b2b-components-pending-order-address": { + "/search/b2b-components-budget": { "post": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Budget" + ], + "summary": "Search for the B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "searchB2bComponentsBudget", + "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" + } + } ], - "summary": "Search for the B2b Components Pending Order Address resources.", - "description": "Available since: 6.6.0.0", - "operationId": "searchB2bComponentsPendingOrderAddress", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -6064,7 +6729,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsPendingOrderAddress", + "description": "List of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6078,7 +6743,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6096,7 +6761,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6113,19 +6778,19 @@ } } }, - "/b2b-components-pending-order-address/{id}": { + "/b2b-components-budget/{id}": { "get": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Budget" ], - "summary": "Detailed information about a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "getB2bComponentsPendingOrderAddress", + "summary": "Detailed information about a B2b Components Budget resource.", + "description": "Available since: 6.7.4.0", + "operationId": "getB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", @@ -6135,7 +6800,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6147,7 +6812,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6162,7 +6827,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6179,16 +6844,16 @@ }, "delete": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Budget" ], - "summary": "Delete a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "deleteB2bComponentsPendingOrderAddress", + "summary": "Delete a B2b Components Budget resource.", + "description": "Available since: 6.7.4.0", + "operationId": "deleteB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", @@ -6219,16 +6884,16 @@ }, "patch": { "tags": [ - "B2b Components Pending Order Address" + "B2b Components Budget" ], - "summary": "Partially update information about a B2b Components Pending Order Address resource.", - "description": "Available since: 6.6.0.0", - "operationId": "updateB2bComponentsPendingOrderAddress", + "summary": "Partially update information about a B2b Components Budget resource.", + "description": "Available since: 6.7.4.0", + "operationId": "updateB2bComponentsBudget", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_pending_order_address", + "description": "Identifier for the b2b_components_budget", "required": true, "schema": { "type": "string", @@ -6246,35 +6911,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Pending Order Address resource.", + "description": "Partially update information about a B2b Components Budget resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsPendingOrderAddress", + "description": "Detail of B2bComponentsBudget", "content": { "application/vnd.api+json": { "schema": { @@ -6286,7 +6934,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6301,7 +6949,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + "$ref": "#/components/schemas/B2bComponentsBudget" } } } @@ -6320,14 +6968,94 @@ } } }, - "/b2b-components-role": { + "/aggregate/b2b-components-budget": { + "post": { + "tags": [ + "B2b Components Budget" + ], + "summary": "Aggregate for the B2b Components Budget resources.", + "description": "Available since: 6.7.4.0", + "operationId": "aggregateB2bComponentsBudget", + "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 B2bComponentsBudget", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsBudget" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsBudget" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-employee-wishlist": { "get": { "tags": [ - "B2b Components Role" + "B2b Components Employee Wishlist" ], - "summary": "List with basic information of B2b Components Role resources.", + "summary": "List with basic information of B2b Components Employee Wishlist resources.", "description": "", - "operationId": "getB2bComponentsRoleList", + "operationId": "getB2bComponentsEmployeeWishlistList", "parameters": [ { "name": "limit", @@ -6356,7 +7084,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Role resources.", + "description": "List of B2b Components Employee Wishlist resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6375,7 +7103,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } ] @@ -6389,16 +7117,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-role?limit=25" + "example": "/b2b-components-employee-wishlist?limit=25" }, "last": { - "example": "/b2b-components-role?limit=25&page=11" + "example": "/b2b-components-employee-wishlist?limit=25&page=11" }, "next": { - "example": "/b2b-components-role?limit=25&page=4" + "example": "/b2b-components-employee-wishlist?limit=25&page=4" }, "prev": { - "example": "/b2b-components-role?limit=25&page=2" + "example": "/b2b-components-employee-wishlist?limit=25&page=2" } } } @@ -6419,7 +7147,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6434,11 +7162,11 @@ }, "post": { "tags": [ - "B2b Components Role" + "B2b Components Employee Wishlist" ], - "summary": "Create a new B2b Components Role resources.", + "summary": "Create a new B2b Components Employee Wishlist resources.", "description": "", - "operationId": "createB2bComponentsRole", + "operationId": "createB2bComponentsEmployeeWishlist", "parameters": [ { "name": "_response", @@ -6455,33 +7183,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsRole" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -6493,7 +7204,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6508,7 +7219,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6524,22 +7235,32 @@ } } }, - "/search/b2b-components-role": { + "/search/b2b-components-employee-wishlist": { "post": { "tags": [ - "B2b Components Role" + "B2b Components Employee Wishlist" ], - "summary": "Search for the B2b Components Role resources.", + "summary": "Search for the B2b Components Employee Wishlist resources.", "description": "", - "operationId": "searchB2bComponentsRole", + "operationId": "searchB2bComponentsEmployeeWishlist", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -6549,7 +7270,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsRole", + "description": "List of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -6563,7 +7284,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6581,7 +7302,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6598,19 +7319,19 @@ } } }, - "/b2b-components-role/{id}": { + "/b2b-components-employee-wishlist/{id}": { "get": { "tags": [ - "B2b Components Role" + "B2b Components Employee Wishlist" ], - "summary": "Detailed information about a B2b Components Role resource.", + "summary": "Detailed information about a B2b Components Employee Wishlist resource.", "description": "", - "operationId": "getB2bComponentsRole", + "operationId": "getB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", @@ -6620,7 +7341,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -6632,7 +7353,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6647,7 +7368,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6664,16 +7385,16 @@ }, "delete": { "tags": [ - "B2b Components Role" + "B2b Components Employee Wishlist" ], - "summary": "Delete a B2b Components Role resource.", + "summary": "Delete a B2b Components Employee Wishlist resource.", "description": "", - "operationId": "deleteB2bComponentsRole", + "operationId": "deleteB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", @@ -6704,16 +7425,16 @@ }, "patch": { "tags": [ - "B2b Components Role" + "B2b Components Employee Wishlist" ], - "summary": "Partially update information about a B2b Components Role resource.", + "summary": "Partially update information about a B2b Components Employee Wishlist resource.", "description": "", - "operationId": "updateB2bComponentsRole", + "operationId": "updateB2bComponentsEmployeeWishlist", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_role", + "description": "Identifier for the b2b_components_employee_wishlist", "required": true, "schema": { "type": "string", @@ -6731,35 +7452,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Role resource.", + "description": "Partially update information about a B2b Components Employee Wishlist resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsRole" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsRole", + "description": "Detail of B2bComponentsEmployeeWishlist", "content": { "application/vnd.api+json": { "schema": { @@ -6771,7 +7475,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6786,7 +7490,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsRole" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" } } } @@ -6805,15 +7509,94 @@ } } }, - "/b2b-components-shopping-list": { + "/aggregate/b2b-components-employee-wishlist": { + "post": { + "tags": [ + "B2b Components Employee Wishlist" + ], + "summary": "Aggregate for the B2b Components Employee Wishlist resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsEmployeeWishlist", + "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 B2bComponentsEmployeeWishlist", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-employee-wishlist-product": { "get": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Components Employee Wishlist Product" ], - "summary": "List with basic information of B2b Components Shopping List 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.2.0", - "operationId": "getB2bComponentsShoppingListList", + "summary": "List with basic information of B2b Components Employee Wishlist Product resources.", + "description": "", + "operationId": "getB2bComponentsEmployeeWishlistProductList", "parameters": [ { "name": "limit", @@ -6842,7 +7625,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Shopping List resources.", + "description": "List of B2b Components Employee Wishlist Product resources.", "content": { "application/vnd.api+json": { "schema": { @@ -6861,7 +7644,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } ] @@ -6875,16 +7658,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-shopping-list?limit=25" + "example": "/b2b-components-employee-wishlist-product?limit=25" }, "last": { - "example": "/b2b-components-shopping-list?limit=25&page=11" + "example": "/b2b-components-employee-wishlist-product?limit=25&page=11" }, "next": { - "example": "/b2b-components-shopping-list?limit=25&page=4" + "example": "/b2b-components-employee-wishlist-product?limit=25&page=4" }, "prev": { - "example": "/b2b-components-shopping-list?limit=25&page=2" + "example": "/b2b-components-employee-wishlist-product?limit=25&page=2" } } } @@ -6905,7 +7688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -6920,12 +7703,11 @@ }, "post": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Components Employee Wishlist Product" ], - "summary": "Create a new B2b Components Shopping List 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.2.0", - "operationId": "createB2bComponentsShoppingList", + "summary": "Create a new B2b Components Employee Wishlist Product resources.", + "description": "", + "operationId": "createB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "_response", @@ -6942,33 +7724,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -6980,7 +7745,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -6995,7 +7760,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7011,23 +7776,32 @@ } } }, - "/search/b2b-components-shopping-list": { + "/search/b2b-components-employee-wishlist-product": { "post": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Components Employee Wishlist Product" + ], + "summary": "Search for the B2b Components Employee Wishlist Product resources.", + "description": "", + "operationId": "searchB2bComponentsEmployeeWishlistProduct", + "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" + } + } ], - "summary": "Search for the B2b Components Shopping List 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.2.0", - "operationId": "searchB2bComponentsShoppingList", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -7037,7 +7811,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingList", + "description": "List of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7051,7 +7825,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7069,7 +7843,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7086,20 +7860,19 @@ } } }, - "/b2b-components-shopping-list/{id}": { + "/b2b-components-employee-wishlist-product/{id}": { "get": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Components Employee Wishlist Product" ], - "summary": "Detailed information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingList", + "summary": "Detailed information about a B2b Components Employee Wishlist Product resource.", + "description": "", + "operationId": "getB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", @@ -7109,7 +7882,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7121,7 +7894,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7136,7 +7909,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7153,17 +7926,16 @@ }, "delete": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Components Employee Wishlist Product" ], - "summary": "Delete a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "deleteB2bComponentsShoppingList", + "summary": "Delete a B2b Components Employee Wishlist Product resource.", + "description": "", + "operationId": "deleteB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", @@ -7194,17 +7966,16 @@ }, "patch": { "tags": [ - "B2b Components Shopping List", - "Experimental" + "B2b Components Employee Wishlist Product" ], - "summary": "Partially update information about a B2b Components Shopping List resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "updateB2bComponentsShoppingList", + "summary": "Partially update information about a B2b Components Employee Wishlist Product resource.", + "description": "", + "operationId": "updateB2bComponentsEmployeeWishlistProduct", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list", + "description": "Identifier for the b2b_components_employee_wishlist_product", "required": true, "schema": { "type": "string", @@ -7222,35 +7993,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Shopping List resource.", + "description": "Partially update information about a B2b Components Employee Wishlist Product resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingList", + "description": "Detail of B2bComponentsEmployeeWishlistProduct", "content": { "application/vnd.api+json": { "schema": { @@ -7262,7 +8016,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7277,7 +8031,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" } } } @@ -7296,15 +8050,94 @@ } } }, - "/b2b-components-shopping-list-line-item": { + "/aggregate/b2b-components-employee-wishlist-product": { + "post": { + "tags": [ + "B2b Components Employee Wishlist Product" + ], + "summary": "Aggregate for the B2b Components Employee Wishlist Product resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsEmployeeWishlistProduct", + "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 B2bComponentsEmployeeWishlistProduct", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-individual-pricing": { "get": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Components Individual Pricing" ], - "summary": "List with basic information of B2b Components Shopping List Line Item 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.2.0", - "operationId": "getB2bComponentsShoppingListLineItemList", + "summary": "List with basic information of B2b Components Individual Pricing resources.", + "description": "Available since: 6.7.8.0", + "operationId": "getB2bComponentsIndividualPricingList", "parameters": [ { "name": "limit", @@ -7333,7 +8166,7 @@ ], "responses": { "200": { - "description": "List of B2b Components Shopping List Line Item resources.", + "description": "List of B2b Components Individual Pricing resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7352,7 +8185,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } ] @@ -7366,16 +8199,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-components-shopping-list-line-item?limit=25" + "example": "/b2b-components-individual-pricing?limit=25" }, "last": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" + "example": "/b2b-components-individual-pricing?limit=25&page=11" }, "next": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" + "example": "/b2b-components-individual-pricing?limit=25&page=4" }, "prev": { - "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" + "example": "/b2b-components-individual-pricing?limit=25&page=2" } } } @@ -7396,7 +8229,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7411,12 +8244,11 @@ }, "post": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Components Individual Pricing" ], - "summary": "Create a new B2b Components Shopping List Line Item 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.2.0", - "operationId": "createB2bComponentsShoppingListLineItem", + "summary": "Create a new B2b Components Individual Pricing resources.", + "description": "Available since: 6.7.8.0", + "operationId": "createB2bComponentsIndividualPricing", "parameters": [ { "name": "_response", @@ -7433,33 +8265,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bComponentsIndividualPricing", "content": { "application/vnd.api+json": { "schema": { @@ -7471,7 +8286,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7486,7 +8301,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7502,23 +8317,32 @@ } } }, - "/search/b2b-components-shopping-list-line-item": { + "/search/b2b-components-individual-pricing": { "post": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Components Individual Pricing" + ], + "summary": "Search for the B2b Components Individual Pricing resources.", + "description": "Available since: 6.7.8.0", + "operationId": "searchB2bComponentsIndividualPricing", + "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" + } + } ], - "summary": "Search for the B2b Components Shopping List Line Item 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.2.0", - "operationId": "searchB2bComponentsShoppingListLineItem", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -7528,7 +8352,7 @@ }, "responses": { "200": { - "description": "List of B2bComponentsShoppingListLineItem", + "description": "List of B2bComponentsIndividualPricing", "content": { "application/vnd.api+json": { "schema": { @@ -7542,7 +8366,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7560,7 +8384,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7577,20 +8401,19 @@ } } }, - "/b2b-components-shopping-list-line-item/{id}": { + "/b2b-components-individual-pricing/{id}": { "get": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Components Individual Pricing" ], - "summary": "Detailed information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "getB2bComponentsShoppingListLineItem", + "summary": "Detailed information about a B2b Components Individual Pricing resource.", + "description": "Available since: 6.7.8.0", + "operationId": "getB2bComponentsIndividualPricing", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_components_individual_pricing", "required": true, "schema": { "type": "string", @@ -7600,7 +8423,7 @@ ], "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bComponentsIndividualPricing", "content": { "application/vnd.api+json": { "schema": { @@ -7612,7 +8435,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7627,7 +8450,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7644,17 +8467,16 @@ }, "delete": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Components Individual Pricing" ], - "summary": "Delete a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "deleteB2bComponentsShoppingListLineItem", + "summary": "Delete a B2b Components Individual Pricing resource.", + "description": "Available since: 6.7.8.0", + "operationId": "deleteB2bComponentsIndividualPricing", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_components_individual_pricing", "required": true, "schema": { "type": "string", @@ -7685,17 +8507,16 @@ }, "patch": { "tags": [ - "B2b Components Shopping List Line Item", - "Experimental" + "B2b Components Individual Pricing" ], - "summary": "Partially update information about a B2b Components Shopping List Line Item resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "description": "Available since: 6.6.2.0", - "operationId": "updateB2bComponentsShoppingListLineItem", + "summary": "Partially update information about a B2b Components Individual Pricing resource.", + "description": "Available since: 6.7.8.0", + "operationId": "updateB2bComponentsIndividualPricing", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_components_shopping_list_line_item", + "description": "Identifier for the b2b_components_individual_pricing", "required": true, "schema": { "type": "string", @@ -7713,35 +8534,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Components Shopping List Line Item resource.", + "description": "Partially update information about a B2b Components Individual Pricing resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } }, "responses": { "200": { - "description": "Detail of B2bComponentsShoppingListLineItem", + "description": "Detail of B2bComponentsIndividualPricing", "content": { "application/vnd.api+json": { "schema": { @@ -7753,7 +8557,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7768,7 +8572,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" } } } @@ -7787,14 +8591,94 @@ } } }, - "/b2b-employee": { + "/aggregate/b2b-components-individual-pricing": { + "post": { + "tags": [ + "B2b Components Individual Pricing" + ], + "summary": "Aggregate for the B2b Components Individual Pricing resources.", + "description": "Available since: 6.7.8.0", + "operationId": "aggregateB2bComponentsIndividualPricing", + "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 B2bComponentsIndividualPricing", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-individual-pricing-company-assignment": { "get": { "tags": [ - "B2b Employee" + "B2b Components Individual Pricing Company Assignment" ], - "summary": "List with basic information of B2b Employee resources.", - "description": "", - "operationId": "getB2bEmployeeList", + "summary": "List with basic information of B2b Components Individual Pricing Company Assignment resources.", + "description": "Available since: 6.7.8.0", + "operationId": "getB2bComponentsIndividualPricingCompanyAssignmentList", "parameters": [ { "name": "limit", @@ -7823,7 +8707,7 @@ ], "responses": { "200": { - "description": "List of B2b Employee resources.", + "description": "List of B2b Components Individual Pricing Company Assignment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -7842,7 +8726,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } ] @@ -7856,16 +8740,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-employee?limit=25" + "example": "/b2b-components-individual-pricing-company-assignment?limit=25" }, "last": { - "example": "/b2b-employee?limit=25&page=11" + "example": "/b2b-components-individual-pricing-company-assignment?limit=25&page=11" }, "next": { - "example": "/b2b-employee?limit=25&page=4" + "example": "/b2b-components-individual-pricing-company-assignment?limit=25&page=4" }, "prev": { - "example": "/b2b-employee?limit=25&page=2" + "example": "/b2b-components-individual-pricing-company-assignment?limit=25&page=2" } } } @@ -7886,7 +8770,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -7901,11 +8785,11 @@ }, "post": { "tags": [ - "B2b Employee" + "B2b Components Individual Pricing Company Assignment" ], - "summary": "Create a new B2b Employee resources.", - "description": "", - "operationId": "createB2bEmployee", + "summary": "Create a new B2b Components Individual Pricing Company Assignment resources.", + "description": "Available since: 6.7.8.0", + "operationId": "createB2bComponentsIndividualPricingCompanyAssignment", "parameters": [ { "name": "_response", @@ -7922,33 +8806,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bComponentsIndividualPricingCompanyAssignment", "content": { "application/vnd.api+json": { "schema": { @@ -7960,7 +8827,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -7975,7 +8842,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -7991,22 +8858,32 @@ } } }, - "/search/b2b-employee": { + "/search/b2b-components-individual-pricing-company-assignment": { "post": { "tags": [ - "B2b Employee" + "B2b Components Individual Pricing Company Assignment" + ], + "summary": "Search for the B2b Components Individual Pricing Company Assignment resources.", + "description": "Available since: 6.7.8.0", + "operationId": "searchB2bComponentsIndividualPricingCompanyAssignment", + "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" + } + } ], - "summary": "Search for the B2b Employee resources.", - "description": "", - "operationId": "searchB2bEmployee", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -8016,7 +8893,7 @@ }, "responses": { "200": { - "description": "List of B2bEmployee", + "description": "List of B2bComponentsIndividualPricingCompanyAssignment", "content": { "application/vnd.api+json": { "schema": { @@ -8030,7 +8907,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -8048,7 +8925,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -8065,19 +8942,19 @@ } } }, - "/b2b-employee/{id}": { + "/b2b-components-individual-pricing-company-assignment/{id}": { "get": { "tags": [ - "B2b Employee" + "B2b Components Individual Pricing Company Assignment" ], - "summary": "Detailed information about a B2b Employee resource.", - "description": "", - "operationId": "getB2bEmployee", + "summary": "Detailed information about a B2b Components Individual Pricing Company Assignment resource.", + "description": "Available since: 6.7.8.0", + "operationId": "getB2bComponentsIndividualPricingCompanyAssignment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_components_individual_pricing_company_assignment", "required": true, "schema": { "type": "string", @@ -8087,7 +8964,7 @@ ], "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bComponentsIndividualPricingCompanyAssignment", "content": { "application/vnd.api+json": { "schema": { @@ -8099,7 +8976,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -8114,7 +8991,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -8131,16 +9008,16 @@ }, "delete": { "tags": [ - "B2b Employee" + "B2b Components Individual Pricing Company Assignment" ], - "summary": "Delete a B2b Employee resource.", - "description": "", - "operationId": "deleteB2bEmployee", + "summary": "Delete a B2b Components Individual Pricing Company Assignment resource.", + "description": "Available since: 6.7.8.0", + "operationId": "deleteB2bComponentsIndividualPricingCompanyAssignment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_components_individual_pricing_company_assignment", "required": true, "schema": { "type": "string", @@ -8171,16 +9048,16 @@ }, "patch": { "tags": [ - "B2b Employee" + "B2b Components Individual Pricing Company Assignment" ], - "summary": "Partially update information about a B2b Employee resource.", - "description": "", - "operationId": "updateB2bEmployee", + "summary": "Partially update information about a B2b Components Individual Pricing Company Assignment resource.", + "description": "Available since: 6.7.8.0", + "operationId": "updateB2bComponentsIndividualPricingCompanyAssignment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_employee", + "description": "Identifier for the b2b_components_individual_pricing_company_assignment", "required": true, "schema": { "type": "string", @@ -8198,35 +9075,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Employee resource.", + "description": "Partially update information about a B2b Components Individual Pricing Company Assignment resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } }, "responses": { "200": { - "description": "Detail of B2bEmployee", + "description": "Detail of B2bComponentsIndividualPricingCompanyAssignment", "content": { "application/vnd.api+json": { "schema": { @@ -8238,7 +9098,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -8253,7 +9113,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" } } } @@ -8272,14 +9132,94 @@ } } }, - "/b2b-order-employee": { + "/aggregate/b2b-components-individual-pricing-company-assignment": { + "post": { + "tags": [ + "B2b Components Individual Pricing Company Assignment" + ], + "summary": "Aggregate for the B2b Components Individual Pricing Company Assignment resources.", + "description": "Available since: 6.7.8.0", + "operationId": "aggregateB2bComponentsIndividualPricingCompanyAssignment", + "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 B2bComponentsIndividualPricingCompanyAssignment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-individual-pricing-computed-cache": { "get": { "tags": [ - "B2b Order Employee" + "B2b Components Individual Pricing Computed Cache" ], - "summary": "List with basic information of B2b Order Employee resources.", + "summary": "List with basic information of B2b Components Individual Pricing Computed Cache resources.", "description": "", - "operationId": "getB2bOrderEmployeeList", + "operationId": "getB2bComponentsIndividualPricingComputedCacheList", "parameters": [ { "name": "limit", @@ -8308,7 +9248,7 @@ ], "responses": { "200": { - "description": "List of B2b Order Employee resources.", + "description": "List of B2b Components Individual Pricing Computed Cache resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8327,7 +9267,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } ] @@ -8341,16 +9281,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-order-employee?limit=25" + "example": "/b2b-components-individual-pricing-computed-cache?limit=25" }, "last": { - "example": "/b2b-order-employee?limit=25&page=11" + "example": "/b2b-components-individual-pricing-computed-cache?limit=25&page=11" }, "next": { - "example": "/b2b-order-employee?limit=25&page=4" + "example": "/b2b-components-individual-pricing-computed-cache?limit=25&page=4" }, "prev": { - "example": "/b2b-order-employee?limit=25&page=2" + "example": "/b2b-components-individual-pricing-computed-cache?limit=25&page=2" } } } @@ -8371,7 +9311,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8386,11 +9326,11 @@ }, "post": { "tags": [ - "B2b Order Employee" + "B2b Components Individual Pricing Computed Cache" ], - "summary": "Create a new B2b Order Employee resources.", + "summary": "Create a new B2b Components Individual Pricing Computed Cache resources.", "description": "", - "operationId": "createB2bOrderEmployee", + "operationId": "createB2bComponentsIndividualPricingComputedCache", "parameters": [ { "name": "_response", @@ -8407,33 +9347,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsIndividualPricingComputedCache", "content": { "application/vnd.api+json": { "schema": { @@ -8445,7 +9368,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8460,7 +9383,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8476,22 +9399,32 @@ } } }, - "/search/b2b-order-employee": { + "/search/b2b-components-individual-pricing-computed-cache": { "post": { "tags": [ - "B2b Order Employee" + "B2b Components Individual Pricing Computed Cache" ], - "summary": "Search for the B2b Order Employee resources.", + "summary": "Search for the B2b Components Individual Pricing Computed Cache resources.", "description": "", - "operationId": "searchB2bOrderEmployee", + "operationId": "searchB2bComponentsIndividualPricingComputedCache", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -8501,7 +9434,7 @@ }, "responses": { "200": { - "description": "List of B2bOrderEmployee", + "description": "List of B2bComponentsIndividualPricingComputedCache", "content": { "application/vnd.api+json": { "schema": { @@ -8515,7 +9448,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8533,7 +9466,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8550,19 +9483,19 @@ } } }, - "/b2b-order-employee/{id}": { + "/b2b-components-individual-pricing-computed-cache/{id}": { "get": { "tags": [ - "B2b Order Employee" + "B2b Components Individual Pricing Computed Cache" ], - "summary": "Detailed information about a B2b Order Employee resource.", + "summary": "Detailed information about a B2b Components Individual Pricing Computed Cache resource.", "description": "", - "operationId": "getB2bOrderEmployee", + "operationId": "getB2bComponentsIndividualPricingComputedCache", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_individual_pricing_computed_cache", "required": true, "schema": { "type": "string", @@ -8572,7 +9505,7 @@ ], "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsIndividualPricingComputedCache", "content": { "application/vnd.api+json": { "schema": { @@ -8584,7 +9517,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8599,7 +9532,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8616,16 +9549,16 @@ }, "delete": { "tags": [ - "B2b Order Employee" + "B2b Components Individual Pricing Computed Cache" ], - "summary": "Delete a B2b Order Employee resource.", + "summary": "Delete a B2b Components Individual Pricing Computed Cache resource.", "description": "", - "operationId": "deleteB2bOrderEmployee", + "operationId": "deleteB2bComponentsIndividualPricingComputedCache", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_individual_pricing_computed_cache", "required": true, "schema": { "type": "string", @@ -8656,16 +9589,16 @@ }, "patch": { "tags": [ - "B2b Order Employee" + "B2b Components Individual Pricing Computed Cache" ], - "summary": "Partially update information about a B2b Order Employee resource.", + "summary": "Partially update information about a B2b Components Individual Pricing Computed Cache resource.", "description": "", - "operationId": "updateB2bOrderEmployee", + "operationId": "updateB2bComponentsIndividualPricingComputedCache", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_order_employee", + "description": "Identifier for the b2b_components_individual_pricing_computed_cache", "required": true, "schema": { "type": "string", @@ -8683,35 +9616,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Order Employee resource.", + "description": "Partially update information about a B2b Components Individual Pricing Computed Cache resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } }, "responses": { "200": { - "description": "Detail of B2bOrderEmployee", + "description": "Detail of B2bComponentsIndividualPricingComputedCache", "content": { "application/vnd.api+json": { "schema": { @@ -8723,7 +9639,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8738,7 +9654,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bOrderEmployee" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" } } } @@ -8757,14 +9673,94 @@ } } }, - "/b2b-permission": { + "/aggregate/b2b-components-individual-pricing-computed-cache": { + "post": { + "tags": [ + "B2b Components Individual Pricing Computed Cache" + ], + "summary": "Aggregate for the B2b Components Individual Pricing Computed Cache resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsIndividualPricingComputedCache", + "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 B2bComponentsIndividualPricingComputedCache", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingComputedCache" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-individual-pricing-tier": { "get": { "tags": [ - "B2b Permission" + "B2b Components Individual Pricing Tier" ], - "summary": "List with basic information of B2b Permission resources.", - "description": "", - "operationId": "getB2bPermissionList", + "summary": "List with basic information of B2b Components Individual Pricing Tier resources.", + "description": "Available since: 6.7.8.0", + "operationId": "getB2bComponentsIndividualPricingTierList", "parameters": [ { "name": "limit", @@ -8793,7 +9789,7 @@ ], "responses": { "200": { - "description": "List of B2b Permission resources.", + "description": "List of B2b Components Individual Pricing Tier resources.", "content": { "application/vnd.api+json": { "schema": { @@ -8812,7 +9808,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } ] @@ -8826,16 +9822,16 @@ "type": "object", "properties": { "first": { - "example": "/b2b-permission?limit=25" + "example": "/b2b-components-individual-pricing-tier?limit=25" }, "last": { - "example": "/b2b-permission?limit=25&page=11" + "example": "/b2b-components-individual-pricing-tier?limit=25&page=11" }, "next": { - "example": "/b2b-permission?limit=25&page=4" + "example": "/b2b-components-individual-pricing-tier?limit=25&page=4" }, "prev": { - "example": "/b2b-permission?limit=25&page=2" + "example": "/b2b-components-individual-pricing-tier?limit=25&page=2" } } } @@ -8856,7 +9852,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -8871,11 +9867,11 @@ }, "post": { "tags": [ - "B2b Permission" + "B2b Components Individual Pricing Tier" ], - "summary": "Create a new B2b Permission resources.", - "description": "", - "operationId": "createB2bPermission", + "summary": "Create a new B2b Components Individual Pricing Tier resources.", + "description": "Available since: 6.7.8.0", + "operationId": "createB2bComponentsIndividualPricingTier", "parameters": [ { "name": "_response", @@ -8892,33 +9888,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bPermission" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsIndividualPricingTier", "content": { "application/vnd.api+json": { "schema": { @@ -8930,7 +9909,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -8945,7 +9924,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -8961,22 +9940,32 @@ } } }, - "/search/b2b-permission": { + "/search/b2b-components-individual-pricing-tier": { "post": { "tags": [ - "B2b Permission" + "B2b Components Individual Pricing Tier" + ], + "summary": "Search for the B2b Components Individual Pricing Tier resources.", + "description": "Available since: 6.7.8.0", + "operationId": "searchB2bComponentsIndividualPricingTier", + "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" + } + } ], - "summary": "Search for the B2b Permission resources.", - "description": "", - "operationId": "searchB2bPermission", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -8986,7 +9975,7 @@ }, "responses": { "200": { - "description": "List of B2bPermission", + "description": "List of B2bComponentsIndividualPricingTier", "content": { "application/vnd.api+json": { "schema": { @@ -9000,7 +9989,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -9018,7 +10007,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -9035,19 +10024,19 @@ } } }, - "/b2b-permission/{id}": { + "/b2b-components-individual-pricing-tier/{id}": { "get": { "tags": [ - "B2b Permission" + "B2b Components Individual Pricing Tier" ], - "summary": "Detailed information about a B2b Permission resource.", - "description": "", - "operationId": "getB2bPermission", + "summary": "Detailed information about a B2b Components Individual Pricing Tier resource.", + "description": "Available since: 6.7.8.0", + "operationId": "getB2bComponentsIndividualPricingTier", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_individual_pricing_tier", "required": true, "schema": { "type": "string", @@ -9057,7 +10046,7 @@ ], "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsIndividualPricingTier", "content": { "application/vnd.api+json": { "schema": { @@ -9069,7 +10058,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -9084,7 +10073,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -9101,16 +10090,16 @@ }, "delete": { "tags": [ - "B2b Permission" + "B2b Components Individual Pricing Tier" ], - "summary": "Delete a B2b Permission resource.", - "description": "", - "operationId": "deleteB2bPermission", + "summary": "Delete a B2b Components Individual Pricing Tier resource.", + "description": "Available since: 6.7.8.0", + "operationId": "deleteB2bComponentsIndividualPricingTier", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_individual_pricing_tier", "required": true, "schema": { "type": "string", @@ -9141,16 +10130,16 @@ }, "patch": { "tags": [ - "B2b Permission" + "B2b Components Individual Pricing Tier" ], - "summary": "Partially update information about a B2b Permission resource.", - "description": "", - "operationId": "updateB2bPermission", + "summary": "Partially update information about a B2b Components Individual Pricing Tier resource.", + "description": "Available since: 6.7.8.0", + "operationId": "updateB2bComponentsIndividualPricingTier", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the b2b_permission", + "description": "Identifier for the b2b_components_individual_pricing_tier", "required": true, "schema": { "type": "string", @@ -9168,35 +10157,18 @@ } ], "requestBody": { - "description": "Partially update information about a B2b Permission resource.", + "description": "Partially update information about a B2b Components Individual Pricing Tier resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/B2bPermission" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } }, "responses": { "200": { - "description": "Detail of B2bPermission", + "description": "Detail of B2bComponentsIndividualPricingTier", "content": { "application/vnd.api+json": { "schema": { @@ -9208,7 +10180,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -9223,7 +10195,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/B2bPermission" + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" } } } @@ -9242,14 +10214,94 @@ } } }, - "/custom-price": { + "/aggregate/b2b-components-individual-pricing-tier": { + "post": { + "tags": [ + "B2b Components Individual Pricing Tier" + ], + "summary": "Aggregate for the B2b Components Individual Pricing Tier resources.", + "description": "Available since: 6.7.8.0", + "operationId": "aggregateB2bComponentsIndividualPricingTier", + "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 B2bComponentsIndividualPricingTier", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-organization": { "get": { "tags": [ - "Custom Price" + "B2b Components Organization" ], - "summary": "List with basic information of Custom Price resources.", + "summary": "List with basic information of B2b Components Organization resources.", "description": "", - "operationId": "getCustomPriceList", + "operationId": "getB2bComponentsOrganizationList", "parameters": [ { "name": "limit", @@ -9278,7 +10330,7 @@ ], "responses": { "200": { - "description": "List of Custom Price resources.", + "description": "List of B2b Components Organization resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9297,7 +10349,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } ] @@ -9311,16 +10363,16 @@ "type": "object", "properties": { "first": { - "example": "/custom-price?limit=25" + "example": "/b2b-components-organization?limit=25" }, "last": { - "example": "/custom-price?limit=25&page=11" + "example": "/b2b-components-organization?limit=25&page=11" }, "next": { - "example": "/custom-price?limit=25&page=4" + "example": "/b2b-components-organization?limit=25&page=4" }, "prev": { - "example": "/custom-price?limit=25&page=2" + "example": "/b2b-components-organization?limit=25&page=2" } } } @@ -9341,7 +10393,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9356,11 +10408,11 @@ }, "post": { "tags": [ - "Custom Price" + "B2b Components Organization" ], - "summary": "Create a new Custom Price resources.", + "summary": "Create a new B2b Components Organization resources.", "description": "", - "operationId": "createCustomPrice", + "operationId": "createB2bComponentsOrganization", "parameters": [ { "name": "_response", @@ -9377,33 +10429,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -9415,7 +10450,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9430,7 +10465,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9446,22 +10481,32 @@ } } }, - "/search/custom-price": { + "/search/b2b-components-organization": { "post": { "tags": [ - "Custom Price" + "B2b Components Organization" ], - "summary": "Search for the Custom Price resources.", + "summary": "Search for the B2b Components Organization resources.", "description": "", - "operationId": "searchCustomPrice", + "operationId": "searchB2bComponentsOrganization", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -9471,7 +10516,7 @@ }, "responses": { "200": { - "description": "List of CustomPrice", + "description": "List of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -9485,7 +10530,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9503,7 +10548,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9520,19 +10565,19 @@ } } }, - "/custom-price/{id}": { + "/b2b-components-organization/{id}": { "get": { "tags": [ - "Custom Price" + "B2b Components Organization" ], - "summary": "Detailed information about a Custom Price resource.", + "summary": "Detailed information about a B2b Components Organization resource.", "description": "", - "operationId": "getCustomPrice", + "operationId": "getB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", @@ -9542,7 +10587,7 @@ ], "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -9554,7 +10599,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9569,7 +10614,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9586,16 +10631,16 @@ }, "delete": { "tags": [ - "Custom Price" + "B2b Components Organization" ], - "summary": "Delete a Custom Price resource.", + "summary": "Delete a B2b Components Organization resource.", "description": "", - "operationId": "deleteCustomPrice", + "operationId": "deleteB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", @@ -9626,16 +10671,16 @@ }, "patch": { "tags": [ - "Custom Price" + "B2b Components Organization" ], - "summary": "Partially update information about a Custom Price resource.", + "summary": "Partially update information about a B2b Components Organization resource.", "description": "", - "operationId": "updateCustomPrice", + "operationId": "updateB2bComponentsOrganization", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the custom_price", + "description": "Identifier for the b2b_components_organization", "required": true, "schema": { "type": "string", @@ -9653,35 +10698,18 @@ } ], "requestBody": { - "description": "Partially update information about a Custom Price resource.", + "description": "Partially update information about a B2b Components Organization resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomPrice" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } }, "responses": { "200": { - "description": "Detail of CustomPrice", + "description": "Detail of B2bComponentsOrganization", "content": { "application/vnd.api+json": { "schema": { @@ -9693,7 +10721,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9708,7 +10736,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomPrice" + "$ref": "#/components/schemas/B2bComponentsOrganization" } } } @@ -9727,14 +10755,94 @@ } } }, - "/customer-specific-features": { + "/aggregate/b2b-components-organization": { + "post": { + "tags": [ + "B2b Components Organization" + ], + "summary": "Aggregate for the B2b Components Organization resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsOrganization", + "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 B2bComponentsOrganization", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-organization-customer-address": { "get": { "tags": [ - "Customer Specific Features" + "B2b Components Organization Customer Address" ], - "summary": "List with basic information of Customer Specific Features resources.", + "summary": "List with basic information of B2b Components Organization Customer Address resources.", "description": "", - "operationId": "getCustomerSpecificFeaturesList", + "operationId": "getB2bComponentsOrganizationCustomerAddressList", "parameters": [ { "name": "limit", @@ -9763,7 +10871,7 @@ ], "responses": { "200": { - "description": "List of Customer Specific Features resources.", + "description": "List of B2b Components Organization Customer Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -9782,7 +10890,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } ] @@ -9796,16 +10904,16 @@ "type": "object", "properties": { "first": { - "example": "/customer-specific-features?limit=25" + "example": "/b2b-components-organization-customer-address?limit=25" }, "last": { - "example": "/customer-specific-features?limit=25&page=11" + "example": "/b2b-components-organization-customer-address?limit=25&page=11" }, "next": { - "example": "/customer-specific-features?limit=25&page=4" + "example": "/b2b-components-organization-customer-address?limit=25&page=4" }, "prev": { - "example": "/customer-specific-features?limit=25&page=2" + "example": "/b2b-components-organization-customer-address?limit=25&page=2" } } } @@ -9826,7 +10934,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -9841,11 +10949,11 @@ }, "post": { "tags": [ - "Customer Specific Features" + "B2b Components Organization Customer Address" ], - "summary": "Create a new Customer Specific Features resources.", + "summary": "Create a new B2b Components Organization Customer Address resources.", "description": "", - "operationId": "createCustomerSpecificFeatures", + "operationId": "createB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "_response", @@ -9862,33 +10970,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9900,7 +10991,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -9915,7 +11006,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -9931,22 +11022,32 @@ } } }, - "/search/customer-specific-features": { + "/search/b2b-components-organization-customer-address": { "post": { "tags": [ - "Customer Specific Features" + "B2b Components Organization Customer Address" ], - "summary": "Search for the Customer Specific Features resources.", + "summary": "Search for the B2b Components Organization Customer Address resources.", "description": "", - "operationId": "searchCustomerSpecificFeatures", + "operationId": "searchB2bComponentsOrganizationCustomerAddress", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -9956,7 +11057,7 @@ }, "responses": { "200": { - "description": "List of CustomerSpecificFeatures", + "description": "List of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -9970,7 +11071,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -9988,7 +11089,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -10005,19 +11106,19 @@ } } }, - "/customer-specific-features/{id}": { + "/b2b-components-organization-customer-address/{id}": { "get": { "tags": [ - "Customer Specific Features" + "B2b Components Organization Customer Address" ], - "summary": "Detailed information about a Customer Specific Features resource.", + "summary": "Detailed information about a B2b Components Organization Customer Address resource.", "description": "", - "operationId": "getCustomerSpecificFeatures", + "operationId": "getB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", @@ -10027,7 +11128,7 @@ ], "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -10039,7 +11140,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -10054,7 +11155,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -10071,16 +11172,16 @@ }, "delete": { "tags": [ - "Customer Specific Features" + "B2b Components Organization Customer Address" ], - "summary": "Delete a Customer Specific Features resource.", + "summary": "Delete a B2b Components Organization Customer Address resource.", "description": "", - "operationId": "deleteCustomerSpecificFeatures", + "operationId": "deleteB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", @@ -10111,16 +11212,16 @@ }, "patch": { "tags": [ - "Customer Specific Features" + "B2b Components Organization Customer Address" ], - "summary": "Partially update information about a Customer Specific Features resource.", + "summary": "Partially update information about a B2b Components Organization Customer Address resource.", "description": "", - "operationId": "updateCustomerSpecificFeatures", + "operationId": "updateB2bComponentsOrganizationCustomerAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the customer_specific_features", + "description": "Identifier for the b2b_components_organization_customer_address", "required": true, "schema": { "type": "string", @@ -10138,35 +11239,18 @@ } ], "requestBody": { - "description": "Partially update information about a Customer Specific Features resource.", + "description": "Partially update information about a B2b Components Organization Customer Address resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } }, "responses": { "200": { - "description": "Detail of CustomerSpecificFeatures", + "description": "Detail of B2bComponentsOrganizationCustomerAddress", "content": { "application/vnd.api+json": { "schema": { @@ -10178,7 +11262,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -10193,7 +11277,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/CustomerSpecificFeatures" + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" } } } @@ -10212,14 +11296,94 @@ } } }, - "/media-ai-tag": { + "/aggregate/b2b-components-organization-customer-address": { + "post": { + "tags": [ + "B2b Components Organization Customer Address" + ], + "summary": "Aggregate for the B2b Components Organization Customer Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsOrganizationCustomerAddress", + "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 B2bComponentsOrganizationCustomerAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-pending-order": { "get": { "tags": [ - "Media Ai Tag" + "B2b Components Pending Order" ], - "summary": "List with basic information of Media Ai Tag resources.", - "description": "", - "operationId": "getMediaAiTagList", + "summary": "List with basic information of B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderList", "parameters": [ { "name": "limit", @@ -10248,7 +11412,7 @@ ], "responses": { "200": { - "description": "List of Media Ai Tag resources.", + "description": "List of B2b Components Pending Order resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10267,7 +11431,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } ] @@ -10281,16 +11445,16 @@ "type": "object", "properties": { "first": { - "example": "/media-ai-tag?limit=25" + "example": "/b2b-components-pending-order?limit=25" }, "last": { - "example": "/media-ai-tag?limit=25&page=11" + "example": "/b2b-components-pending-order?limit=25&page=11" }, "next": { - "example": "/media-ai-tag?limit=25&page=4" + "example": "/b2b-components-pending-order?limit=25&page=4" }, "prev": { - "example": "/media-ai-tag?limit=25&page=2" + "example": "/b2b-components-pending-order?limit=25&page=2" } } } @@ -10311,7 +11475,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10326,11 +11490,11 @@ }, "post": { "tags": [ - "Media Ai Tag" + "B2b Components Pending Order" ], - "summary": "Create a new Media Ai Tag resources.", - "description": "", - "operationId": "createMediaAiTag", + "summary": "Create a new B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrder", "parameters": [ { "name": "_response", @@ -10347,33 +11511,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -10385,7 +11532,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10400,7 +11547,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10416,22 +11563,32 @@ } } }, - "/search/media-ai-tag": { + "/search/b2b-components-pending-order": { "post": { "tags": [ - "Media Ai Tag" + "B2b Components Pending Order" + ], + "summary": "Search for the B2b Components Pending Order resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrder", + "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" + } + } ], - "summary": "Search for the Media Ai Tag resources.", - "description": "", - "operationId": "searchMediaAiTag", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -10441,7 +11598,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -10455,7 +11612,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10473,7 +11630,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10490,19 +11647,19 @@ } } }, - "/media-ai-tag/{id}": { + "/b2b-components-pending-order/{id}": { "get": { "tags": [ - "Media Ai Tag" + "B2b Components Pending Order" ], - "summary": "Detailed information about a Media Ai Tag resource.", - "description": "", - "operationId": "getMediaAiTag", + "summary": "Detailed information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -10512,7 +11669,7 @@ ], "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -10524,7 +11681,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10539,7 +11696,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10556,16 +11713,16 @@ }, "delete": { "tags": [ - "Media Ai Tag" + "B2b Components Pending Order" ], - "summary": "Delete a Media Ai Tag resource.", - "description": "", - "operationId": "deleteMediaAiTag", + "summary": "Delete a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -10596,16 +11753,16 @@ }, "patch": { "tags": [ - "Media Ai Tag" + "B2b Components Pending Order" ], - "summary": "Partially update information about a Media Ai Tag resource.", - "description": "", - "operationId": "updateMediaAiTag", + "summary": "Partially update information about a B2b Components Pending Order resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the b2b_components_pending_order", "required": true, "schema": { "type": "string", @@ -10623,35 +11780,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Ai Tag resource.", + "description": "Partially update information about a B2b Components Pending Order resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/MediaAiTag" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of B2bComponentsPendingOrder", "content": { "application/vnd.api+json": { "schema": { @@ -10663,7 +11803,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10678,7 +11818,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } } @@ -10697,14 +11837,94 @@ } } }, - "/order-product-warehouse": { + "/aggregate/b2b-components-pending-order": { + "post": { + "tags": [ + "B2b Components Pending Order" + ], + "summary": "Aggregate for the B2b Components Pending Order resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsPendingOrder", + "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 B2bComponentsPendingOrder", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-pending-order-address": { "get": { "tags": [ - "Order Product Warehouse" + "B2b Components Pending Order Address" ], - "summary": "List with basic information of Order Product Warehouse resources.", - "description": "", - "operationId": "getOrderProductWarehouseList", + "summary": "List with basic information of B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderAddressList", "parameters": [ { "name": "limit", @@ -10733,7 +11953,7 @@ ], "responses": { "200": { - "description": "List of Order Product Warehouse resources.", + "description": "List of B2b Components Pending Order Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -10752,7 +11972,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } ] @@ -10766,16 +11986,16 @@ "type": "object", "properties": { "first": { - "example": "/order-product-warehouse?limit=25" + "example": "/b2b-components-pending-order-address?limit=25" }, "last": { - "example": "/order-product-warehouse?limit=25&page=11" + "example": "/b2b-components-pending-order-address?limit=25&page=11" }, "next": { - "example": "/order-product-warehouse?limit=25&page=4" + "example": "/b2b-components-pending-order-address?limit=25&page=4" }, "prev": { - "example": "/order-product-warehouse?limit=25&page=2" + "example": "/b2b-components-pending-order-address?limit=25&page=2" } } } @@ -10796,7 +12016,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -10811,11 +12031,11 @@ }, "post": { "tags": [ - "Order Product Warehouse" + "B2b Components Pending Order Address" ], - "summary": "Create a new Order Product Warehouse resources.", - "description": "", - "operationId": "createOrderProductWarehouse", + "summary": "Create a new B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "createB2bComponentsPendingOrderAddress", "parameters": [ { "name": "_response", @@ -10832,33 +12052,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -10870,7 +12073,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -10885,7 +12088,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -10901,22 +12104,32 @@ } } }, - "/search/order-product-warehouse": { + "/search/b2b-components-pending-order-address": { "post": { "tags": [ - "Order Product Warehouse" + "B2b Components Pending Order Address" + ], + "summary": "Search for the B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.0.0", + "operationId": "searchB2bComponentsPendingOrderAddress", + "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" + } + } ], - "summary": "Search for the Order Product Warehouse resources.", - "description": "", - "operationId": "searchOrderProductWarehouse", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -10926,7 +12139,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -10940,7 +12153,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -10958,7 +12171,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -10975,19 +12188,19 @@ } } }, - "/order-product-warehouse/{id}": { + "/b2b-components-pending-order-address/{id}": { "get": { "tags": [ - "Order Product Warehouse" + "B2b Components Pending Order Address" ], - "summary": "Detailed information about a Order Product Warehouse resource.", - "description": "", - "operationId": "getOrderProductWarehouse", + "summary": "Detailed information about a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "getB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -10997,7 +12210,7 @@ ], "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -11009,7 +12222,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -11024,7 +12237,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -11041,16 +12254,16 @@ }, "delete": { "tags": [ - "Order Product Warehouse" + "B2b Components Pending Order Address" ], - "summary": "Delete a Order Product Warehouse resource.", - "description": "", - "operationId": "deleteOrderProductWarehouse", + "summary": "Delete a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "deleteB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -11081,16 +12294,16 @@ }, "patch": { "tags": [ - "Order Product Warehouse" + "B2b Components Pending Order Address" ], - "summary": "Partially update information about a Order Product Warehouse resource.", - "description": "", - "operationId": "updateOrderProductWarehouse", + "summary": "Partially update information about a B2b Components Pending Order Address resource.", + "description": "Available since: 6.6.0.0", + "operationId": "updateB2bComponentsPendingOrderAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the b2b_components_pending_order_address", "required": true, "schema": { "type": "string", @@ -11108,35 +12321,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Product Warehouse resource.", + "description": "Partially update information about a B2b Components Pending Order Address resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of B2bComponentsPendingOrderAddress", "content": { "application/vnd.api+json": { "schema": { @@ -11148,7 +12344,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -11163,7 +12359,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" } } } @@ -11182,14 +12378,94 @@ } } }, - "/order-return": { + "/aggregate/b2b-components-pending-order-address": { + "post": { + "tags": [ + "B2b Components Pending Order Address" + ], + "summary": "Aggregate for the B2b Components Pending Order Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsPendingOrderAddress", + "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 B2bComponentsPendingOrderAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-role": { "get": { "tags": [ - "Order Return" + "B2b Components Role" ], - "summary": "List with basic information of Order Return resources.", + "summary": "List with basic information of B2b Components Role resources.", "description": "", - "operationId": "getOrderReturnList", + "operationId": "getB2bComponentsRoleList", "parameters": [ { "name": "limit", @@ -11218,7 +12494,7 @@ ], "responses": { "200": { - "description": "List of Order Return resources.", + "description": "List of B2b Components Role resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11237,7 +12513,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } ] @@ -11251,16 +12527,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return?limit=25" + "example": "/b2b-components-role?limit=25" }, "last": { - "example": "/order-return?limit=25&page=11" + "example": "/b2b-components-role?limit=25&page=11" }, "next": { - "example": "/order-return?limit=25&page=4" + "example": "/b2b-components-role?limit=25&page=4" }, "prev": { - "example": "/order-return?limit=25&page=2" + "example": "/b2b-components-role?limit=25&page=2" } } } @@ -11281,7 +12557,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11296,11 +12572,11 @@ }, "post": { "tags": [ - "Order Return" + "B2b Components Role" ], - "summary": "Create a new Order Return resources.", + "summary": "Create a new B2b Components Role resources.", "description": "", - "operationId": "createOrderReturn", + "operationId": "createB2bComponentsRole", "parameters": [ { "name": "_response", @@ -11317,33 +12593,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -11355,7 +12614,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11370,7 +12629,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11386,22 +12645,32 @@ } } }, - "/search/order-return": { + "/search/b2b-components-role": { "post": { "tags": [ - "Order Return" + "B2b Components Role" ], - "summary": "Search for the Order Return resources.", + "summary": "Search for the B2b Components Role resources.", "description": "", - "operationId": "searchOrderReturn", + "operationId": "searchB2bComponentsRole", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -11411,7 +12680,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -11425,7 +12694,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11443,7 +12712,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11460,19 +12729,19 @@ } } }, - "/order-return/{id}": { + "/b2b-components-role/{id}": { "get": { "tags": [ - "Order Return" + "B2b Components Role" ], - "summary": "Detailed information about a Order Return resource.", + "summary": "Detailed information about a B2b Components Role resource.", "description": "", - "operationId": "getOrderReturn", + "operationId": "getB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -11482,7 +12751,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -11494,7 +12763,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11509,7 +12778,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11526,16 +12795,16 @@ }, "delete": { "tags": [ - "Order Return" + "B2b Components Role" ], - "summary": "Delete a Order Return resource.", + "summary": "Delete a B2b Components Role resource.", "description": "", - "operationId": "deleteOrderReturn", + "operationId": "deleteB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -11566,16 +12835,16 @@ }, "patch": { "tags": [ - "Order Return" + "B2b Components Role" ], - "summary": "Partially update information about a Order Return resource.", + "summary": "Partially update information about a B2b Components Role resource.", "description": "", - "operationId": "updateOrderReturn", + "operationId": "updateB2bComponentsRole", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the b2b_components_role", "required": true, "schema": { "type": "string", @@ -11593,35 +12862,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return resource.", + "description": "Partially update information about a B2b Components Role resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturn" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of B2bComponentsRole", "content": { "application/vnd.api+json": { "schema": { @@ -11633,7 +12885,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11648,7 +12900,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/B2bComponentsRole" } } } @@ -11667,14 +12919,94 @@ } } }, - "/order-return-line-item": { + "/aggregate/b2b-components-role": { + "post": { + "tags": [ + "B2b Components Role" + ], + "summary": "Aggregate for the B2b Components Role resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsRole", + "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 B2bComponentsRole", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-shopping-list": { "get": { "tags": [ - "Order Return Line Item" + "B2b Components Shopping List" ], - "summary": "List with basic information of Order Return Line Item resources.", - "description": "", - "operationId": "getOrderReturnLineItemList", + "summary": "List with basic information of B2b Components Shopping List resources.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListList", "parameters": [ { "name": "limit", @@ -11703,7 +13035,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item resources.", + "description": "List of B2b Components Shopping List resources.", "content": { "application/vnd.api+json": { "schema": { @@ -11722,7 +13054,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } ] @@ -11736,16 +13068,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item?limit=25" + "example": "/b2b-components-shopping-list?limit=25" }, "last": { - "example": "/order-return-line-item?limit=25&page=11" + "example": "/b2b-components-shopping-list?limit=25&page=11" }, "next": { - "example": "/order-return-line-item?limit=25&page=4" + "example": "/b2b-components-shopping-list?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item?limit=25&page=2" + "example": "/b2b-components-shopping-list?limit=25&page=2" } } } @@ -11766,7 +13098,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11781,11 +13113,11 @@ }, "post": { "tags": [ - "Order Return Line Item" + "B2b Components Shopping List" ], - "summary": "Create a new Order Return Line Item resources.", - "description": "", - "operationId": "createOrderReturnLineItem", + "summary": "Create a new B2b Components Shopping List resources.", + "description": "Available since: 6.6.2.0", + "operationId": "createB2bComponentsShoppingList", "parameters": [ { "name": "_response", @@ -11802,33 +13134,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -11840,7 +13155,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11855,7 +13170,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11871,22 +13186,32 @@ } } }, - "/search/order-return-line-item": { + "/search/b2b-components-shopping-list": { "post": { "tags": [ - "Order Return Line Item" + "B2b Components Shopping List" + ], + "summary": "Search for the B2b Components Shopping List resources.", + "description": "Available since: 6.6.2.0", + "operationId": "searchB2bComponentsShoppingList", + "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" + } + } ], - "summary": "Search for the Order Return Line Item resources.", - "description": "", - "operationId": "searchOrderReturnLineItem", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -11896,7 +13221,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -11910,7 +13235,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11928,7 +13253,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11945,19 +13270,19 @@ } } }, - "/order-return-line-item/{id}": { + "/b2b-components-shopping-list/{id}": { "get": { "tags": [ - "Order Return Line Item" + "B2b Components Shopping List" ], - "summary": "Detailed information about a Order Return Line Item resource.", - "description": "", - "operationId": "getOrderReturnLineItem", + "summary": "Detailed information about a B2b Components Shopping List resource.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -11967,7 +13292,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -11979,7 +13304,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -11994,7 +13319,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -12011,16 +13336,16 @@ }, "delete": { "tags": [ - "Order Return Line Item" + "B2b Components Shopping List" ], - "summary": "Delete a Order Return Line Item resource.", - "description": "", - "operationId": "deleteOrderReturnLineItem", + "summary": "Delete a B2b Components Shopping List resource.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -12051,16 +13376,16 @@ }, "patch": { "tags": [ - "Order Return Line Item" + "B2b Components Shopping List" ], - "summary": "Partially update information about a Order Return Line Item resource.", - "description": "", - "operationId": "updateOrderReturnLineItem", + "summary": "Partially update information about a B2b Components Shopping List resource.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the b2b_components_shopping_list", "required": true, "schema": { "type": "string", @@ -12078,35 +13403,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item resource.", + "description": "Partially update information about a B2b Components Shopping List resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of B2bComponentsShoppingList", "content": { "application/vnd.api+json": { "schema": { @@ -12118,7 +13426,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -12133,7 +13441,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/B2bComponentsShoppingList" } } } @@ -12152,14 +13460,94 @@ } } }, - "/order-return-line-item-reason": { + "/aggregate/b2b-components-shopping-list": { + "post": { + "tags": [ + "B2b Components Shopping List" + ], + "summary": "Aggregate for the B2b Components Shopping List resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsShoppingList", + "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 B2bComponentsShoppingList", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-shopping-list-line-item": { "get": { "tags": [ - "Order Return Line Item Reason" + "B2b Components Shopping List Line Item" ], - "summary": "List with basic information of Order Return Line Item Reason resources.", - "description": "", - "operationId": "getOrderReturnLineItemReasonList", + "summary": "List with basic information of B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListLineItemList", "parameters": [ { "name": "limit", @@ -12188,7 +13576,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item Reason resources.", + "description": "List of B2b Components Shopping List Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12207,7 +13595,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } ] @@ -12221,16 +13609,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item-reason?limit=25" + "example": "/b2b-components-shopping-list-line-item?limit=25" }, "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=11" }, "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" + "example": "/b2b-components-shopping-list-line-item?limit=25&page=2" } } } @@ -12251,7 +13639,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12266,11 +13654,11 @@ }, "post": { "tags": [ - "Order Return Line Item Reason" + "B2b Components Shopping List Line Item" ], - "summary": "Create a new Order Return Line Item Reason resources.", - "description": "", - "operationId": "createOrderReturnLineItemReason", + "summary": "Create a new B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.2.0", + "operationId": "createB2bComponentsShoppingListLineItem", "parameters": [ { "name": "_response", @@ -12287,33 +13675,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -12325,7 +13696,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12340,7 +13711,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12356,22 +13727,32 @@ } } }, - "/search/order-return-line-item-reason": { + "/search/b2b-components-shopping-list-line-item": { "post": { "tags": [ - "Order Return Line Item Reason" + "B2b Components Shopping List Line Item" + ], + "summary": "Search for the B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.2.0", + "operationId": "searchB2bComponentsShoppingListLineItem", + "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" + } + } ], - "summary": "Search for the Order Return Line Item Reason resources.", - "description": "", - "operationId": "searchOrderReturnLineItemReason", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -12381,7 +13762,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -12395,7 +13776,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12413,7 +13794,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12430,19 +13811,19 @@ } } }, - "/order-return-line-item-reason/{id}": { + "/b2b-components-shopping-list-line-item/{id}": { "get": { "tags": [ - "Order Return Line Item Reason" + "B2b Components Shopping List Line Item" ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", - "description": "", - "operationId": "getOrderReturnLineItemReason", + "summary": "Detailed information about a B2b Components Shopping List Line Item resource.", + "description": "Available since: 6.6.2.0", + "operationId": "getB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -12452,7 +13833,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -12464,7 +13845,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12479,7 +13860,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12496,16 +13877,16 @@ }, "delete": { "tags": [ - "Order Return Line Item Reason" + "B2b Components Shopping List Line Item" ], - "summary": "Delete a Order Return Line Item Reason resource.", - "description": "", - "operationId": "deleteOrderReturnLineItemReason", + "summary": "Delete a B2b Components Shopping List Line Item resource.", + "description": "Available since: 6.6.2.0", + "operationId": "deleteB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -12536,16 +13917,16 @@ }, "patch": { "tags": [ - "Order Return Line Item Reason" + "B2b Components Shopping List Line Item" ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", - "description": "", - "operationId": "updateOrderReturnLineItemReason", + "summary": "Partially update information about a B2b Components Shopping List Line Item resource.", + "description": "Available since: 6.6.2.0", + "operationId": "updateB2bComponentsShoppingListLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the b2b_components_shopping_list_line_item", "required": true, "schema": { "type": "string", @@ -12563,35 +13944,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item Reason resource.", + "description": "Partially update information about a B2b Components Shopping List Line Item resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of B2bComponentsShoppingListLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -12603,7 +13967,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12618,7 +13982,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } } @@ -12637,14 +14001,94 @@ } } }, - "/order-warehouse-group": { + "/aggregate/b2b-components-shopping-list-line-item": { + "post": { + "tags": [ + "B2b Components Shopping List Line Item" + ], + "summary": "Aggregate for the B2b Components Shopping List Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsShoppingListLineItem", + "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 B2bComponentsShoppingListLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-components-subscription-employee": { "get": { "tags": [ - "Order Warehouse Group" + "B2b Components Subscription Employee" ], - "summary": "List with basic information of Order Warehouse Group resources.", + "summary": "List with basic information of B2b Components Subscription Employee resources.", "description": "", - "operationId": "getOrderWarehouseGroupList", + "operationId": "getB2bComponentsSubscriptionEmployeeList", "parameters": [ { "name": "limit", @@ -12673,7 +14117,7 @@ ], "responses": { "200": { - "description": "List of Order Warehouse Group resources.", + "description": "List of B2b Components Subscription Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -12692,7 +14136,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } ] @@ -12706,16 +14150,16 @@ "type": "object", "properties": { "first": { - "example": "/order-warehouse-group?limit=25" + "example": "/b2b-components-subscription-employee?limit=25" }, "last": { - "example": "/order-warehouse-group?limit=25&page=11" + "example": "/b2b-components-subscription-employee?limit=25&page=11" }, "next": { - "example": "/order-warehouse-group?limit=25&page=4" + "example": "/b2b-components-subscription-employee?limit=25&page=4" }, "prev": { - "example": "/order-warehouse-group?limit=25&page=2" + "example": "/b2b-components-subscription-employee?limit=25&page=2" } } } @@ -12736,7 +14180,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12751,11 +14195,11 @@ }, "post": { "tags": [ - "Order Warehouse Group" + "B2b Components Subscription Employee" ], - "summary": "Create a new Order Warehouse Group resources.", + "summary": "Create a new B2b Components Subscription Employee resources.", "description": "", - "operationId": "createOrderWarehouseGroup", + "operationId": "createB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "_response", @@ -12772,33 +14216,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12810,7 +14237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12825,7 +14252,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12841,22 +14268,32 @@ } } }, - "/search/order-warehouse-group": { + "/search/b2b-components-subscription-employee": { "post": { "tags": [ - "Order Warehouse Group" + "B2b Components Subscription Employee" ], - "summary": "Search for the Order Warehouse Group resources.", + "summary": "Search for the B2b Components Subscription Employee resources.", "description": "", - "operationId": "searchOrderWarehouseGroup", + "operationId": "searchB2bComponentsSubscriptionEmployee", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -12866,7 +14303,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12880,7 +14317,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12898,7 +14335,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12915,19 +14352,19 @@ } } }, - "/order-warehouse-group/{id}": { + "/b2b-components-subscription-employee/{id}": { "get": { "tags": [ - "Order Warehouse Group" + "B2b Components Subscription Employee" ], - "summary": "Detailed information about a Order Warehouse Group resource.", + "summary": "Detailed information about a B2b Components Subscription Employee resource.", "description": "", - "operationId": "getOrderWarehouseGroup", + "operationId": "getB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the b2b_components_subscription_employee", "required": true, "schema": { "type": "string", @@ -12937,7 +14374,7 @@ ], "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -12949,7 +14386,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12964,7 +14401,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -12981,16 +14418,16 @@ }, "delete": { "tags": [ - "Order Warehouse Group" + "B2b Components Subscription Employee" ], - "summary": "Delete a Order Warehouse Group resource.", + "summary": "Delete a B2b Components Subscription Employee resource.", "description": "", - "operationId": "deleteOrderWarehouseGroup", + "operationId": "deleteB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the b2b_components_subscription_employee", "required": true, "schema": { "type": "string", @@ -13021,16 +14458,16 @@ }, "patch": { "tags": [ - "Order Warehouse Group" + "B2b Components Subscription Employee" ], - "summary": "Partially update information about a Order Warehouse Group resource.", + "summary": "Partially update information about a B2b Components Subscription Employee resource.", "description": "", - "operationId": "updateOrderWarehouseGroup", + "operationId": "updateB2bComponentsSubscriptionEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the b2b_components_subscription_employee", "required": true, "schema": { "type": "string", @@ -13048,35 +14485,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Warehouse Group resource.", + "description": "Partially update information about a B2b Components Subscription Employee resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of B2bComponentsSubscriptionEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13088,7 +14508,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -13103,7 +14523,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" } } } @@ -13122,14 +14542,94 @@ } } }, - "/product-review-summary": { + "/aggregate/b2b-components-subscription-employee": { + "post": { + "tags": [ + "B2b Components Subscription Employee" + ], + "summary": "Aggregate for the B2b Components Subscription Employee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bComponentsSubscriptionEmployee", + "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 B2bComponentsSubscriptionEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsSubscriptionEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-employee": { "get": { "tags": [ - "Product Review Summary" + "B2b Employee" ], - "summary": "List with basic information of Product Review Summary resources.", + "summary": "List with basic information of B2b Employee resources.", "description": "", - "operationId": "getProductReviewSummaryList", + "operationId": "getB2bEmployeeList", "parameters": [ { "name": "limit", @@ -13158,7 +14658,7 @@ ], "responses": { "200": { - "description": "List of Product Review Summary resources.", + "description": "List of B2b Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13177,7 +14677,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } ] @@ -13191,16 +14691,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review-summary?limit=25" + "example": "/b2b-employee?limit=25" }, "last": { - "example": "/product-review-summary?limit=25&page=11" + "example": "/b2b-employee?limit=25&page=11" }, "next": { - "example": "/product-review-summary?limit=25&page=4" + "example": "/b2b-employee?limit=25&page=4" }, "prev": { - "example": "/product-review-summary?limit=25&page=2" + "example": "/b2b-employee?limit=25&page=2" } } } @@ -13221,7 +14721,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13236,11 +14736,11 @@ }, "post": { "tags": [ - "Product Review Summary" + "B2b Employee" ], - "summary": "Create a new Product Review Summary resources.", + "summary": "Create a new B2b Employee resources.", "description": "", - "operationId": "createProductReviewSummary", + "operationId": "createB2bEmployee", "parameters": [ { "name": "_response", @@ -13257,33 +14757,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13295,7 +14778,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13310,7 +14793,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13326,22 +14809,32 @@ } } }, - "/search/product-review-summary": { + "/search/b2b-employee": { "post": { "tags": [ - "Product Review Summary" + "B2b Employee" ], - "summary": "Search for the Product Review Summary resources.", + "summary": "Search for the B2b Employee resources.", "description": "", - "operationId": "searchProductReviewSummary", + "operationId": "searchB2bEmployee", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -13351,7 +14844,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13365,7 +14858,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13383,7 +14876,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13400,19 +14893,19 @@ } } }, - "/product-review-summary/{id}": { + "/b2b-employee/{id}": { "get": { "tags": [ - "Product Review Summary" + "B2b Employee" ], - "summary": "Detailed information about a Product Review Summary resource.", + "summary": "Detailed information about a B2b Employee resource.", "description": "", - "operationId": "getProductReviewSummary", + "operationId": "getB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -13422,7 +14915,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13434,7 +14927,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13449,7 +14942,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13466,16 +14959,16 @@ }, "delete": { "tags": [ - "Product Review Summary" + "B2b Employee" ], - "summary": "Delete a Product Review Summary resource.", + "summary": "Delete a B2b Employee resource.", "description": "", - "operationId": "deleteProductReviewSummary", + "operationId": "deleteB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -13506,16 +14999,16 @@ }, "patch": { "tags": [ - "Product Review Summary" + "B2b Employee" ], - "summary": "Partially update information about a Product Review Summary resource.", + "summary": "Partially update information about a B2b Employee resource.", "description": "", - "operationId": "updateProductReviewSummary", + "operationId": "updateB2bEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the b2b_employee", "required": true, "schema": { "type": "string", @@ -13533,35 +15026,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review Summary resource.", + "description": "Partially update information about a B2b Employee resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductReviewSummary" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of B2bEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13573,7 +15049,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13588,7 +15064,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/B2bEmployee" } } } @@ -13607,14 +15083,94 @@ } } }, - "/product-warehouse": { + "/aggregate/b2b-employee": { + "post": { + "tags": [ + "B2b Employee" + ], + "summary": "Aggregate for the B2b Employee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bEmployee", + "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 B2bEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-order-employee": { "get": { "tags": [ - "Product Warehouse" + "B2b Order Employee" ], - "summary": "List with basic information of Product Warehouse resources.", + "summary": "List with basic information of B2b Order Employee resources.", "description": "", - "operationId": "getProductWarehouseList", + "operationId": "getB2bOrderEmployeeList", "parameters": [ { "name": "limit", @@ -13643,7 +15199,7 @@ ], "responses": { "200": { - "description": "List of Product Warehouse resources.", + "description": "List of B2b Order Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -13662,7 +15218,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } ] @@ -13676,16 +15232,16 @@ "type": "object", "properties": { "first": { - "example": "/product-warehouse?limit=25" + "example": "/b2b-order-employee?limit=25" }, "last": { - "example": "/product-warehouse?limit=25&page=11" + "example": "/b2b-order-employee?limit=25&page=11" }, "next": { - "example": "/product-warehouse?limit=25&page=4" + "example": "/b2b-order-employee?limit=25&page=4" }, "prev": { - "example": "/product-warehouse?limit=25&page=2" + "example": "/b2b-order-employee?limit=25&page=2" } } } @@ -13706,7 +15262,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13721,11 +15277,11 @@ }, "post": { "tags": [ - "Product Warehouse" + "B2b Order Employee" ], - "summary": "Create a new Product Warehouse resources.", + "summary": "Create a new B2b Order Employee resources.", "description": "", - "operationId": "createProductWarehouse", + "operationId": "createB2bOrderEmployee", "parameters": [ { "name": "_response", @@ -13742,33 +15298,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13780,7 +15319,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13795,7 +15334,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13811,22 +15350,32 @@ } } }, - "/search/product-warehouse": { + "/search/b2b-order-employee": { "post": { "tags": [ - "Product Warehouse" + "B2b Order Employee" ], - "summary": "Search for the Product Warehouse resources.", + "summary": "Search for the B2b Order Employee resources.", "description": "", - "operationId": "searchProductWarehouse", + "operationId": "searchB2bOrderEmployee", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -13836,7 +15385,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13850,7 +15399,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13868,7 +15417,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13885,19 +15434,19 @@ } } }, - "/product-warehouse/{id}": { + "/b2b-order-employee/{id}": { "get": { "tags": [ - "Product Warehouse" + "B2b Order Employee" ], - "summary": "Detailed information about a Product Warehouse resource.", + "summary": "Detailed information about a B2b Order Employee resource.", "description": "", - "operationId": "getProductWarehouse", + "operationId": "getB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -13907,7 +15456,7 @@ ], "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -13919,7 +15468,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13934,7 +15483,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -13951,16 +15500,16 @@ }, "delete": { "tags": [ - "Product Warehouse" + "B2b Order Employee" ], - "summary": "Delete a Product Warehouse resource.", + "summary": "Delete a B2b Order Employee resource.", "description": "", - "operationId": "deleteProductWarehouse", + "operationId": "deleteB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -13991,16 +15540,16 @@ }, "patch": { "tags": [ - "Product Warehouse" + "B2b Order Employee" ], - "summary": "Partially update information about a Product Warehouse resource.", + "summary": "Partially update information about a B2b Order Employee resource.", "description": "", - "operationId": "updateProductWarehouse", + "operationId": "updateB2bOrderEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the b2b_order_employee", "required": true, "schema": { "type": "string", @@ -14018,35 +15567,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Warehouse resource.", + "description": "Partially update information about a B2b Order Employee resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/ProductWarehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of B2bOrderEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -14058,7 +15590,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -14073,7 +15605,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/B2bOrderEmployee" } } } @@ -14092,14 +15624,94 @@ } } }, - "/quote": { + "/aggregate/b2b-order-employee": { + "post": { + "tags": [ + "B2b Order Employee" + ], + "summary": "Aggregate for the B2b Order Employee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bOrderEmployee", + "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 B2bOrderEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bOrderEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/b2b-permission": { "get": { "tags": [ - "Quote" + "B2b Permission" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", + "summary": "List with basic information of B2b Permission resources.", + "description": "", + "operationId": "getB2bPermissionList", "parameters": [ { "name": "limit", @@ -14128,7 +15740,7 @@ ], "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of B2b Permission resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14147,7 +15759,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } ] @@ -14161,16 +15773,16 @@ "type": "object", "properties": { "first": { - "example": "/quote?limit=25" + "example": "/b2b-permission?limit=25" }, "last": { - "example": "/quote?limit=25&page=11" + "example": "/b2b-permission?limit=25&page=11" }, "next": { - "example": "/quote?limit=25&page=4" + "example": "/b2b-permission?limit=25&page=4" }, "prev": { - "example": "/quote?limit=25&page=2" + "example": "/b2b-permission?limit=25&page=2" } } } @@ -14191,7 +15803,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14206,11 +15818,11 @@ }, "post": { "tags": [ - "Quote" + "B2b Permission" ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", + "summary": "Create a new B2b Permission resources.", + "description": "", + "operationId": "createB2bPermission", "parameters": [ { "name": "_response", @@ -14227,33 +15839,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Quote" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -14265,7 +15860,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14280,7 +15875,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14296,22 +15891,32 @@ } } }, - "/search/quote": { + "/search/b2b-permission": { "post": { "tags": [ - "Quote" + "B2b Permission" + ], + "summary": "Search for the B2b Permission resources.", + "description": "", + "operationId": "searchB2bPermission", + "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" + } + } ], - "summary": "Search for the Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuote", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -14321,7 +15926,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -14335,7 +15940,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14353,7 +15958,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14370,19 +15975,19 @@ } } }, - "/quote/{id}": { + "/b2b-permission/{id}": { "get": { "tags": [ - "Quote" + "B2b Permission" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", + "summary": "Detailed information about a B2b Permission resource.", + "description": "", + "operationId": "getB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -14392,7 +15997,7 @@ ], "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -14404,7 +16009,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14419,7 +16024,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14436,16 +16041,16 @@ }, "delete": { "tags": [ - "Quote" + "B2b Permission" ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", + "summary": "Delete a B2b Permission resource.", + "description": "", + "operationId": "deleteB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -14476,16 +16081,16 @@ }, "patch": { "tags": [ - "Quote" + "B2b Permission" ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", + "summary": "Partially update information about a B2b Permission resource.", + "description": "", + "operationId": "updateB2bPermission", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the b2b_permission", "required": true, "schema": { "type": "string", @@ -14503,35 +16108,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote resource.", + "description": "Partially update information about a B2b Permission resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Quote" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of B2bPermission", "content": { "application/vnd.api+json": { "schema": { @@ -14543,7 +16131,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14558,7 +16146,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/B2bPermission" } } } @@ -14577,14 +16165,95 @@ } } }, - "/quote-comment": { + "/aggregate/b2b-permission": { + "post": { + "tags": [ + "B2b Permission" + ], + "summary": "Aggregate for the B2b Permission resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateB2bPermission", + "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 B2bPermission", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bPermission" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/bundle-discount": { "get": { "tags": [ - "Quote Comment" + "Bundle Discount", + "Experimental" ], - "summary": "List with basic information of Quote Comment resources.", - "description": "", - "operationId": "getQuoteCommentList", + "summary": "List with basic information of Bundle Discount 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": "getBundleDiscountList", "parameters": [ { "name": "limit", @@ -14613,7 +16282,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Bundle Discount resources.", "content": { "application/vnd.api+json": { "schema": { @@ -14632,7 +16301,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } ] @@ -14646,16 +16315,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/bundle-discount?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/bundle-discount?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/bundle-discount?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/bundle-discount?limit=25&page=2" } } } @@ -14676,7 +16345,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14691,11 +16360,12 @@ }, "post": { "tags": [ - "Quote Comment" + "Bundle Discount", + "Experimental" ], - "summary": "Create a new Quote Comment resources.", - "description": "", - "operationId": "createQuoteComment", + "summary": "Create a new Bundle Discount 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": "createBundleDiscount", "parameters": [ { "name": "_response", @@ -14712,33 +16382,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteComment" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -14750,7 +16403,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14765,7 +16418,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14781,22 +16434,33 @@ } } }, - "/search/quote-comment": { + "/search/bundle-discount": { "post": { "tags": [ - "Quote Comment" + "Bundle Discount", + "Experimental" + ], + "summary": "Search for the Bundle Discount 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": "searchBundleDiscount", + "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" + } + } ], - "summary": "Search for the Quote Comment resources.", - "description": "", - "operationId": "searchQuoteComment", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -14806,7 +16470,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -14820,7 +16484,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14838,7 +16502,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14855,19 +16519,20 @@ } } }, - "/quote-comment/{id}": { + "/bundle-discount/{id}": { "get": { "tags": [ - "Quote Comment" + "Bundle Discount", + "Experimental" ], - "summary": "Detailed information about a Quote Comment resource.", - "description": "", - "operationId": "getQuoteComment", + "summary": "Detailed information about a Bundle Discount 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": "getBundleDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -14877,7 +16542,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -14889,7 +16554,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14904,7 +16569,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -14921,16 +16586,17 @@ }, "delete": { "tags": [ - "Quote Comment" + "Bundle Discount", + "Experimental" ], - "summary": "Delete a Quote Comment resource.", - "description": "", - "operationId": "deleteQuoteComment", + "summary": "Delete a Bundle Discount 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": "deleteBundleDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -14961,16 +16627,17 @@ }, "patch": { "tags": [ - "Quote Comment" + "Bundle Discount", + "Experimental" ], - "summary": "Partially update information about a Quote Comment resource.", - "description": "", - "operationId": "updateQuoteComment", + "summary": "Partially update information about a Bundle Discount 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": "updateBundleDiscount", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the bundle_discount", "required": true, "schema": { "type": "string", @@ -14988,35 +16655,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Bundle Discount resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteComment" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of BundleDiscount", "content": { "application/vnd.api+json": { "schema": { @@ -15028,7 +16678,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -15043,7 +16693,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/BundleDiscount" } } } @@ -15062,14 +16712,96 @@ } } }, - "/quote-delivery": { + "/aggregate/bundle-discount": { + "post": { + "tags": [ + "Bundle Discount", + "Experimental" + ], + "summary": "Aggregate for the Bundle Discount 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": "aggregateBundleDiscount", + "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 BundleDiscount", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleDiscount" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleDiscount" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/bundle-item": { "get": { "tags": [ - "Quote Delivery" + "Bundle Item", + "Experimental" ], - "summary": "List with basic information of Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", + "summary": "List with basic information of Bundle Item 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": "getBundleItemList", "parameters": [ { "name": "limit", @@ -15098,7 +16830,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Bundle Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15117,7 +16849,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } ] @@ -15131,16 +16863,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery?limit=25" + "example": "/bundle-item?limit=25" }, "last": { - "example": "/quote-delivery?limit=25&page=11" + "example": "/bundle-item?limit=25&page=11" }, "next": { - "example": "/quote-delivery?limit=25&page=4" + "example": "/bundle-item?limit=25&page=4" }, "prev": { - "example": "/quote-delivery?limit=25&page=2" + "example": "/bundle-item?limit=25&page=2" } } } @@ -15161,7 +16893,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15176,11 +16908,12 @@ }, "post": { "tags": [ - "Quote Delivery" + "Bundle Item", + "Experimental" ], - "summary": "Create a new Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", + "summary": "Create a new Bundle Item 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": "createBundleItem", "parameters": [ { "name": "_response", @@ -15197,33 +16930,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -15235,7 +16951,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15250,7 +16966,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15266,22 +16982,33 @@ } } }, - "/search/quote-delivery": { + "/search/bundle-item": { "post": { "tags": [ - "Quote Delivery" + "Bundle Item", + "Experimental" + ], + "summary": "Search for the Bundle Item 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": "searchBundleItem", + "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" + } + } ], - "summary": "Search for the Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDelivery", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -15291,7 +17018,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -15305,7 +17032,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15323,7 +17050,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15340,19 +17067,20 @@ } } }, - "/quote-delivery/{id}": { + "/bundle-item/{id}": { "get": { "tags": [ - "Quote Delivery" + "Bundle Item", + "Experimental" ], - "summary": "Detailed information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", + "summary": "Detailed information about a Bundle Item 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": "getBundleItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -15362,7 +17090,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -15374,7 +17102,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15389,7 +17117,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15406,16 +17134,17 @@ }, "delete": { "tags": [ - "Quote Delivery" + "Bundle Item", + "Experimental" ], - "summary": "Delete a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", + "summary": "Delete a Bundle Item 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": "deleteBundleItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -15446,16 +17175,17 @@ }, "patch": { "tags": [ - "Quote Delivery" + "Bundle Item", + "Experimental" ], - "summary": "Partially update information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", + "summary": "Partially update information about a Bundle Item 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": "updateBundleItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the bundle_item", "required": true, "schema": { "type": "string", @@ -15473,35 +17203,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "description": "Partially update information about a Bundle Item resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDelivery" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of BundleItem", "content": { "application/vnd.api+json": { "schema": { @@ -15513,7 +17226,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15528,7 +17241,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/BundleItem" } } } @@ -15547,14 +17260,95 @@ } } }, - "/quote-delivery-position": { + "/aggregate/bundle-item": { + "post": { + "tags": [ + "Bundle Item", + "Experimental" + ], + "summary": "Aggregate for the Bundle Item 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": "aggregateBundleItem", + "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 BundleItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/custom-price": { "get": { "tags": [ - "Quote Delivery Position" + "Custom Price" ], - "summary": "List with basic information of Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPositionList", + "summary": "List with basic information of Custom Price resources.", + "description": "", + "operationId": "getCustomPriceList", "parameters": [ { "name": "limit", @@ -15583,7 +17377,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Custom Price resources.", "content": { "application/vnd.api+json": { "schema": { @@ -15602,7 +17396,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } ] @@ -15616,16 +17410,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/custom-price?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/custom-price?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/custom-price?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/custom-price?limit=25&page=2" } } } @@ -15646,7 +17440,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15661,11 +17455,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Custom Price" ], - "summary": "Create a new Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "summary": "Create a new Custom Price resources.", + "description": "", + "operationId": "createCustomPrice", "parameters": [ { "name": "_response", @@ -15682,33 +17476,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -15720,7 +17497,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15735,7 +17512,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15751,22 +17528,32 @@ } } }, - "/search/quote-delivery-position": { + "/search/custom-price": { "post": { "tags": [ - "Quote Delivery Position" + "Custom Price" + ], + "summary": "Search for the Custom Price resources.", + "description": "", + "operationId": "searchCustomPrice", + "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" + } + } ], - "summary": "Search for the Quote Delivery Position resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDeliveryPosition", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -15776,7 +17563,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -15790,7 +17577,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15808,7 +17595,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15825,19 +17612,19 @@ } } }, - "/quote-delivery-position/{id}": { + "/custom-price/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Custom Price" ], - "summary": "Detailed information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "summary": "Detailed information about a Custom Price resource.", + "description": "", + "operationId": "getCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -15847,7 +17634,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -15859,7 +17646,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15874,7 +17661,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -15891,16 +17678,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Custom Price" ], - "summary": "Delete a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", + "summary": "Delete a Custom Price resource.", + "description": "", + "operationId": "deleteCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -15931,16 +17718,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Custom Price" ], - "summary": "Partially update information about a Quote Delivery Position resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDeliveryPosition", + "summary": "Partially update information about a Custom Price resource.", + "description": "", + "operationId": "updateCustomPrice", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the custom_price", "required": true, "schema": { "type": "string", @@ -15958,35 +17745,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Custom Price resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of CustomPrice", "content": { "application/vnd.api+json": { "schema": { @@ -15998,7 +17768,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -16013,7 +17783,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/CustomPrice" } } } @@ -16032,14 +17802,94 @@ } } }, - "/quote-document": { + "/aggregate/custom-price": { + "post": { + "tags": [ + "Custom Price" + ], + "summary": "Aggregate for the Custom Price resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomPrice", + "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 CustomPrice", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomPrice" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/customer-specific-features": { "get": { "tags": [ - "Quote Document" + "Customer Specific Features" ], - "summary": "List with basic information of Quote Document resources.", + "summary": "List with basic information of Customer Specific Features resources.", "description": "", - "operationId": "getQuoteDocumentList", + "operationId": "getCustomerSpecificFeaturesList", "parameters": [ { "name": "limit", @@ -16068,7 +17918,7 @@ ], "responses": { "200": { - "description": "List of Quote Document resources.", + "description": "List of Customer Specific Features resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16087,7 +17937,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } ] @@ -16101,16 +17951,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-document?limit=25" + "example": "/customer-specific-features?limit=25" }, "last": { - "example": "/quote-document?limit=25&page=11" + "example": "/customer-specific-features?limit=25&page=11" }, "next": { - "example": "/quote-document?limit=25&page=4" + "example": "/customer-specific-features?limit=25&page=4" }, "prev": { - "example": "/quote-document?limit=25&page=2" + "example": "/customer-specific-features?limit=25&page=2" } } } @@ -16131,7 +17981,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16146,11 +17996,11 @@ }, "post": { "tags": [ - "Quote Document" + "Customer Specific Features" ], - "summary": "Create a new Quote Document resources.", + "summary": "Create a new Customer Specific Features resources.", "description": "", - "operationId": "createQuoteDocument", + "operationId": "createCustomerSpecificFeatures", "parameters": [ { "name": "_response", @@ -16167,33 +18017,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDocument" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -16205,7 +18038,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16220,7 +18053,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16236,22 +18069,32 @@ } } }, - "/search/quote-document": { + "/search/customer-specific-features": { "post": { "tags": [ - "Quote Document" + "Customer Specific Features" ], - "summary": "Search for the Quote Document resources.", + "summary": "Search for the Customer Specific Features resources.", "description": "", - "operationId": "searchQuoteDocument", + "operationId": "searchCustomerSpecificFeatures", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -16261,7 +18104,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -16275,7 +18118,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16293,7 +18136,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16310,19 +18153,19 @@ } } }, - "/quote-document/{id}": { + "/customer-specific-features/{id}": { "get": { "tags": [ - "Quote Document" + "Customer Specific Features" ], - "summary": "Detailed information about a Quote Document resource.", + "summary": "Detailed information about a Customer Specific Features resource.", "description": "", - "operationId": "getQuoteDocument", + "operationId": "getCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -16332,7 +18175,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -16344,7 +18187,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16359,7 +18202,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16376,16 +18219,16 @@ }, "delete": { "tags": [ - "Quote Document" + "Customer Specific Features" ], - "summary": "Delete a Quote Document resource.", + "summary": "Delete a Customer Specific Features resource.", "description": "", - "operationId": "deleteQuoteDocument", + "operationId": "deleteCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -16416,16 +18259,16 @@ }, "patch": { "tags": [ - "Quote Document" + "Customer Specific Features" ], - "summary": "Partially update information about a Quote Document resource.", + "summary": "Partially update information about a Customer Specific Features resource.", "description": "", - "operationId": "updateQuoteDocument", + "operationId": "updateCustomerSpecificFeatures", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the customer_specific_features", "required": true, "schema": { "type": "string", @@ -16443,35 +18286,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Document resource.", + "description": "Partially update information about a Customer Specific Features resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteDocument" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of CustomerSpecificFeatures", "content": { "application/vnd.api+json": { "schema": { @@ -16483,7 +18309,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16498,7 +18324,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/CustomerSpecificFeatures" } } } @@ -16517,14 +18343,94 @@ } } }, - "/quote-employee": { + "/aggregate/customer-specific-features": { + "post": { + "tags": [ + "Customer Specific Features" + ], + "summary": "Aggregate for the Customer Specific Features resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateCustomerSpecificFeatures", + "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 CustomerSpecificFeatures", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerSpecificFeatures" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/media-ai-tag": { "get": { "tags": [ - "Quote Employee" + "Media Ai Tag" ], - "summary": "List with basic information of Quote Employee resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getQuoteEmployeeList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -16553,7 +18459,7 @@ ], "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -16572,7 +18478,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -16586,16 +18492,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-employee?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/quote-employee?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/quote-employee?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/quote-employee?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -16616,7 +18522,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16631,11 +18537,11 @@ }, "post": { "tags": [ - "Quote Employee" + "Media Ai Tag" ], - "summary": "Create a new Quote Employee resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createQuoteEmployee", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -16652,33 +18558,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -16690,7 +18579,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16705,7 +18594,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16721,22 +18610,32 @@ } } }, - "/search/quote-employee": { + "/search/media-ai-tag": { "post": { "tags": [ - "Quote Employee" + "Media Ai Tag" ], - "summary": "Search for the Quote Employee resources.", + "summary": "Search for the Media Ai Tag resources.", "description": "", - "operationId": "searchQuoteEmployee", + "operationId": "searchMediaAiTag", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -16746,7 +18645,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -16760,7 +18659,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16778,7 +18677,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16795,19 +18694,19 @@ } } }, - "/quote-employee/{id}": { + "/media-ai-tag/{id}": { "get": { "tags": [ - "Quote Employee" + "Media Ai Tag" ], - "summary": "Detailed information about a Quote Employee resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getQuoteEmployee", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -16817,7 +18716,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -16829,7 +18728,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16844,7 +18743,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16861,16 +18760,16 @@ }, "delete": { "tags": [ - "Quote Employee" + "Media Ai Tag" ], - "summary": "Delete a Quote Employee resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteQuoteEmployee", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -16901,16 +18800,16 @@ }, "patch": { "tags": [ - "Quote Employee" + "Media Ai Tag" ], - "summary": "Partially update information about a Quote Employee resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateQuoteEmployee", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -16928,35 +18827,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteEmployee" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -16968,7 +18850,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -16983,7 +18865,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -17002,14 +18884,94 @@ } } }, - "/quote-line-item": { + "/aggregate/media-ai-tag": { + "post": { + "tags": [ + "Media Ai Tag" + ], + "summary": "Aggregate for the Media Ai Tag resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateMediaAiTag", + "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 MediaAiTag", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaAiTag" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-product-warehouse": { "get": { "tags": [ - "Quote Line Item" + "Order Product Warehouse" ], - "summary": "List with basic information of Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItemList", + "summary": "List with basic information of Order Product Warehouse resources.", + "description": "", + "operationId": "getOrderProductWarehouseList", "parameters": [ { "name": "limit", @@ -17038,7 +19000,7 @@ ], "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17057,7 +19019,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } ] @@ -17071,16 +19033,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-line-item?limit=25" + "example": "/order-product-warehouse?limit=25" }, "last": { - "example": "/quote-line-item?limit=25&page=11" + "example": "/order-product-warehouse?limit=25&page=11" }, "next": { - "example": "/quote-line-item?limit=25&page=4" + "example": "/order-product-warehouse?limit=25&page=4" }, "prev": { - "example": "/quote-line-item?limit=25&page=2" + "example": "/order-product-warehouse?limit=25&page=2" } } } @@ -17101,7 +19063,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17116,11 +19078,11 @@ }, "post": { "tags": [ - "Quote Line Item" + "Order Product Warehouse" ], - "summary": "Create a new Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", + "summary": "Create a new Order Product Warehouse resources.", + "description": "", + "operationId": "createOrderProductWarehouse", "parameters": [ { "name": "_response", @@ -17137,33 +19099,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -17175,7 +19120,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17190,7 +19135,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17206,22 +19151,32 @@ } } }, - "/search/quote-line-item": { + "/search/order-product-warehouse": { "post": { "tags": [ - "Quote Line Item" + "Order Product Warehouse" + ], + "summary": "Search for the Order Product Warehouse resources.", + "description": "", + "operationId": "searchOrderProductWarehouse", + "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" + } + } ], - "summary": "Search for the Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteLineItem", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -17231,7 +19186,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -17245,7 +19200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17263,7 +19218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17280,19 +19235,19 @@ } } }, - "/quote-line-item/{id}": { + "/order-product-warehouse/{id}": { "get": { "tags": [ - "Quote Line Item" + "Order Product Warehouse" ], - "summary": "Detailed information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", + "summary": "Detailed information about a Order Product Warehouse resource.", + "description": "", + "operationId": "getOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -17302,7 +19257,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -17314,7 +19269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17329,7 +19284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17346,16 +19301,16 @@ }, "delete": { "tags": [ - "Quote Line Item" + "Order Product Warehouse" ], - "summary": "Delete a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", + "summary": "Delete a Order Product Warehouse resource.", + "description": "", + "operationId": "deleteOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -17386,16 +19341,16 @@ }, "patch": { "tags": [ - "Quote Line Item" + "Order Product Warehouse" ], - "summary": "Partially update information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteLineItem", + "summary": "Partially update information about a Order Product Warehouse resource.", + "description": "", + "operationId": "updateOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -17413,35 +19368,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "description": "Partially update information about a Order Product Warehouse resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteLineItem" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -17453,7 +19391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17468,7 +19406,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -17487,14 +19425,94 @@ } } }, - "/quote-transaction": { + "/aggregate/order-product-warehouse": { + "post": { + "tags": [ + "Order Product Warehouse" + ], + "summary": "Aggregate for the Order Product Warehouse resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderProductWarehouse", + "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 OrderProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return": { "get": { "tags": [ - "Quote Transaction" + "Order Return" ], - "summary": "List with basic information of Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransactionList", + "summary": "List with basic information of Order Return resources.", + "description": "", + "operationId": "getOrderReturnList", "parameters": [ { "name": "limit", @@ -17523,7 +19541,7 @@ ], "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { @@ -17542,7 +19560,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } ] @@ -17556,16 +19574,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-transaction?limit=25" + "example": "/order-return?limit=25" }, "last": { - "example": "/quote-transaction?limit=25&page=11" + "example": "/order-return?limit=25&page=11" }, "next": { - "example": "/quote-transaction?limit=25&page=4" + "example": "/order-return?limit=25&page=4" }, "prev": { - "example": "/quote-transaction?limit=25&page=2" + "example": "/order-return?limit=25&page=2" } } } @@ -17586,7 +19604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17601,11 +19619,11 @@ }, "post": { "tags": [ - "Quote Transaction" + "Order Return" ], - "summary": "Create a new Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", + "summary": "Create a new Order Return resources.", + "description": "", + "operationId": "createOrderReturn", "parameters": [ { "name": "_response", @@ -17622,33 +19640,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -17660,7 +19661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17675,7 +19676,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17691,22 +19692,32 @@ } } }, - "/search/quote-transaction": { + "/search/order-return": { "post": { "tags": [ - "Quote Transaction" + "Order Return" + ], + "summary": "Search for the Order Return resources.", + "description": "", + "operationId": "searchOrderReturn", + "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" + } + } ], - "summary": "Search for the Quote Transaction resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteTransaction", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -17716,7 +19727,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -17730,7 +19741,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17748,7 +19759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17765,19 +19776,19 @@ } } }, - "/quote-transaction/{id}": { + "/order-return/{id}": { "get": { "tags": [ - "Quote Transaction" + "Order Return" ], - "summary": "Detailed information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", + "summary": "Detailed information about a Order Return resource.", + "description": "", + "operationId": "getOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -17787,7 +19798,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -17799,7 +19810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17814,7 +19825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17831,16 +19842,16 @@ }, "delete": { "tags": [ - "Quote Transaction" + "Order Return" ], - "summary": "Delete a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", + "summary": "Delete a Order Return resource.", + "description": "", + "operationId": "deleteOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -17871,16 +19882,16 @@ }, "patch": { "tags": [ - "Quote Transaction" + "Order Return" ], - "summary": "Partially update information about a Quote Transaction resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteTransaction", + "summary": "Partially update information about a Order Return resource.", + "description": "", + "operationId": "updateOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -17898,35 +19909,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "description": "Partially update information about a Order Return resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/QuoteTransaction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -17938,7 +19932,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17953,7 +19947,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -17972,15 +19966,94 @@ } } }, - "/spatial-render-config-size": { + "/aggregate/order-return": { + "post": { + "tags": [ + "Order Return" + ], + "summary": "Aggregate for the Order Return resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderReturn", + "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 OrderReturn", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturn" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Order Return Line Item" ], - "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 Order Return Line Item resources.", "description": "", - "operationId": "getSpatialRenderConfigSizeList", + "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", @@ -18009,7 +20082,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18028,7 +20101,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } ] @@ -18042,16 +20115,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-render-config-size?limit=25" + "example": "/order-return-line-item?limit=25" }, "last": { - "example": "/spatial-render-config-size?limit=25&page=11" + "example": "/order-return-line-item?limit=25&page=11" }, "next": { - "example": "/spatial-render-config-size?limit=25&page=4" + "example": "/order-return-line-item?limit=25&page=4" }, "prev": { - "example": "/spatial-render-config-size?limit=25&page=2" + "example": "/order-return-line-item?limit=25&page=2" } } } @@ -18072,7 +20145,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18087,12 +20160,11 @@ }, "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Order Return Line Item" ], - "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 Order Return Line Item resources.", "description": "", - "operationId": "createSpatialRenderConfigSize", + "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", @@ -18109,33 +20181,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -18147,7 +20202,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18162,7 +20217,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18178,23 +20233,32 @@ } } }, - "/search/spatial-render-config-size": { + "/search/order-return-line-item": { "post": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Order Return Line Item" ], - "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 Order Return Line Item resources.", "description": "", - "operationId": "searchSpatialRenderConfigSize", + "operationId": "searchOrderReturnLineItem", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -18204,7 +20268,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -18218,7 +20282,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18236,7 +20300,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18253,20 +20317,19 @@ } } }, - "/spatial-render-config-size/{id}": { + "/order-return-line-item/{id}": { "get": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Order Return Line Item" ], - "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 Order Return Line Item resource.", "description": "", - "operationId": "getSpatialRenderConfigSize", + "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -18276,7 +20339,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -18288,7 +20351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18303,7 +20366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18320,17 +20383,16 @@ }, "delete": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Order Return Line Item" ], - "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 Order Return Line Item resource.", "description": "", - "operationId": "deleteSpatialRenderConfigSize", + "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -18361,17 +20423,16 @@ }, "patch": { "tags": [ - "Spatial Render Config Size", - "Experimental" + "Order Return Line Item" ], - "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 Order Return Line Item resource.", "description": "", - "operationId": "updateSpatialRenderConfigSize", + "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -18389,35 +20450,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Order Return Line Item resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -18429,7 +20473,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18444,7 +20488,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -18463,15 +20507,94 @@ } } }, - "/spatial-scene": { + "/aggregate/order-return-line-item": { + "post": { + "tags": [ + "Order Return Line Item" + ], + "summary": "Aggregate for the Order Return Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderReturnLineItem", + "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 OrderReturnLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-return-line-item-reason": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Order Return Line Item Reason" ], - "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 Order Return Line Item Reason resources.", "description": "", - "operationId": "getSpatialSceneList", + "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", @@ -18500,7 +20623,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18519,7 +20642,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] @@ -18533,16 +20656,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene?limit=25" + "example": "/order-return-line-item-reason?limit=25" }, "last": { - "example": "/spatial-scene?limit=25&page=11" + "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { - "example": "/spatial-scene?limit=25&page=4" + "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { - "example": "/spatial-scene?limit=25&page=2" + "example": "/order-return-line-item-reason?limit=25&page=2" } } } @@ -18563,7 +20686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18578,12 +20701,11 @@ }, "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Order Return Line Item Reason" ], - "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 Order Return Line Item Reason resources.", "description": "", - "operationId": "createSpatialScene", + "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", @@ -18600,33 +20722,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialScene" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -18638,7 +20743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18653,7 +20758,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18669,23 +20774,32 @@ } } }, - "/search/spatial-scene": { + "/search/order-return-line-item-reason": { "post": { "tags": [ - "Spatial Scene", - "Experimental" + "Order Return Line Item Reason" ], - "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 Order Return Line Item Reason resources.", "description": "", - "operationId": "searchSpatialScene", + "operationId": "searchOrderReturnLineItemReason", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -18695,7 +20809,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -18709,7 +20823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18727,7 +20841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18744,20 +20858,19 @@ } } }, - "/spatial-scene/{id}": { + "/order-return-line-item-reason/{id}": { "get": { "tags": [ - "Spatial Scene", - "Experimental" + "Order Return Line Item Reason" ], - "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 Order Return Line Item Reason resource.", "description": "", - "operationId": "getSpatialScene", + "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -18767,7 +20880,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -18779,7 +20892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18794,7 +20907,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18811,17 +20924,16 @@ }, "delete": { "tags": [ - "Spatial Scene", - "Experimental" + "Order Return Line Item Reason" ], - "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 Order Return Line Item Reason resource.", "description": "", - "operationId": "deleteSpatialScene", + "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -18852,17 +20964,16 @@ }, "patch": { "tags": [ - "Spatial Scene", - "Experimental" + "Order Return Line Item Reason" ], - "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 Order Return Line Item Reason resource.", "description": "", - "operationId": "updateSpatialScene", + "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -18880,35 +20991,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialScene" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -18920,7 +21014,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18935,7 +21029,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -18954,15 +21048,94 @@ } } }, - "/spatial-scene-camera": { + "/aggregate/order-return-line-item-reason": { + "post": { + "tags": [ + "Order Return Line Item Reason" + ], + "summary": "Aggregate for the Order Return Line Item Reason resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderReturnLineItemReason", + "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 OrderReturnLineItemReason", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/order-warehouse-group": { "get": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Order Warehouse Group" ], - "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 Order Warehouse Group resources.", "description": "", - "operationId": "getSpatialSceneCameraList", + "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", @@ -18991,7 +21164,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19010,7 +21183,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] @@ -19024,16 +21197,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/order-warehouse-group?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/order-warehouse-group?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/order-warehouse-group?limit=25&page=2" } } } @@ -19054,7 +21227,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19069,12 +21242,11 @@ }, "post": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Order Warehouse Group" ], - "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 Order Warehouse Group resources.", "description": "", - "operationId": "createSpatialSceneCamera", + "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", @@ -19091,33 +21263,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -19129,7 +21284,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19144,7 +21299,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19160,23 +21315,32 @@ } } }, - "/search/spatial-scene-camera": { + "/search/order-warehouse-group": { "post": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Order Warehouse Group" ], - "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 Order Warehouse Group resources.", "description": "", - "operationId": "searchSpatialSceneCamera", + "operationId": "searchOrderWarehouseGroup", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -19186,7 +21350,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -19200,7 +21364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19218,7 +21382,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19235,20 +21399,19 @@ } } }, - "/spatial-scene-camera/{id}": { + "/order-warehouse-group/{id}": { "get": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Order Warehouse Group" ], - "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 Order Warehouse Group resource.", "description": "", - "operationId": "getSpatialSceneCamera", + "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -19258,7 +21421,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -19270,7 +21433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19285,7 +21448,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19302,17 +21465,16 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Order Warehouse Group" ], - "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 Order Warehouse Group resource.", "description": "", - "operationId": "deleteSpatialSceneCamera", + "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -19343,17 +21505,16 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", - "Experimental" + "Order Warehouse Group" ], - "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 Order Warehouse Group resource.", "description": "", - "operationId": "updateSpatialSceneCamera", + "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -19371,35 +21532,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Order Warehouse Group resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -19411,7 +21555,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19426,7 +21570,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -19445,15 +21589,94 @@ } } }, - "/spatial-scene-light": { + "/aggregate/order-warehouse-group": { + "post": { + "tags": [ + "Order Warehouse Group" + ], + "summary": "Aggregate for the Order Warehouse Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateOrderWarehouseGroup", + "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 OrderWarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-review-summary": { "get": { "tags": [ - "Spatial Scene Light", - "Experimental" + "Product Review Summary" ], - "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 Product Review Summary resources.", "description": "", - "operationId": "getSpatialSceneLightList", + "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", @@ -19482,7 +21705,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19501,7 +21724,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } ] @@ -19515,16 +21738,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/product-review-summary?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/product-review-summary?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/product-review-summary?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/product-review-summary?limit=25&page=2" } } } @@ -19545,7 +21768,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19560,12 +21783,11 @@ }, "post": { "tags": [ - "Spatial Scene Light", - "Experimental" + "Product Review Summary" ], - "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 Product Review Summary resources.", "description": "", - "operationId": "createSpatialSceneLight", + "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", @@ -19582,33 +21804,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialSceneLight" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -19620,7 +21825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19635,7 +21840,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19651,23 +21856,32 @@ } } }, - "/search/spatial-scene-light": { + "/search/product-review-summary": { "post": { "tags": [ - "Spatial Scene Light", - "Experimental" + "Product Review Summary" ], - "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 Product Review Summary resources.", "description": "", - "operationId": "searchSpatialSceneLight", + "operationId": "searchProductReviewSummary", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -19677,7 +21891,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -19691,7 +21905,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19709,7 +21923,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19726,20 +21940,19 @@ } } }, - "/spatial-scene-light/{id}": { + "/product-review-summary/{id}": { "get": { "tags": [ - "Spatial Scene Light", - "Experimental" + "Product Review Summary" ], - "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 Product Review Summary resource.", "description": "", - "operationId": "getSpatialSceneLight", + "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -19749,7 +21962,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -19761,7 +21974,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19776,7 +21989,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19793,17 +22006,16 @@ }, "delete": { "tags": [ - "Spatial Scene Light", - "Experimental" + "Product Review Summary" ], - "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 Product Review Summary resource.", "description": "", - "operationId": "deleteSpatialSceneLight", + "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -19834,17 +22046,16 @@ }, "patch": { "tags": [ - "Spatial Scene Light", - "Experimental" + "Product Review Summary" ], - "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 Product Review Summary resource.", "description": "", - "operationId": "updateSpatialSceneLight", + "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -19862,35 +22073,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Product Review Summary resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialSceneLight" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -19902,7 +22096,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19917,7 +22111,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -19936,15 +22130,94 @@ } } }, - "/spatial-scene-object": { + "/aggregate/product-review-summary": { + "post": { + "tags": [ + "Product Review Summary" + ], + "summary": "Aggregate for the Product Review Summary resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductReviewSummary", + "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 ProductReviewSummary", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReviewSummary" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-warehouse": { "get": { "tags": [ - "Spatial Scene Object", - "Experimental" + "Product Warehouse" ], - "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 Product Warehouse resources.", "description": "", - "operationId": "getSpatialSceneObjectList", + "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", @@ -19973,7 +22246,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19992,7 +22265,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } ] @@ -20006,16 +22279,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-object?limit=25" + "example": "/product-warehouse?limit=25" }, "last": { - "example": "/spatial-scene-object?limit=25&page=11" + "example": "/product-warehouse?limit=25&page=11" }, "next": { - "example": "/spatial-scene-object?limit=25&page=4" + "example": "/product-warehouse?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-object?limit=25&page=2" + "example": "/product-warehouse?limit=25&page=2" } } } @@ -20036,7 +22309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20051,12 +22324,11 @@ }, "post": { "tags": [ - "Spatial Scene Object", - "Experimental" + "Product Warehouse" ], - "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 Product Warehouse resources.", "description": "", - "operationId": "createSpatialSceneObject", + "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", @@ -20073,33 +22345,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialSceneObject" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -20111,7 +22366,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20126,7 +22381,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20142,23 +22397,32 @@ } } }, - "/search/spatial-scene-object": { + "/search/product-warehouse": { "post": { "tags": [ - "Spatial Scene Object", - "Experimental" + "Product Warehouse" ], - "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 Product Warehouse resources.", "description": "", - "operationId": "searchSpatialSceneObject", + "operationId": "searchProductWarehouse", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -20168,7 +22432,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -20182,7 +22446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20200,7 +22464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20217,20 +22481,19 @@ } } }, - "/spatial-scene-object/{id}": { + "/product-warehouse/{id}": { "get": { "tags": [ - "Spatial Scene Object", - "Experimental" + "Product Warehouse" ], - "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 Product Warehouse resource.", "description": "", - "operationId": "getSpatialSceneObject", + "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -20240,7 +22503,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -20252,7 +22515,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20267,7 +22530,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20284,17 +22547,16 @@ }, "delete": { "tags": [ - "Spatial Scene Object", - "Experimental" + "Product Warehouse" ], - "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 Product Warehouse resource.", "description": "", - "operationId": "deleteSpatialSceneObject", + "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -20325,17 +22587,16 @@ }, "patch": { "tags": [ - "Spatial Scene Object", - "Experimental" + "Product Warehouse" ], - "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 Product Warehouse resource.", "description": "", - "operationId": "updateSpatialSceneObject", + "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -20353,35 +22614,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Product Warehouse resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SpatialSceneObject" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -20393,7 +22637,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20408,7 +22652,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -20427,15 +22671,94 @@ } } }, - "/sso-provider": { + "/aggregate/product-warehouse": { + "post": { + "tags": [ + "Product Warehouse" + ], + "summary": "Aggregate for the Product Warehouse resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateProductWarehouse", + "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 ProductWarehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote": { "get": { "tags": [ - "Sso Provider", - "Experimental" + "Quote" ], - "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": "getSsoProviderList", + "summary": "List with basic information of Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteList", "parameters": [ { "name": "limit", @@ -20464,7 +22787,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20483,7 +22806,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } ] @@ -20497,16 +22820,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider?limit=25" + "example": "/quote?limit=25" }, "last": { - "example": "/sso-provider?limit=25&page=11" + "example": "/quote?limit=25&page=11" }, "next": { - "example": "/sso-provider?limit=25&page=4" + "example": "/quote?limit=25&page=4" }, "prev": { - "example": "/sso-provider?limit=25&page=2" + "example": "/quote?limit=25&page=2" } } } @@ -20527,7 +22850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20542,12 +22865,11 @@ }, "post": { "tags": [ - "Sso Provider", - "Experimental" + "Quote" ], - "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": "createSsoProvider", + "summary": "Create a new Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuote", "parameters": [ { "name": "_response", @@ -20564,33 +22886,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SsoProvider" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -20602,7 +22907,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20617,7 +22922,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20633,23 +22938,32 @@ } } }, - "/search/sso-provider": { + "/search/quote": { "post": { "tags": [ - "Sso Provider", - "Experimental" + "Quote" + ], + "summary": "Search for the Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuote", + "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" + } + } ], - "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": "searchSsoProvider", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -20659,7 +22973,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -20673,7 +22987,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20691,7 +23005,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20708,20 +23022,19 @@ } } }, - "/sso-provider/{id}": { + "/quote/{id}": { "get": { "tags": [ - "Sso Provider", - "Experimental" + "Quote" ], - "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": "getSsoProvider", + "summary": "Detailed information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -20731,7 +23044,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -20743,7 +23056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20758,7 +23071,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20775,17 +23088,16 @@ }, "delete": { "tags": [ - "Sso Provider", - "Experimental" + "Quote" ], - "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": "deleteSsoProvider", + "summary": "Delete a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -20816,17 +23128,16 @@ }, "patch": { "tags": [ - "Sso Provider", - "Experimental" + "Quote" ], - "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": "updateSsoProvider", + "summary": "Partially update information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -20844,35 +23155,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Quote resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SsoProvider" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -20884,7 +23178,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20899,7 +23193,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/Quote" } } } @@ -20918,15 +23212,94 @@ } } }, - "/sso-provider-customer": { + "/aggregate/quote": { + "post": { + "tags": [ + "Quote" + ], + "summary": "Aggregate for the Quote resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuote", + "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 Quote", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-comment": { "get": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Quote Comment" ], - "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 Quote Comment resources.", "description": "", - "operationId": "getSsoProviderCustomerList", + "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", @@ -20955,7 +23328,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20974,7 +23347,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } ] @@ -20988,16 +23361,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/quote-comment?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/quote-comment?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/quote-comment?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/quote-comment?limit=25&page=2" } } } @@ -21018,7 +23391,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21033,12 +23406,11 @@ }, "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Quote Comment" ], - "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 Quote Comment resources.", "description": "", - "operationId": "createSsoProviderCustomer", + "operationId": "createQuoteComment", "parameters": [ { "name": "_response", @@ -21055,33 +23427,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -21093,7 +23448,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21108,7 +23463,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21124,23 +23479,32 @@ } } }, - "/search/sso-provider-customer": { + "/search/quote-comment": { "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Quote Comment" ], - "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 Quote Comment resources.", "description": "", - "operationId": "searchSsoProviderCustomer", + "operationId": "searchQuoteComment", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -21150,7 +23514,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -21164,7 +23528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21182,7 +23546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21199,20 +23563,19 @@ } } }, - "/sso-provider-customer/{id}": { + "/quote-comment/{id}": { "get": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Quote Comment" ], - "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 Quote Comment resource.", "description": "", - "operationId": "getSsoProviderCustomer", + "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -21222,7 +23585,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -21234,7 +23597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21249,7 +23612,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21266,17 +23629,16 @@ }, "delete": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Quote Comment" ], - "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 Quote Comment resource.", "description": "", - "operationId": "deleteSsoProviderCustomer", + "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -21307,17 +23669,16 @@ }, "patch": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Quote Comment" ], - "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 Quote Comment resource.", "description": "", - "operationId": "updateSsoProviderCustomer", + "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -21335,35 +23696,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider Customer resource.", + "description": "Partially update information about a Quote Comment resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -21375,7 +23719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21390,7 +23734,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -21409,14 +23753,94 @@ } } }, - "/subscription": { + "/aggregate/quote-comment": { + "post": { + "tags": [ + "Quote Comment" + ], + "summary": "Aggregate for the Quote Comment resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteComment", + "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 QuoteComment", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteComment" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery": { "get": { "tags": [ - "Subscription" + "Quote Delivery" ], - "summary": "List with basic information of Subscription resources.", - "description": "", - "operationId": "getSubscriptionList", + "summary": "List with basic information of Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", @@ -21445,7 +23869,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21464,7 +23888,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } ] @@ -21478,16 +23902,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/quote-delivery?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/quote-delivery?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/quote-delivery?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/quote-delivery?limit=25&page=2" } } } @@ -21508,7 +23932,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21523,11 +23947,11 @@ }, "post": { "tags": [ - "Subscription" + "Quote Delivery" ], - "summary": "Create a new Subscription resources.", - "description": "", - "operationId": "createSubscription", + "summary": "Create a new Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", @@ -21544,33 +23968,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Subscription" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -21582,7 +23989,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21597,7 +24004,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21613,22 +24020,32 @@ } } }, - "/search/subscription": { + "/search/quote-delivery": { "post": { "tags": [ - "Subscription" + "Quote Delivery" + ], + "summary": "Search for the Quote Delivery resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDelivery", + "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" + } + } ], - "summary": "Search for the Subscription resources.", - "description": "", - "operationId": "searchSubscription", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -21638,7 +24055,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -21652,7 +24069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21670,7 +24087,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21687,19 +24104,19 @@ } } }, - "/subscription/{id}": { + "/quote-delivery/{id}": { "get": { "tags": [ - "Subscription" + "Quote Delivery" ], - "summary": "Detailed information about a Subscription resource.", - "description": "", - "operationId": "getSubscription", + "summary": "Detailed information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -21709,7 +24126,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -21721,7 +24138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21736,7 +24153,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21753,16 +24170,16 @@ }, "delete": { "tags": [ - "Subscription" + "Quote Delivery" ], - "summary": "Delete a Subscription resource.", - "description": "", - "operationId": "deleteSubscription", + "summary": "Delete a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -21793,16 +24210,16 @@ }, "patch": { "tags": [ - "Subscription" + "Quote Delivery" ], - "summary": "Partially update information about a Subscription resource.", - "description": "", - "operationId": "updateSubscription", + "summary": "Partially update information about a Quote Delivery resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -21820,35 +24237,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription resource.", + "description": "Partially update information about a Quote Delivery resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Subscription" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -21860,7 +24260,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21875,7 +24275,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -21894,14 +24294,94 @@ } } }, - "/subscription-address": { + "/aggregate/quote-delivery": { + "post": { + "tags": [ + "Quote Delivery" + ], + "summary": "Aggregate for the Quote Delivery resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteDelivery", + "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 QuoteDelivery", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDelivery" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-delivery-position": { "get": { "tags": [ - "Subscription Address" + "Quote Delivery Position" ], - "summary": "List with basic information of Subscription Address resources.", - "description": "", - "operationId": "getSubscriptionAddressList", + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", "parameters": [ { "name": "limit", @@ -21930,7 +24410,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21949,7 +24429,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } ] @@ -21963,16 +24443,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/quote-delivery-position?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/quote-delivery-position?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/quote-delivery-position?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/quote-delivery-position?limit=25&page=2" } } } @@ -21993,7 +24473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22008,11 +24488,11 @@ }, "post": { "tags": [ - "Subscription Address" + "Quote Delivery Position" ], - "summary": "Create a new Subscription Address resources.", - "description": "", - "operationId": "createSubscriptionAddress", + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", "parameters": [ { "name": "_response", @@ -22029,33 +24509,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -22067,7 +24530,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22082,7 +24545,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22098,22 +24561,32 @@ } } }, - "/search/subscription-address": { + "/search/quote-delivery-position": { "post": { "tags": [ - "Subscription Address" + "Quote Delivery Position" + ], + "summary": "Search for the Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDeliveryPosition", + "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" + } + } ], - "summary": "Search for the Subscription Address resources.", - "description": "", - "operationId": "searchSubscriptionAddress", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -22123,7 +24596,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -22137,7 +24610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22155,7 +24628,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22172,19 +24645,19 @@ } } }, - "/subscription-address/{id}": { + "/quote-delivery-position/{id}": { "get": { "tags": [ - "Subscription Address" + "Quote Delivery Position" ], - "summary": "Detailed information about a Subscription Address resource.", - "description": "", - "operationId": "getSubscriptionAddress", + "summary": "Detailed information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -22194,7 +24667,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -22206,7 +24679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22221,7 +24694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22238,16 +24711,16 @@ }, "delete": { "tags": [ - "Subscription Address" + "Quote Delivery Position" ], - "summary": "Delete a Subscription Address resource.", - "description": "", - "operationId": "deleteSubscriptionAddress", + "summary": "Delete a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -22278,16 +24751,16 @@ }, "patch": { "tags": [ - "Subscription Address" + "Quote Delivery Position" ], - "summary": "Partially update information about a Subscription Address resource.", - "description": "", - "operationId": "updateSubscriptionAddress", + "summary": "Partially update information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -22305,35 +24778,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Address resource.", + "description": "Partially update information about a Quote Delivery Position resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionAddress" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -22345,7 +24801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22360,7 +24816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -22379,14 +24835,94 @@ } } }, - "/subscription-customer": { + "/aggregate/quote-delivery-position": { + "post": { + "tags": [ + "Quote Delivery Position" + ], + "summary": "Aggregate for the Quote Delivery Position resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteDeliveryPosition", + "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 QuoteDeliveryPosition", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-document": { "get": { "tags": [ - "Subscription Customer" + "Quote Document" ], - "summary": "List with basic information of Subscription Customer resources.", + "summary": "List with basic information of Quote Document resources.", "description": "", - "operationId": "getSubscriptionCustomerList", + "operationId": "getQuoteDocumentList", "parameters": [ { "name": "limit", @@ -22415,7 +24951,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22434,7 +24970,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } ] @@ -22448,16 +24984,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/quote-document?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/quote-document?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/quote-document?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/quote-document?limit=25&page=2" } } } @@ -22478,7 +25014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22493,11 +25029,11 @@ }, "post": { "tags": [ - "Subscription Customer" + "Quote Document" ], - "summary": "Create a new Subscription Customer resources.", + "summary": "Create a new Quote Document resources.", "description": "", - "operationId": "createSubscriptionCustomer", + "operationId": "createQuoteDocument", "parameters": [ { "name": "_response", @@ -22514,33 +25050,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -22552,7 +25071,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22567,7 +25086,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22583,22 +25102,32 @@ } } }, - "/search/subscription-customer": { + "/search/quote-document": { "post": { "tags": [ - "Subscription Customer" + "Quote Document" ], - "summary": "Search for the Subscription Customer resources.", + "summary": "Search for the Quote Document resources.", "description": "", - "operationId": "searchSubscriptionCustomer", + "operationId": "searchQuoteDocument", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -22608,7 +25137,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -22622,7 +25151,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22640,7 +25169,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22657,19 +25186,19 @@ } } }, - "/subscription-customer/{id}": { + "/quote-document/{id}": { "get": { "tags": [ - "Subscription Customer" + "Quote Document" ], - "summary": "Detailed information about a Subscription Customer resource.", + "summary": "Detailed information about a Quote Document resource.", "description": "", - "operationId": "getSubscriptionCustomer", + "operationId": "getQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -22679,7 +25208,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -22691,7 +25220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22706,7 +25235,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22723,16 +25252,16 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Quote Document" ], - "summary": "Delete a Subscription Customer resource.", + "summary": "Delete a Quote Document resource.", "description": "", - "operationId": "deleteSubscriptionCustomer", + "operationId": "deleteQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -22763,16 +25292,16 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Quote Document" ], - "summary": "Partially update information about a Subscription Customer resource.", + "summary": "Partially update information about a Quote Document resource.", "description": "", - "operationId": "updateSubscriptionCustomer", + "operationId": "updateQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -22790,35 +25319,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Customer resource.", + "description": "Partially update information about a Quote Document resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -22830,7 +25342,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22845,7 +25357,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -22864,14 +25376,94 @@ } } }, - "/subscription-interval": { + "/aggregate/quote-document": { + "post": { + "tags": [ + "Quote Document" + ], + "summary": "Aggregate for the Quote Document resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteDocument", + "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 QuoteDocument", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDocument" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-employee": { "get": { "tags": [ - "Subscription Interval" + "Quote Employee" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Quote Employee resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getQuoteEmployeeList", "parameters": [ { "name": "limit", @@ -22900,7 +25492,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22919,7 +25511,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } ] @@ -22933,16 +25525,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/quote-employee?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/quote-employee?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/quote-employee?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/quote-employee?limit=25&page=2" } } } @@ -22963,7 +25555,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -22978,11 +25570,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Quote Employee" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Quote Employee resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createQuoteEmployee", "parameters": [ { "name": "_response", @@ -22999,33 +25591,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionInterval" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -23037,7 +25612,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23052,7 +25627,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23068,22 +25643,32 @@ } } }, - "/search/subscription-interval": { + "/search/quote-employee": { "post": { "tags": [ - "Subscription Interval" + "Quote Employee" ], - "summary": "Search for the Subscription Interval resources.", + "summary": "Search for the Quote Employee resources.", "description": "", - "operationId": "searchSubscriptionInterval", + "operationId": "searchQuoteEmployee", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -23093,7 +25678,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -23107,7 +25692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23125,7 +25710,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23142,19 +25727,19 @@ } } }, - "/subscription-interval/{id}": { + "/quote-employee/{id}": { "get": { "tags": [ - "Subscription Interval" + "Quote Employee" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Quote Employee resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -23164,7 +25749,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -23176,7 +25761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23191,7 +25776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23208,16 +25793,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Quote Employee" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Quote Employee resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -23248,16 +25833,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Quote Employee" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Quote Employee resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -23275,35 +25860,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Interval resource.", + "description": "Partially update information about a Quote Employee resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionInterval" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -23315,7 +25883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23330,7 +25898,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -23349,14 +25917,94 @@ } } }, - "/subscription-plan": { + "/aggregate/quote-employee": { + "post": { + "tags": [ + "Quote Employee" + ], + "summary": "Aggregate for the Quote Employee resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteEmployee", + "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 QuoteEmployee", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteEmployee" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-line-item": { "get": { "tags": [ - "Subscription Plan" + "Quote Line Item" ], - "summary": "List with basic information of Subscription Plan resources.", - "description": "", - "operationId": "getSubscriptionPlanList", + "summary": "List with basic information of Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItemList", "parameters": [ { "name": "limit", @@ -23385,7 +26033,7 @@ ], "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23404,7 +26052,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } ] @@ -23418,16 +26066,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-plan?limit=25" + "example": "/quote-line-item?limit=25" }, "last": { - "example": "/subscription-plan?limit=25&page=11" + "example": "/quote-line-item?limit=25&page=11" }, "next": { - "example": "/subscription-plan?limit=25&page=4" + "example": "/quote-line-item?limit=25&page=4" }, "prev": { - "example": "/subscription-plan?limit=25&page=2" + "example": "/quote-line-item?limit=25&page=2" } } } @@ -23448,7 +26096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23463,11 +26111,11 @@ }, "post": { "tags": [ - "Subscription Plan" + "Quote Line Item" ], - "summary": "Create a new Subscription Plan resources.", - "description": "", - "operationId": "createSubscriptionPlan", + "summary": "Create a new Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteLineItem", "parameters": [ { "name": "_response", @@ -23484,33 +26132,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -23522,7 +26153,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23537,7 +26168,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23553,22 +26184,32 @@ } } }, - "/search/subscription-plan": { + "/search/quote-line-item": { "post": { "tags": [ - "Subscription Plan" + "Quote Line Item" + ], + "summary": "Search for the Quote Line Item resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteLineItem", + "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" + } + } ], - "summary": "Search for the Subscription Plan resources.", - "description": "", - "operationId": "searchSubscriptionPlan", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -23578,7 +26219,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -23592,7 +26233,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23610,7 +26251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23627,19 +26268,19 @@ } } }, - "/subscription-plan/{id}": { + "/quote-line-item/{id}": { "get": { "tags": [ - "Subscription Plan" + "Quote Line Item" ], - "summary": "Detailed information about a Subscription Plan resource.", - "description": "", - "operationId": "getSubscriptionPlan", + "summary": "Detailed information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -23649,7 +26290,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -23661,7 +26302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23676,7 +26317,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23693,16 +26334,16 @@ }, "delete": { "tags": [ - "Subscription Plan" + "Quote Line Item" ], - "summary": "Delete a Subscription Plan resource.", - "description": "", - "operationId": "deleteSubscriptionPlan", + "summary": "Delete a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -23733,16 +26374,16 @@ }, "patch": { "tags": [ - "Subscription Plan" + "Quote Line Item" ], - "summary": "Partially update information about a Subscription Plan resource.", - "description": "", - "operationId": "updateSubscriptionPlan", + "summary": "Partially update information about a Quote Line Item resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -23760,35 +26401,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "description": "Partially update information about a Quote Line Item resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SubscriptionPlan" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -23800,7 +26424,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23815,7 +26439,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -23834,14 +26458,94 @@ } } }, - "/swag-delay-action": { + "/aggregate/quote-line-item": { + "post": { + "tags": [ + "Quote Line Item" + ], + "summary": "Aggregate for the Quote Line Item resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteLineItem", + "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 QuoteLineItem", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteLineItem" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/quote-transaction": { "get": { "tags": [ - "Swag Delay Action" + "Quote Transaction" ], - "summary": "List with basic information of Swag Delay Action resources.", - "description": "", - "operationId": "getSwagDelayActionList", + "summary": "List with basic information of Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", "parameters": [ { "name": "limit", @@ -23870,7 +26574,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23889,7 +26593,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } ] @@ -23903,16 +26607,16 @@ "type": "object", "properties": { "first": { - "example": "/swag-delay-action?limit=25" + "example": "/quote-transaction?limit=25" }, "last": { - "example": "/swag-delay-action?limit=25&page=11" + "example": "/quote-transaction?limit=25&page=11" }, "next": { - "example": "/swag-delay-action?limit=25&page=4" + "example": "/quote-transaction?limit=25&page=4" }, "prev": { - "example": "/swag-delay-action?limit=25&page=2" + "example": "/quote-transaction?limit=25&page=2" } } } @@ -23933,7 +26637,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -23948,11 +26652,11 @@ }, "post": { "tags": [ - "Swag Delay Action" + "Quote Transaction" ], - "summary": "Create a new Swag Delay Action resources.", - "description": "", - "operationId": "createSwagDelayAction", + "summary": "Create a new Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", "parameters": [ { "name": "_response", @@ -23969,33 +26673,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagDelayAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -24007,7 +26694,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24022,7 +26709,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24038,22 +26725,32 @@ } } }, - "/search/swag-delay-action": { + "/search/quote-transaction": { "post": { "tags": [ - "Swag Delay Action" + "Quote Transaction" + ], + "summary": "Search for the Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteTransaction", + "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" + } + } ], - "summary": "Search for the Swag Delay Action resources.", - "description": "", - "operationId": "searchSwagDelayAction", "requestBody": { "required": true, "content": { - "application/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -24063,7 +26760,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -24077,7 +26774,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24095,7 +26792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24112,19 +26809,19 @@ } } }, - "/swag-delay-action/{id}": { + "/quote-transaction/{id}": { "get": { "tags": [ - "Swag Delay Action" + "Quote Transaction" ], - "summary": "Detailed information about a Swag Delay Action resource.", - "description": "", - "operationId": "getSwagDelayAction", + "summary": "Detailed information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -24134,7 +26831,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -24146,7 +26843,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24161,7 +26858,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24178,16 +26875,16 @@ }, "delete": { "tags": [ - "Swag Delay Action" + "Quote Transaction" ], - "summary": "Delete a Swag Delay Action resource.", - "description": "", - "operationId": "deleteSwagDelayAction", + "summary": "Delete a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -24218,16 +26915,16 @@ }, "patch": { "tags": [ - "Swag Delay Action" + "Quote Transaction" ], - "summary": "Partially update information about a Swag Delay Action resource.", - "description": "", - "operationId": "updateSwagDelayAction", + "summary": "Partially update information about a Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the swag_delay_action", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -24245,35 +26942,18 @@ } ], "requestBody": { - "description": "Partially update information about a Swag Delay Action resource.", + "description": "Partially update information about a Quote Transaction resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/SwagDelayAction" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -24285,7 +26965,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24300,7 +26980,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -24319,14 +26999,95 @@ } } }, - "/warehouse": { + "/aggregate/quote-transaction": { + "post": { + "tags": [ + "Quote Transaction" + ], + "summary": "Aggregate for the Quote Transaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteTransaction", + "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 QuoteTransaction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteTransaction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-render-config-size": { "get": { "tags": [ - "Warehouse" + "Spatial Render Config Size", + "Experimental" ], - "summary": "List with basic information of Warehouse resources.", + "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": "getWarehouseList", + "operationId": "getSpatialRenderConfigSizeList", "parameters": [ { "name": "limit", @@ -24355,7 +27116,7 @@ ], "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24374,7 +27135,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -24388,16 +27149,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/warehouse?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/warehouse?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/warehouse?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -24418,7 +27179,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24433,11 +27194,12 @@ }, "post": { "tags": [ - "Warehouse" + "Spatial Render Config Size", + "Experimental" ], - "summary": "Create a new Warehouse resources.", + "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": "createWarehouse", + "operationId": "createSpatialRenderConfigSize", "parameters": [ { "name": "_response", @@ -24454,33 +27216,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Warehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -24492,7 +27237,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24507,7 +27252,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24523,22 +27268,33 @@ } } }, - "/search/warehouse": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Warehouse" + "Spatial Render Config Size", + "Experimental" ], - "summary": "Search for the Warehouse resources.", + "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": "searchWarehouse", + "operationId": "searchSpatialRenderConfigSize", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -24548,7 +27304,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -24562,7 +27318,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24580,7 +27336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24597,19 +27353,20 @@ } } }, - "/warehouse/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Warehouse" + "Spatial Render Config Size", + "Experimental" ], - "summary": "Detailed information about a Warehouse resource.", + "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": "getWarehouse", + "operationId": "getSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -24619,7 +27376,7 @@ ], "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -24631,7 +27388,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24646,7 +27403,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24663,16 +27420,17 @@ }, "delete": { "tags": [ - "Warehouse" + "Spatial Render Config Size", + "Experimental" ], - "summary": "Delete a Warehouse resource.", + "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": "deleteWarehouse", + "operationId": "deleteSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -24703,16 +27461,17 @@ }, "patch": { "tags": [ - "Warehouse" + "Spatial Render Config Size", + "Experimental" ], - "summary": "Partially update information about a Warehouse resource.", + "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": "updateWarehouse", + "operationId": "updateSpatialRenderConfigSize", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -24730,35 +27489,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/Warehouse" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -24770,7 +27512,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24785,7 +27527,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -24804,14 +27546,96 @@ } } }, - "/warehouse-group": { + "/aggregate/spatial-render-config-size": { + "post": { + "tags": [ + "Spatial Render Config Size", + "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.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialRenderConfigSize", + "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 SpatialRenderConfigSize", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialRenderConfigSize" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene": { "get": { "tags": [ - "Warehouse Group" + "Spatial Scene", + "Experimental" ], - "summary": "List with basic information of Warehouse Group resources.", + "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": "getWarehouseGroupList", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -24840,7 +27664,7 @@ ], "responses": { "200": { - "description": "List of Warehouse Group resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24859,7 +27683,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -24873,16 +27697,16 @@ "type": "object", "properties": { "first": { - "example": "/warehouse-group?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/warehouse-group?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/warehouse-group?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/warehouse-group?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -24903,7 +27727,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24918,11 +27742,12 @@ }, "post": { "tags": [ - "Warehouse Group" + "Spatial Scene", + "Experimental" ], - "summary": "Create a new Warehouse Group resources.", + "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": "createWarehouseGroup", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -24939,33 +27764,16 @@ ], "requestBody": { "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -24977,7 +27785,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -24992,7 +27800,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25008,22 +27816,33 @@ } } }, - "/search/warehouse-group": { + "/search/spatial-scene": { "post": { "tags": [ - "Warehouse Group" + "Spatial Scene", + "Experimental" ], - "summary": "Search for the Warehouse Group resources.", + "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": "searchWarehouseGroup", + "operationId": "searchSpatialScene", + "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/vnd.api+json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - }, "application/json": { "schema": { "$ref": "#/components/schemas/Criteria" @@ -25033,7 +27852,7 @@ }, "responses": { "200": { - "description": "List of WarehouseGroup", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -25047,7 +27866,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25065,7 +27884,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25082,19 +27901,20 @@ } } }, - "/warehouse-group/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Warehouse Group" + "Spatial Scene", + "Experimental" ], - "summary": "Detailed information about a Warehouse Group resource.", + "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": "getWarehouseGroup", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -25104,7 +27924,7 @@ ], "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -25116,7 +27936,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25131,7 +27951,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25148,16 +27968,17 @@ }, "delete": { "tags": [ - "Warehouse Group" + "Spatial Scene", + "Experimental" ], - "summary": "Delete a Warehouse Group resource.", + "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": "deleteWarehouseGroup", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -25188,16 +28009,17 @@ }, "patch": { "tags": [ - "Warehouse Group" + "Spatial Scene", + "Experimental" ], - "summary": "Partially update information about a Warehouse Group resource.", + "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": "updateWarehouseGroup", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the warehouse_group", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -25215,35 +28037,18 @@ } ], "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { - "application/vnd.api+json": { - "schema": { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" - }, - "included": { - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true - } - } - } - }, "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -25255,7 +28060,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25270,7 +28075,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -25289,287 +28094,375 @@ } } }, - "/_action/custom-price": { + "/aggregate/spatial-scene": { "post": { "tags": [ - "Bulk Operations" + "Spatial Scene", + "Experimental" ], - "summary": "Bulk edit custom prices", - "description": "An emulation of Sync API implementation", - "operationId": "customPriceImport", + "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": { "application/json": { "schema": { - "type": "array", - "items": { - "oneOf": [ + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } + } + }, + "responses": { + "200": { + "description": "List of SpatialScene", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ { - "$ref": "#/components/schemas/CustomPricingUpsertOperation" + "$ref": "#/components/schemas/success" }, { - "$ref": "#/components/schemas/CustomPricingDeleteOperation" + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } } ] } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScene" + } + } + } + } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, + } + } + }, + "/spatial-scene-camera": { + "get": { + "tags": [ + "Spatial Scene Camera", + "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.", + "description": "", + "operationId": "getSpatialSceneCameraList", + "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": "Returns a JSON result containing information about the updated entities", + "description": "List of Spatial Scene Camera 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/SpatialSceneCamera" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-camera?limit=25" + }, + "last": { + "example": "/spatial-scene-camera?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-camera?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-camera?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/CustomPricingResponse" + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } } } } + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/api/_admin/rule-builder-preview/{orderId}": { + }, "post": { "tags": [ - "Rule Preview" + "Spatial Scene Camera", + "Experimental" ], - "summary": "Preview results of a rule evaluating an order", - "description": "Evaluate the conditions of a rule based on a pre-selected order.", - "operationId": "rulePreview", + "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": "createSpatialSceneCamera", "parameters": [ { - "name": "orderId", - "in": "path", - "description": "Identifier of the order the preview should be generated for", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", "schema": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "basic", + "detail" + ] } } ], "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "conditions" - ], - "properties": { - "conditions": { - "description": "Array of nested rule condition payloads.", - "items": { - "type": "object" - }, - "type": "array" - }, - "dateTime": { - "description": "A date and time to be mocked in the preview evaluation.", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Returns the results of the evaluated rule conditions as an object.", + "description": "Detail of SpatialSceneCamera", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "array", - "items": { - "properties": { - "match": { - "description": "Evaluation of the condition", - "type": "boolean" - }, - "name": { - "description": "The technical name of the condition", - "type": "string" - }, - "ruleReferenceId": { - "description": "The id of the corresponding rule_condition entity", - "type": "string" - } + "allOf": [ + { + "$ref": "#/components/schemas/success" }, - "type": "object" + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/invite-employee": { + "/search/spatial-scene-camera": { "post": { "tags": [ - "B2B Employee Management" + "Spatial Scene Camera", + "Experimental" ], - "summary": "Sends an invite email to employee", - "description": "This route is used to send an invite email to an employee", - "operationId": "inviteEmployee", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "description": "Id of the employee to invite", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "description": "Id of the sales channel through which the registration will be fulfilled.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "required": [ - "id" - ], - "type": "object" - } + "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": "searchSpatialSceneCamera", + "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" } } - }, - "responses": { - "204": { - "description": "No content response" - } - } - } - }, - "/_action/create-employee": { - "post": { - "tags": [ - "B2B Employee Management" ], - "summary": "Creates an employee", - "description": "This route is used to create an employee", - "operationId": "createEmployee", - "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { - "properties": { - "firstName": { - "description": "First name of the new employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the new employee", - "type": "string" - }, - "email": { - "description": "Email of the new employee", - "type": "string" - }, - "roleId": { - "description": "Id of the role of the new employee", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "IDs of the created employees", + "description": "List of SpatialSceneCamera", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + ] + } + }, "application/json": { "schema": { "type": "object", "properties": { + "total": { + "type": "integer" + }, "data": { - "description": "Array of the created employee ids", "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } } } } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/update-employee": { - "patch": { - "tags": [ - "B2B Employee Management" - ], - "summary": "Updates an employee", - "description": "This route is used to update an employee", - "operationId": "updateEmployee", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "properties": { - "id": { - "description": "Id of the employee", - "type": "string" - }, - "firstName": { - "description": "First name of the employee", - "type": "string" - }, - "lastName": { - "description": "Last name of the employee", - "type": "string" - }, - "email": { - "description": "Email of the employee", - "type": "string" - }, - "roleId": { - "description": "Id of the role of the employee", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "No content response" - } - } - } - }, - "/_proxy-quote/{salesChannelId}": { - "post": { + "/spatial-scene-camera/{id}": { + "get": { "tags": [ - "B2B Quote Management" + "Spatial Scene Camera", + "Experimental" ], - "summary": "Create a new quote", - "description": "This route is used to create a new quote from admin", - "operationId": "createQuoteFromAdmin", + "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": "getSpatialSceneCamera", "parameters": [ { - "name": "salesChannelId", + "name": "id", "in": "path", - "description": "Identifier of the sales channel to be fetched", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -25577,49 +28470,63 @@ } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "Quote entity", + "description": "Detail of SpatialSceneCamera", "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + ] + } + }, "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/quote/{quoteId}/product/{productId}": { - "post": { + }, + "delete": { "tags": [ - "B2B Quote Management" + "Spatial Scene Camera", + "Experimental" ], - "summary": "Add product to quote", - "description": "This route is used to add a product to a quote from admin", - "operationId": "addProductToQuote", + "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": "deleteSpatialSceneCamera", "parameters": [ { - "name": "quoteId", + "name": "id", "in": "path", - "description": "Identifier of the quote to be fetched", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -25627,201 +28534,123 @@ } }, { - "name": "productId", - "in": "path", - "description": "Identifier of the product to be fetched", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "quantity": { - "type": "integer", - "pattern": "int32" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "204": { - "description": "No content response" - } - } - } - }, - "/_action/quote/{quoteId}/lineItem": { - "post": { - "tags": [ - "B2B Quote Management" - ], - "summary": "Add custom line item to quote", - "description": "This route is used to add a custom line item to a quote from admin", - "operationId": "addCustomLineItemToQuote", - "parameters": [ - { - "name": "quoteId", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "identifier": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string", - "default": "custom" - }, - "quantity": { - "type": "integer", - "pattern": "int32" - }, - "label": { - "type": "string", - "default": "null" - }, - "description": { - "type": "string", - "default": "null" - }, - "removable": { - "type": "boolean", - "default": true - }, - "stackable": { - "type": "boolean", - "default": true - }, - "payload": { - "type": "array", - "items": { - "type": "object" - } - }, - "priceDefinition": { - "type": "array", - "items": { - "type": "object" - } - } - }, - "type": "object" - } - } - } - }, "responses": { "204": { - "description": "No content response" + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } - } - }, - "/_action/quote/{quoteId}/recalculate": { - "post": { + }, + "patch": { "tags": [ - "B2B Quote Management" + "Spatial Scene Camera", + "Experimental" ], - "summary": "Recalculate a quote", - "description": "This route is used to recalculate a quote", - "operationId": "recalculateQuote", + "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": "updateSpatialSceneCamera", "parameters": [ { - "name": "quoteId", + "name": "id", "in": "path", - "description": "Identifier of the quote to be fetched", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - } - ], - "responses": { - "204": { - "description": "No content response" - } - } - } - }, - "/_action/quote/{quoteId}/comment": { - "post": { - "tags": [ - "B2B Quote Management" - ], - "summary": "Create a new comment", - "description": "This route is used to create a new comment from admin", - "operationId": "createComment", - "parameters": [ + }, { - "name": "quoteId", - "in": "path", - "description": "Identifier of the quote to be fetched", - "required": true, + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], "requestBody": { - "required": true, + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/json": { "schema": { - "properties": { - "comment": { - "description": "Message content", - "type": "string" - }, - "state": { - "description": "Current quote state", - "type": "string" - } - }, - "type": "object" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { - "204": { - "description": "No content response" + "200": { + "description": "Detail of SpatialSceneCamera", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } } } }, - "/_action/text-to-image/generate": { + "/aggregate/spatial-scene-camera": { "post": { "tags": [ - "Text to Image", + "Spatial Scene Camera", "Experimental" ], - "summary": "Generate images based on a textual prompt", - "description": "Experimental until v6.7.0\n\nGenerate images based on a textual prompt", - "operationId": "textToImageGenerate", + "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": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -25829,604 +28658,17570 @@ "schema": { "type": "object", "properties": { - "description": { - "description": "The textual prompt to describe what image to generate", - "type": "string", - "example": "Generate a warm and inviting ambience with soft lightning and neutral tones" + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } } - } + }, + "required": [ + "aggregations" + ] } } } }, "responses": { "200": { - "description": "The base64 string representation of the generated image", + "description": "List of SpatialSceneCamera", "content": { - "application/json": { + "application/vnd.api+json": { "schema": { - "type": "string", - "format": "byte", - "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAJZlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgExAAIAAAARAAAAWodpAAQAAAABAAAAbAAAAAAAAABgAAAAAQAAAGAAAAABd3d3Lmlua3NjYXBlLm9yZwAAAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAABAAAAAAKwl1NwAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAi1pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+d3d3Lmlua3NjYXBlLm9yZzwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj45NjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+OTY8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgryNKKqAAAC8klEQVQ4EV1Tz0tUURg99943zpvGcWaqaRTJ7CdGvzBtkVQYFLjxD3AlZFREUZv21q4f1CLBCLR2bdoVBVmbchGUiUQU0i8oNUEsG9/MOG/uvZ07Y2B9vPu473HP+c53vvsJuOi3Ev3CuO26IbtHAH1K4EBSIlvDf0rY2aQSo63JcOh6d82EO9dvrewXwoiV4Pphe1N7OJP2gaAETBV40tE6lihXCLQAAx96xVl+wZKEyaqRHbYjtg5HUjlrJkOhoSCvrC+J1voQ62q1jXnGWAvl16WkV5p/2phdc9QhKwT1Q3bQJnEquYjiZBH+mazGufYcGpMhhLDQFGqXEymJYqw24y/8nBtMrc6cFg13bZtVeB0rQ38JoXrTGtcO/0I8alAMqwKjXhVOBZAkJKsWyleLwVI7heGEiAG+ZrUUfmpnHgl+BEsSzFYBjH/38XIqypqBbNygZW1o9m2LKVMunPCorEPRnG8GcmfMojEVolQWTELvmHliyseBZ4mqkU6IM9X68uo00LPd63AEG1GGe2SEICfagf9GZcvXhghbrGwFryHkhffAj1zdRookmMxN3I0XBOYCj32vwpfowY6GIh51BGiKWLzKC4zxzG+q2LwKmAwULxDwRZCdYZzVI599KnBaq+E60Lk1j/td83hxKIeLTSE+069PLLtk8VWw/7dkHCdNgDAhEPm4BDzZH6BzS4BCSUKTy5kXUW7RZyswsxAJn/9IRd5O69ti7bDd63kYs2yjgmWVPED2e7sLOMLMriNlLVDickTOH7ZVR/2o+pkvtcu5Y+INwQMyCVWGKPJu2mZe3Z7xGI6PpPHwXS1mc16lI7GIca0trkpk1O/FcDCTyowt21UZoscqhS69AENjdFpCvicjOBOSV+BSY2i6NhVU29Y6ufBr7mkqnVm+yismMXvH3oDEeclhMizDp9u1TDHPNeN85b8He/ID3W3x/4bpX5Jd7EYfMQcJqad3iEvMNteY0daEHrq8PM6VSeQ4/wGOAT89rW8MpwAAAABJRU5ErkJggg==" + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } + ] } - } - } - } - } - } - } - }, - "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" + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + } + } + } } - ] + } }, - "data": { - "$ref": "#/components/schemas/data" + "400": { + "$ref": "#/components/responses/400" }, - "included": { - "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": false - }, - "failure": { - "required": [ - "errors" + } + } + }, + "/spatial-scene-group": { + "get": { + "tags": [ + "Spatial Scene Group", + "Experimental" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" + "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": "getSpatialSceneGroupList", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } }, - "links": { - "$ref": "#/components/schemas/links" + { + "name": "page", + "in": "query", + "description": "The page to be returned", + "schema": { + "type": "integer" + } }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/error" - }, - "uniqueItems": true + { + "name": "query", + "in": "query", + "description": "Encoded SwagQL in JSON", + "schema": { + "type": "string" + } } - }, - "type": "object", - "additionalProperties": false - }, - "info": { - "required": [ - "meta" ], - "properties": { - "meta": { - "$ref": "#/components/schemas/meta" - }, - "links": { - "$ref": "#/components/schemas/links" + "responses": { + "200": { + "description": "List of Spatial Scene 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/SpatialSceneGroup" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-group?limit=25" + }, + "last": { + "example": "/spatial-scene-group?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-group?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-group?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + } + } + } }, - "jsonapi": { - "$ref": "#/components/schemas/jsonapi" + "401": { + "$ref": "#/components/responses/401" } - }, - "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" - }, + "post": { + "tags": [ + "Spatial Scene Group", + "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.", + "description": "", + "operationId": "createSpatialSceneGroup", + "parameters": [ { - "description": "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", - "type": "array", - "items": { - "$ref": "#/components/schemas/resource" - }, - "uniqueItems": true + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } } - ] - }, - "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" + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } } }, - "type": "object" - }, - "relationshipLinks": { - "description": "A resource object **MAY** contain references to other resource objects (\"relationships\"). Relationships may be to-one or to-many. Relationships can be specified by including a member in a resource's links object.", - "properties": { - "self": { - "allOf": [ - { - "description": "A `self` member, whose value is a URL for the relationship itself (a \"relationship URL\"). This URL allows the client to directly manipulate the relationship. For example, it would allow a client to remove an `author` from an `article` without deleting the people resource itself.", - "type": "array", - "items": { - "type": "object" + "responses": { + "200": { + "description": "Detail of SpatialSceneGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + ] } }, - { - "$ref": "#/components/schemas/link" + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } } - ] + } }, - "related": { - "$ref": "#/components/schemas/link" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": true - }, - "links": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/link" } - }, - "link": { - "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", - "oneOf": [ - { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, + } + }, + "/search/spatial-scene-group": { + "post": { + "tags": [ + "Spatial Scene Group", + "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.", + "description": "", + "operationId": "searchSpatialSceneGroup", + "parameters": [ { - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "A string containing the link's URL.", - "type": "string", - "format": "uri-reference" - }, - "meta": { - "$ref": "#/components/schemas/meta" + "name": "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" } } } - ] - }, - "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" - ] + }, + "responses": { + "200": { + "description": "List of SpatialSceneGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + } + } + } }, - { - "required": [ - "links" - ] + "400": { + "$ref": "#/components/responses/400" }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-group/{id}": { + "get": { + "tags": [ + "Spatial Scene Group", + "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.", + "description": "", + "operationId": "getSpatialSceneGroup", + "parameters": [ { - "type": "object", - "properties": { - "links": { - "$ref": "#/components/schemas/relationshipLinks" + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + ] + } }, - "data": { - "description": "Member, whose value represents \"resource linkage\".", - "oneOf": [ - { - "$ref": "#/components/schemas/relationshipToOne" - }, - { - "$ref": "#/components/schemas/relationshipToMany" + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } } - ] + } } } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" } - ], - "additionalProperties": false + } }, - "relationshipToOne": { - "allOf": [ + "delete": { + "tags": [ + "Spatial Scene Group", + "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.", + "description": "", + "operationId": "deleteSpatialSceneGroup", + "parameters": [ { - "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." + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, { - "$ref": "#/components/schemas/linkage" + "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" + } + } }, - "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" + "patch": { + "tags": [ + "Spatial Scene Group", + "Experimental" ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": "updateSpatialSceneGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_group", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, - "meta": { - "$ref": "#/components/schemas/meta" + { + "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 Spatial Scene Group resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } } }, - "type": "object", - "additionalProperties": false - }, - "pagination": { - "properties": { - "first": { - "description": "The first page of data", - "type": "string", - "format": "uri-reference" + "responses": { + "200": { + "description": "Detail of SpatialSceneGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + } + } }, - "last": { - "description": "The last page of data", - "type": "string", - "format": "uri-reference" + "400": { + "$ref": "#/components/responses/400" }, - "prev": { - "description": "The previous page of data", - "type": "string", - "format": "uri-reference" + "404": { + "$ref": "#/components/responses/404" }, - "next": { - "description": "The next page of data", - "type": "string", - "format": "uri-reference" + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object" - }, - "jsonapi": { - "description": "An object describing the server's implementation", - "properties": { - "version": { - "type": "string" - }, - "meta": { - "$ref": "#/components/schemas/meta" + } + } + }, + "/aggregate/spatial-scene-group": { + "post": { + "tags": [ + "Spatial Scene Group", + "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.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialSceneGroup", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "aggregations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Aggregation" + } + } + }, + "required": [ + "aggregations" + ] + } + } } }, - "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]." + "responses": { + "200": { + "description": "List of SpatialSceneGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + } + ] + } }, - "parameter": { - "type": "string", - "description": "A string indicating which query parameter caused the error." + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + } + } + } } } }, - "meta": { - "$ref": "#/components/schemas/meta" + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" } - }, - "type": "object", - "additionalProperties": false - }, - "AclRoleJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ + } + } + }, + "/spatial-scene-light": { + "get": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "getSpatialSceneLightList", + "parameters": [ { - "$ref": "#/components/schemas/resource" + "name": "limit", + "in": "query", + "description": "Max amount of resources to be returned in a page", + "schema": { + "type": "integer" + } }, { - "required": [ - "id", - "name" - ], - "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" + "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 Spatial Scene Light resources.", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "allOf": [ + { + "$ref": "#/components/schemas/data" }, - "id": { - "type": "string", - "example": "9bc65c2abec141778ffaa729489f3e87" + { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } } - } - } - } - }, - "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" + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" }, - "id": { - "type": "string", - "example": "415320131958c70f4f250ca4d7e63bbd" + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-light?limit=25" + }, + "last": { + "example": "/spatial-scene-light?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-light?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-light?limit=25&page=2" + } + } } - } + ] } } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" }, - "type": "object" + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } } - }, - "type": "object" + } } - }, - "type": "object" + } + }, + "401": { + "$ref": "#/components/responses/401" } - ] + } }, - "AclRole": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name" + "post": { + "tags": [ + "Spatial Scene Light", + "Experimental" ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privileges": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false + "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": "createSpatialSceneLight", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] } - }, - "deletedAt": { - "type": "string", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-light": { + "post": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "searchSpatialSceneLight", + "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 SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-light/{id}": { + "get": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "getSpatialSceneLight", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_light", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "deleteSpatialSceneLight", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_light", + "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": [ + "Spatial Scene Light", + "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.", + "description": "", + "operationId": "updateSpatialSceneLight", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_light", + "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 Spatial Scene Light resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/spatial-scene-light": { + "post": { + "tags": [ + "Spatial Scene Light", + "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.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialSceneLight", + "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 SpatialSceneLight", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-material": { + "get": { + "tags": [ + "Spatial Scene Material", + "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.", + "description": "", + "operationId": "getSpatialSceneMaterialList", + "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 Spatial Scene Material 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/SpatialSceneMaterial" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-material?limit=25" + }, + "last": { + "example": "/spatial-scene-material?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-material?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-material?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene Material", + "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.", + "description": "", + "operationId": "createSpatialSceneMaterial", + "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/SpatialSceneMaterial" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneMaterial", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-material": { + "post": { + "tags": [ + "Spatial Scene Material", + "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.", + "description": "", + "operationId": "searchSpatialSceneMaterial", + "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 SpatialSceneMaterial", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-material/{id}": { + "get": { + "tags": [ + "Spatial Scene Material", + "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.", + "description": "", + "operationId": "getSpatialSceneMaterial", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_material", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneMaterial", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Material", + "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.", + "description": "", + "operationId": "deleteSpatialSceneMaterial", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_material", + "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": [ + "Spatial Scene Material", + "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.", + "description": "", + "operationId": "updateSpatialSceneMaterial", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_material", + "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 Spatial Scene Material resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneMaterial", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/spatial-scene-material": { + "post": { + "tags": [ + "Spatial Scene Material", + "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.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialSceneMaterial", + "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 SpatialSceneMaterial", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-object": { + "get": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "getSpatialSceneObjectList", + "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 Spatial Scene Object 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/SpatialSceneObject" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-object?limit=25" + }, + "last": { + "example": "/spatial-scene-object?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-object?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-object?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "createSpatialSceneObject", + "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/SpatialSceneObject" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-object": { + "post": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "searchSpatialSceneObject", + "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 SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-object/{id}": { + "get": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "getSpatialSceneObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_object", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "deleteSpatialSceneObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_object", + "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": [ + "Spatial Scene Object", + "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.", + "description": "", + "operationId": "updateSpatialSceneObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_object", + "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 Spatial Scene Object resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/spatial-scene-object": { + "post": { + "tags": [ + "Spatial Scene Object", + "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.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialSceneObject", + "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 SpatialSceneObject", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-primitive": { + "get": { + "tags": [ + "Spatial Scene Primitive", + "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.", + "description": "", + "operationId": "getSpatialScenePrimitiveList", + "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 Spatial Scene Primitive 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/SpatialScenePrimitive" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/spatial-scene-primitive?limit=25" + }, + "last": { + "example": "/spatial-scene-primitive?limit=25&page=11" + }, + "next": { + "example": "/spatial-scene-primitive?limit=25&page=4" + }, + "prev": { + "example": "/spatial-scene-primitive?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Spatial Scene Primitive", + "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.", + "description": "", + "operationId": "createSpatialScenePrimitive", + "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/SpatialScenePrimitive" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialScenePrimitive", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/spatial-scene-primitive": { + "post": { + "tags": [ + "Spatial Scene Primitive", + "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.", + "description": "", + "operationId": "searchSpatialScenePrimitive", + "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 SpatialScenePrimitive", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/spatial-scene-primitive/{id}": { + "get": { + "tags": [ + "Spatial Scene Primitive", + "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.", + "description": "", + "operationId": "getSpatialScenePrimitive", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_primitive", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SpatialScenePrimitive", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Spatial Scene Primitive", + "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.", + "description": "", + "operationId": "deleteSpatialScenePrimitive", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_primitive", + "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": [ + "Spatial Scene Primitive", + "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.", + "description": "", + "operationId": "updateSpatialScenePrimitive", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the spatial_scene_primitive", + "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 Spatial Scene Primitive resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SpatialScenePrimitive", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/spatial-scene-primitive": { + "post": { + "tags": [ + "Spatial Scene Primitive", + "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.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSpatialScenePrimitive", + "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 SpatialScenePrimitive", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider": { + "get": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "getSsoProviderList", + "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 Sso Provider 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/SsoProvider" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sso-provider?limit=25" + }, + "last": { + "example": "/sso-provider?limit=25&page=11" + }, + "next": { + "example": "/sso-provider?limit=25&page=4" + }, + "prev": { + "example": "/sso-provider?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "createSsoProvider", + "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/SsoProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sso-provider": { + "post": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "searchSsoProvider", + "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 SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider/{id}": { + "get": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "getSsoProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "deleteSsoProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider", + "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": [ + "Sso Provider", + "Experimental" + ], + "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": "updateSsoProvider", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider", + "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 Sso Provider resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sso-provider": { + "post": { + "tags": [ + "Sso Provider", + "Experimental" + ], + "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": "aggregateSsoProvider", + "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 SsoProvider", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProvider" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider-customer": { + "get": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "getSsoProviderCustomerList", + "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 Sso Provider 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/SsoProviderCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/sso-provider-customer?limit=25" + }, + "last": { + "example": "/sso-provider-customer?limit=25&page=11" + }, + "next": { + "example": "/sso-provider-customer?limit=25&page=4" + }, + "prev": { + "example": "/sso-provider-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "createSsoProviderCustomer", + "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/SsoProviderCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/sso-provider-customer": { + "post": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "searchSsoProviderCustomer", + "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 SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/sso-provider-customer/{id}": { + "get": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "getSsoProviderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "deleteSsoProviderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "updateSsoProviderCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the sso_provider_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Sso Provider Customer resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/sso-provider-customer": { + "post": { + "tags": [ + "Sso Provider Customer", + "Experimental" + ], + "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": "aggregateSsoProviderCustomer", + "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 SsoProviderCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SsoProviderCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription": { + "get": { + "tags": [ + "Subscription" + ], + "summary": "List with basic information of Subscription resources.", + "description": "", + "operationId": "getSubscriptionList", + "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 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/Subscription" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription?limit=25" + }, + "last": { + "example": "/subscription?limit=25&page=11" + }, + "next": { + "example": "/subscription?limit=25&page=4" + }, + "prev": { + "example": "/subscription?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription" + ], + "summary": "Create a new Subscription resources.", + "description": "", + "operationId": "createSubscription", + "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/Subscription" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription": { + "post": { + "tags": [ + "Subscription" + ], + "summary": "Search for the Subscription resources.", + "description": "", + "operationId": "searchSubscription", + "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 Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription/{id}": { + "get": { + "tags": [ + "Subscription" + ], + "summary": "Detailed information about a Subscription resource.", + "description": "", + "operationId": "getSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription" + ], + "summary": "Delete a Subscription resource.", + "description": "", + "operationId": "deleteSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "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" + ], + "summary": "Partially update information about a Subscription resource.", + "description": "", + "operationId": "updateSubscription", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription", + "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 resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Subscription" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/subscription": { + "post": { + "tags": [ + "Subscription" + ], + "summary": "Aggregate for the Subscription resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSubscription", + "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 Subscription", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Subscription" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-address": { + "get": { + "tags": [ + "Subscription Address" + ], + "summary": "List with basic information of Subscription Address resources.", + "description": "", + "operationId": "getSubscriptionAddressList", + "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 Address 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/SubscriptionAddress" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-address?limit=25" + }, + "last": { + "example": "/subscription-address?limit=25&page=11" + }, + "next": { + "example": "/subscription-address?limit=25&page=4" + }, + "prev": { + "example": "/subscription-address?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Address" + ], + "summary": "Create a new Subscription Address resources.", + "description": "", + "operationId": "createSubscriptionAddress", + "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/SubscriptionAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription-address": { + "post": { + "tags": [ + "Subscription Address" + ], + "summary": "Search for the Subscription Address resources.", + "description": "", + "operationId": "searchSubscriptionAddress", + "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 SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-address/{id}": { + "get": { + "tags": [ + "Subscription Address" + ], + "summary": "Detailed information about a Subscription Address resource.", + "description": "", + "operationId": "getSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Address" + ], + "summary": "Delete a Subscription Address resource.", + "description": "", + "operationId": "deleteSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "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 Address" + ], + "summary": "Partially update information about a Subscription Address resource.", + "description": "", + "operationId": "updateSubscriptionAddress", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_address", + "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 Address resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/subscription-address": { + "post": { + "tags": [ + "Subscription Address" + ], + "summary": "Aggregate for the Subscription Address resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSubscriptionAddress", + "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 SubscriptionAddress", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionAddress" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-customer": { + "get": { + "tags": [ + "Subscription Customer" + ], + "summary": "List with basic information of Subscription Customer resources.", + "description": "", + "operationId": "getSubscriptionCustomerList", + "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 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/SubscriptionCustomer" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-customer?limit=25" + }, + "last": { + "example": "/subscription-customer?limit=25&page=11" + }, + "next": { + "example": "/subscription-customer?limit=25&page=4" + }, + "prev": { + "example": "/subscription-customer?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Customer" + ], + "summary": "Create a new Subscription Customer resources.", + "description": "", + "operationId": "createSubscriptionCustomer", + "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/SubscriptionCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription-customer": { + "post": { + "tags": [ + "Subscription Customer" + ], + "summary": "Search for the Subscription Customer resources.", + "description": "", + "operationId": "searchSubscriptionCustomer", + "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 SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-customer/{id}": { + "get": { + "tags": [ + "Subscription Customer" + ], + "summary": "Detailed information about a Subscription Customer resource.", + "description": "", + "operationId": "getSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Customer" + ], + "summary": "Delete a Subscription Customer resource.", + "description": "", + "operationId": "deleteSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Subscription Customer" + ], + "summary": "Partially update information about a Subscription Customer resource.", + "description": "", + "operationId": "updateSubscriptionCustomer", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_customer", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Partially update information about a Subscription Customer resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/subscription-customer": { + "post": { + "tags": [ + "Subscription Customer" + ], + "summary": "Aggregate for the Subscription Customer resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSubscriptionCustomer", + "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 SubscriptionCustomer", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionCustomer" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/subscription-interval": { + "get": { + "tags": [ + "Subscription Interval" + ], + "summary": "List with basic information of Subscription Interval resources.", + "description": "", + "operationId": "getSubscriptionIntervalList", + "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 Interval 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/SubscriptionInterval" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/subscription-interval?limit=25" + }, + "last": { + "example": "/subscription-interval?limit=25&page=11" + }, + "next": { + "example": "/subscription-interval?limit=25&page=4" + }, + "prev": { + "example": "/subscription-interval?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Subscription Interval" + ], + "summary": "Create a new Subscription Interval resources.", + "description": "", + "operationId": "createSubscriptionInterval", + "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/SubscriptionInterval" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/subscription-interval": { + "post": { + "tags": [ + "Subscription Interval" + ], + "summary": "Search for the Subscription Interval resources.", + "description": "", + "operationId": "searchSubscriptionInterval", + "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 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-interval/{id}": { + "get": { + "tags": [ + "Subscription Interval" + ], + "summary": "Detailed information about a Subscription Interval resource.", + "description": "", + "operationId": "getSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Subscription Interval" + ], + "summary": "Delete a Subscription Interval resource.", + "description": "", + "operationId": "deleteSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "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 Interval" + ], + "summary": "Partially update information about a Subscription Interval resource.", + "description": "", + "operationId": "updateSubscriptionInterval", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the subscription_interval", + "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 Interval resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SubscriptionInterval", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SubscriptionInterval" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/subscription-interval": { + "post": { + "tags": [ + "Subscription Interval" + ], + "summary": "Aggregate for the Subscription Interval resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSubscriptionInterval", + "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 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", + "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" + } + } + } + }, + "/swag-delay-action": { + "get": { + "tags": [ + "Swag Delay Action" + ], + "summary": "List with basic information of Swag Delay Action resources.", + "description": "", + "operationId": "getSwagDelayActionList", + "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 Delay Action 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/SwagDelayAction" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/swag-delay-action?limit=25" + }, + "last": { + "example": "/swag-delay-action?limit=25&page=11" + }, + "next": { + "example": "/swag-delay-action?limit=25&page=4" + }, + "prev": { + "example": "/swag-delay-action?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Create a new Swag Delay Action resources.", + "description": "", + "operationId": "createSwagDelayAction", + "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/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/swag-delay-action": { + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Search for the Swag Delay Action resources.", + "description": "", + "operationId": "searchSwagDelayAction", + "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 SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/swag-delay-action/{id}": { + "get": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Detailed information about a Swag Delay Action resource.", + "description": "", + "operationId": "getSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Delete a Swag Delay Action resource.", + "description": "", + "operationId": "deleteSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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 Delay Action" + ], + "summary": "Partially update information about a Swag Delay Action resource.", + "description": "", + "operationId": "updateSwagDelayAction", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the swag_delay_action", + "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 Delay Action resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/swag-delay-action": { + "post": { + "tags": [ + "Swag Delay Action" + ], + "summary": "Aggregate for the Swag Delay Action resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateSwagDelayAction", + "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 SwagDelayAction", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SwagDelayAction" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "List with basic information of Warehouse resources.", + "description": "", + "operationId": "getWarehouseList", + "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 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/Warehouse" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/warehouse?limit=25" + }, + "last": { + "example": "/warehouse?limit=25&page=11" + }, + "next": { + "example": "/warehouse?limit=25&page=4" + }, + "prev": { + "example": "/warehouse?limit=25&page=2" + } + } + } + ] + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Create a new Warehouse resources.", + "description": "", + "operationId": "createWarehouse", + "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/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/search/warehouse": { + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Search for the Warehouse resources.", + "description": "", + "operationId": "searchWarehouse", + "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 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/{id}": { + "get": { + "tags": [ + "Warehouse" + ], + "summary": "Detailed information about a Warehouse resource.", + "description": "", + "operationId": "getWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse" + ], + "summary": "Delete a Warehouse resource.", + "description": "", + "operationId": "deleteWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "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": [ + "Warehouse" + ], + "summary": "Partially update information about a Warehouse resource.", + "description": "", + "operationId": "updateWarehouse", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse", + "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 Warehouse resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + }, + "responses": { + "200": { + "description": "Detail of Warehouse", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "required": [ + "data" + ], + "properties": { + "data": { + "$ref": "#/components/schemas/Warehouse" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/warehouse": { + "post": { + "tags": [ + "Warehouse" + ], + "summary": "Aggregate for the Warehouse resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWarehouse", + "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 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", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/warehouse-group/{id}": { + "get": { + "tags": [ + "Warehouse Group" + ], + "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}$" + } + } + ], + "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" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Warehouse Group" + ], + "summary": "Delete a Warehouse Group resource.", + "description": "", + "operationId": "deleteWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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": [ + "Warehouse Group" + ], + "summary": "Partially update information about a Warehouse Group resource.", + "description": "", + "operationId": "updateWarehouseGroup", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the warehouse_group", + "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 Warehouse Group resource.", + "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" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/aggregate/warehouse-group": { + "post": { + "tags": [ + "Warehouse Group" + ], + "summary": "Aggregate for the Warehouse Group resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateWarehouseGroup", + "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 WarehouseGroup", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/_action/custom-price": { + "post": { + "tags": [ + "Bulk Operations" + ], + "summary": "Bulk edit custom prices", + "description": "An emulation of Sync API implementation", + "operationId": "customPriceImport", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/CustomPricingUpsertOperation" + }, + { + "$ref": "#/components/schemas/CustomPricingDeleteOperation" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "description": "Returns a JSON result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CustomPricingResponse" + } + } + } + } + } + } + }, + "/api/_admin/rule-builder-preview/{orderId}": { + "post": { + "tags": [ + "Rule Preview" + ], + "summary": "Preview results of a rule evaluating an order", + "description": "Evaluate the conditions of a rule based on a pre-selected order.", + "operationId": "rulePreview", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order the preview should be generated for", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "conditions" + ], + "properties": { + "conditions": { + "description": "Array of nested rule condition payloads.", + "items": { + "type": "object" + }, + "type": "array" + }, + "dateTime": { + "description": "A date and time to be mocked in the preview evaluation.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the results of the evaluated rule conditions as an object.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "properties": { + "match": { + "description": "Evaluation of the condition", + "type": "boolean" + }, + "name": { + "description": "The technical name of the condition", + "type": "string" + }, + "ruleReferenceId": { + "description": "The id of the corresponding rule_condition entity", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + } + }, + "/api/_action/generate-review-summary": { + "post": { + "summary": "Generate review summaries for products", + "description": "Generate review summaries using the ReviewSummary service. Request body accepts mood, productId, salesChannelId and languageIds.", + "operationId": "generateReviewSummary", + "tags": [ + "ReviewSummary" + ], + "requestBody": { + "description": "Options for review summary generation.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Options" + }, + "example": { + "mood": "positive", + "productId": "019970d61cf071b481145788abdb2271", + "salesChannelId": "01988451220e7308bdda1b32e87db12f", + "languageIds": [ + "2fbb5fe2e29a4d70aa5854ce7ce3e20b" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Array of generated summaries", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "array", + "items": { + "$ref": "#/components/schemas/ReviewSummaryItem" + } + }, + { + "$ref": "#/components/schemas/ReviewSummaryByLanguage" + } + ] + }, + "example": { + "2fbb5fe2e29a4d70aa5854ce7ce3e20b": "Review Summary of the product in the specified language." + } + } + } + }, + "400": { + "description": "Bad request — validation or generation error (message returned as plain JSON string)", + "content": { + "application/json": { + "schema": { + "type": "string" + }, + "example": "License missing or generation failed:
" + } + } + } + } + } + }, + "/_action/invite-employee": { + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Sends an invite email to employee", + "description": "This route is used to send an invite email to an employee", + "operationId": "inviteEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the employee to invite", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Id of the sales channel through which the registration will be fulfilled.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "required": [ + "id" + ], + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/create-employee": { + "post": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Creates an employee", + "description": "This route is used to create an employee", + "operationId": "createEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "firstName": { + "description": "First name of the new employee", + "type": "string" + }, + "lastName": { + "description": "Last name of the new employee", + "type": "string" + }, + "email": { + "description": "Email of the new employee", + "type": "string" + }, + "roleId": { + "description": "Id of the role of the new employee", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "IDs of the created employees", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Array of the created employee ids", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "/_action/update-employee": { + "patch": { + "tags": [ + "B2B Employee Management" + ], + "summary": "Updates an employee", + "description": "This route is used to update an employee", + "operationId": "updateEmployee", + "parameters": [], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "description": "Id of the employee", + "type": "string" + }, + "firstName": { + "description": "First name of the employee", + "type": "string" + }, + "lastName": { + "description": "Last name of the employee", + "type": "string" + }, + "email": { + "description": "Email of the employee", + "type": "string" + }, + "roleId": { + "description": "Id of the role of the employee", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_proxy-quote/{salesChannelId}": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Create a new quote", + "description": "This route is used to create a new quote from admin", + "operationId": "createQuoteFromAdmin", + "parameters": [ + { + "name": "salesChannelId", + "in": "path", + "description": "Identifier of the sales channel to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Quote entity", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Quote" + } + } + } + } + } + } + }, + "/_action/quote/{quoteId}/product/{productId}": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Add product to quote", + "description": "This route is used to add a product to a quote from admin", + "operationId": "addProductToQuote", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "productId", + "in": "path", + "description": "Identifier of the product to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "quantity": { + "type": "integer", + "pattern": "int32" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/lineItem": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Add custom line item to quote", + "description": "This route is used to add a custom line item to a quote from admin", + "operationId": "addCustomLineItemToQuote", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "identifier": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string", + "default": "custom" + }, + "quantity": { + "type": "integer", + "pattern": "int32" + }, + "label": { + "type": "string", + "default": "null" + }, + "description": { + "type": "string", + "default": "null" + }, + "removable": { + "type": "boolean", + "default": true + }, + "stackable": { + "type": "boolean", + "default": true + }, + "payload": { + "type": "array", + "items": { + "type": "object" + } + }, + "priceDefinition": { + "type": "array", + "items": { + "type": "object" + } + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/recalculate": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Recalculate a quote", + "description": "This route is used to recalculate a quote", + "operationId": "recalculateQuote", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/quote/{quoteId}/comment": { + "post": { + "tags": [ + "B2B Quote Management" + ], + "summary": "Create a new comment", + "description": "This route is used to create a new comment from admin", + "operationId": "createComment", + "parameters": [ + { + "name": "quoteId", + "in": "path", + "description": "Identifier of the quote to be fetched", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { + "description": "Message content", + "type": "string" + }, + "state": { + "description": "Current quote state", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "204": { + "description": "No content response" + } + } + } + }, + "/_action/text-to-image/generate": { + "post": { + "tags": [ + "Text to Image" + ], + "summary": "Generate images based on a textual prompt", + "description": "Generate images based on a textual prompt", + "operationId": "textToImageGenerate", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "The textual prompt to describe what image to generate", + "type": "string", + "example": "Generate a warm and inviting ambience with soft lightning and neutral tones" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "The base64 string representation of the generated image", + "content": { + "application/json": { + "schema": { + "type": "string", + "format": "byte", + "example": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAJZlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgExAAIAAAARAAAAWodpAAQAAAABAAAAbAAAAAAAAABgAAAAAQAAAGAAAAABd3d3Lmlua3NjYXBlLm9yZwAAAAOgAQADAAAAAQABAACgAgAEAAAAAQAAABCgAwAEAAAAAQAAABAAAAAAKwl1NwAAAAlwSFlzAAAOxAAADsQBlSsOGwAAAi1pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyI+CiAgICAgICAgIDx4bXA6Q3JlYXRvclRvb2w+d3d3Lmlua3NjYXBlLm9yZzwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj45NjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+OTY8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgryNKKqAAAC8klEQVQ4EV1Tz0tUURg99943zpvGcWaqaRTJ7CdGvzBtkVQYFLjxD3AlZFREUZv21q4f1CLBCLR2bdoVBVmbchGUiUQU0i8oNUEsG9/MOG/uvZ07Y2B9vPu473HP+c53vvsJuOi3Ev3CuO26IbtHAH1K4EBSIlvDf0rY2aQSo63JcOh6d82EO9dvrewXwoiV4Pphe1N7OJP2gaAETBV40tE6lihXCLQAAx96xVl+wZKEyaqRHbYjtg5HUjlrJkOhoSCvrC+J1voQ62q1jXnGWAvl16WkV5p/2phdc9QhKwT1Q3bQJnEquYjiZBH+mazGufYcGpMhhLDQFGqXEymJYqw24y/8nBtMrc6cFg13bZtVeB0rQ38JoXrTGtcO/0I8alAMqwKjXhVOBZAkJKsWyleLwVI7heGEiAG+ZrUUfmpnHgl+BEsSzFYBjH/38XIqypqBbNygZW1o9m2LKVMunPCorEPRnG8GcmfMojEVolQWTELvmHliyseBZ4mqkU6IM9X68uo00LPd63AEG1GGe2SEICfagf9GZcvXhghbrGwFryHkhffAj1zdRookmMxN3I0XBOYCj32vwpfowY6GIh51BGiKWLzKC4zxzG+q2LwKmAwULxDwRZCdYZzVI599KnBaq+E60Lk1j/td83hxKIeLTSE+069PLLtk8VWw/7dkHCdNgDAhEPm4BDzZH6BzS4BCSUKTy5kXUW7RZyswsxAJn/9IRd5O69ti7bDd63kYs2yjgmWVPED2e7sLOMLMriNlLVDickTOH7ZVR/2o+pkvtcu5Y+INwQMyCVWGKPJu2mZe3Z7xGI6PpPHwXS1mc16lI7GIca0trkpk1O/FcDCTyowt21UZoscqhS69AENjdFpCvicjOBOSV+BSY2i6NhVU29Y6ufBr7mkqnVm+yismMXvH3oDEeclhMizDp9u1TDHPNeN85b8He/ID3W3x/4bpX5Jd7EYfMQcJqad3iEvMNteY0daEHrq8PM6VSeQ4/wGOAT89rW8MpwAAAABJRU5ErkJggg==" + } + } + } + } + } + } + }, + "/_action/share-config/download/{entity}/{id}": { + "get": { + "tags": [ + "Admin API", + "Sharing", + "Download" + ], + "summary": "Download a shared config", + "description": "This route is used to download a shared config", + "operationId": "downloadSharedConfig", + "parameters": [ + { + "name": "entity", + "in": "path", + "description": "Entity name of the shared config", + "required": true, + "schema": { + "type": "string", + "enum": [ + "flow", + "rule" + ] + } + }, + { + "name": "id", + "in": "path", + "description": "Id of the shared config", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "Download the shared config" + }, + "400": { + "description": "Entity is not supported. Use flow, rule" + }, + "404": { + "description": "Entity with id is invalid or could not be found" + } + } + } + }, + "/_action/share-config/upload/{entity}": { + "post": { + "tags": [ + "Admin API", + "Sharing", + "Upload" + ], + "summary": "Upload a shared config", + "description": "This route is used to upload a shared config", + "operationId": "uploadSharedConfig", + "parameters": [ + { + "name": "entity", + "in": "path", + "description": "Entity name of the shared config", + "required": true, + "schema": { + "type": "string", + "enum": [ + "flow", + "rule" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "description": "Data of the shared config (Entities related that have to be included)", + "type": "object" + }, + "references": { + "description": "References of the shared config (ID's of entities that are referenced)", + "type": "object" + }, + "requirements": { + "description": "Requirements of the shared config (ID's of entities that are required)", + "type": "object" + }, + "flow": { + "description": "Flow of the shared config", + "type": "object" + }, + "rule": { + "description": "Rule of the shared config", + "type": "object" + } + }, + "required": [ + "data", + "references", + "requirements" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Upload the shared config" + }, + "400": { + "description": "Entity is not supported. Use flow, rule" + } + } + } + }, + "/product-bundle/search": { + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Product bundles search", + "operationId": "searchProductBundles", + "parameters": [ + { + "name": "sw-include-search-info", + "in": "header", + "schema": { + "type": "string", + "enum": [ + "0", + "1" + ], + "default": "1" + }, + "description": "Set to 0 to suppress aggregations and search metadata." + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "Search response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + }, + "aggregations": { + "type": "object" + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-bundle/search-ids": { + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Search bundle identifiers", + "operationId": "searchProductBundleIds", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Criteria" + } + } + } + }, + "responses": { + "200": { + "description": "ID search response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "states": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-bundle": { + "get": { + "tags": [ + "Product Bundles" + ], + "summary": "List bundles", + "operationId": "getProductBundles", + "parameters": [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "query", + "in": "query", + "schema": { + "type": "string" + }, + "description": "SwagQL query" + } + ], + "responses": { + "200": { + "description": "Bundle list", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + }, + "page": { + "type": "integer" + }, + "limit": { + "type": "integer" + } + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Create bundle(s)", + "operationId": "createProductBundles", + "parameters": [ + { + "name": "_response", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Set any value to return the created bundle payload(s) instead of 204.", + "allowEmptyValue": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BundleProductWrite" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProductWrite" + } + } + ] + }, + "example": { + "name": "Starter kit", + "bundleItems": [ + { + "productId": "0190311a99bd4be3a456e9a72b4d1234", + "quantity": 1, + "min": 1, + "required": true + }, + { + "productId": "0190311cef8a4c5d880b20a2bfe96543", + "quantity": 1, + "min": 1, + "required": true + } + ], + "visibilities": [ + { + "salesChannelId": "01902f89c8a94a629e102fa97d3a5678", + "visibility": 3 + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "Bundles created" + }, + "200": { + "description": "Created bundle payload(s) when _response is provided", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Product Bundles" + ], + "summary": "Update bundle(s)", + "operationId": "updateProductBundles", + "parameters": [ + { + "name": "_response", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Set any value to return the updated bundle payload(s).", + "allowEmptyValue": true + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/BundleProductWrite" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProductWrite" + } + } + ] + } + } + } + }, + "responses": { + "204": { + "description": "Bundles updated" + }, + "200": { + "description": "Updated bundle payload(s) when _response is provided", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleProduct" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/product-bundle/{id}": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "get": { + "tags": [ + "Product Bundles" + ], + "summary": "Bundle detail", + "operationId": "getProductBundle", + "responses": { + "200": { + "description": "Bundle detail", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/BundleProduct" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/404" + } + } + }, + "delete": { + "tags": [ + "Product Bundles" + ], + "summary": "Delete bundle", + "operationId": "deleteProductBundle", + "responses": { + "204": { + "description": "Bundle deleted" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + } + } + } + }, + "/product-bundle/{id}/clone": { + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "post": { + "tags": [ + "Product Bundles" + ], + "summary": "Clone bundle", + "operationId": "cloneProductBundle", + "parameters": [ + { + "name": "_response", + "in": "query", + "schema": { + "type": "string" + }, + "description": "Set any value to return the cloned bundle payload instead of just the identifier.", + "allowEmptyValue": true + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BundleProductWrite" + } + } + } + }, + "responses": { + "200": { + "description": "Clone response", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + }, + { + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/BundleProduct" + } + } + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "404": { + "$ref": "#/components/responses/404" + } + } + } + } + }, + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "users": { + "properties": { + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "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" + ], + "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" + }, + "AdvancedSearchActionJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configId", + "type", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "active": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "typeConfig": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "searchTerms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action_search_term" + }, + "id": { + "type": "string", + "example": "952c07f523c564f09844ca7f880c2467" + } + } + } + } + }, + "type": "object" + }, + "config": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchAction": { + "required": [ + "id", + "configId", + "type", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "active": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "typeConfig": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "searchTerms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" + } + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + }, + "type": "object" + }, + "AdvancedSearchActionSearchTermJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "term", + "salesChannelId", + "actionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "term": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionId": { + "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": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "action": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "418c5509e2171d55b0aee5c2ea4442b5" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchActionSearchTerm": { + "required": [ + "id", + "term", + "salesChannelId", + "actionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "term": { + "type": "string" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionId": { + "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" + }, + "action": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + }, + "type": "object" + }, + "AdvancedSearchBoostingJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "boost", + "name", + "configId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "boost": { + "type": "number", + "format": "float" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "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": { + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "entityStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62acf68da615789a0175ef827f74acbb" + } + } + } + }, + "type": "object" + }, + "config": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchBoosting": { + "required": [ + "id", + "boost", + "name", + "configId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validTo": { + "type": "string", + "format": "date-time" + }, + "boost": { + "type": "number", + "format": "float" + }, + "active": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "entityStream": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + } + }, + "type": "object" + }, + "AdvancedSearchConfigJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "esEnabled": { + "type": "boolean" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "hitCount": { + "properties": { + "product": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "product_manufacturer": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "category": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + } + }, + "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": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "fields": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "d05b6ed7d2345020440df396d6da7f73" + } + } + } + } + }, + "type": "object" + }, + "boostings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_boosting" + }, + "id": { + "type": "string", + "example": "8e571802e4ea39b214104ca60e13b5a6" + } + } + } + } + }, + "type": "object" + }, + "searchActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/searchActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action" + }, + "id": { + "type": "string", + "example": "f7e07cbefd6755762faa802c35e48929" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchConfig": { + "required": [ + "id", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "esEnabled": { + "type": "boolean" + }, + "andLogic": { + "type": "boolean" + }, + "minSearchLength": { + "type": "integer", + "format": "int64" + }, + "hitCount": { + "properties": { + "product": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "product_manufacturer": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + }, + "category": { + "properties": { + "maxSuggestCount": { + "type": "integer", + "format": "int64" + }, + "maxSearchCount": { + "type": "integer", + "format": "int64" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchConfigField" + } + }, + "boostings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + }, + "searchActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchAction" + } + } + }, + "type": "object" + }, + "AdvancedSearchConfigFieldJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "configId", + "entity", + "field" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "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": { + "config": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2245023265ae4cf87d02c8b6ba991139" + } + } + } + }, + "type": "object" + }, + "customField": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/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" + } + ] + }, + "AdvancedSearchConfigField": { + "required": [ + "id", + "configId", + "entity", + "field" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "configId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "type": "string" + }, + "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 + }, + "config": { + "$ref": "#/components/schemas/AdvancedSearchConfig" + }, + "customField": { + "$ref": "#/components/schemas/CustomField" + } + }, + "type": "object" + }, + "AdvancedSearchEntityStreamJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "filters": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "example": "2c9885d2b0c7e26971f60a90f33cf718" + } + } + } + } + }, + "type": "object" + }, + "boosting": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_boosting" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ab105abdd48ced24ce7b0e516ca0970" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchEntityStream": { + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "apiFilter": { + "type": "object", + "readOnly": true + }, + "invalid": { + "type": "boolean", + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + }, + "boosting": { + "$ref": "#/components/schemas/AdvancedSearchBoosting" + } + }, + "type": "object" + }, + "AdvancedSearchEntityStreamFilterJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entityStreamId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "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": { + "entityStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62acf68da615789a0175ef827f74acbb" + } + } + } + }, + "type": "object" + }, + "parent": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_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": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_entity_stream_filter" + }, + "id": { + "type": "string", + "example": "5da7eb4247add5dbd5776c9c0b38460a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AdvancedSearchEntityStreamFilter": { + "required": [ + "id", + "entityStreamId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityStreamId": { + "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 + }, + "entityStream": { + "$ref": "#/components/schemas/AdvancedSearchEntityStream" + }, + "parent": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + }, + "queries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + } + } + }, + "type": "object" + }, + "AdvancedSearchSynonymJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "left" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "left": { + "type": "array", + "items": { + "type": "string" + } + }, + "right": { + "type": "array", + "items": { + "type": "string" + } + }, + "languageId": { + "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": { + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/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" + } + ] + }, + "AdvancedSearchSynonym": { + "required": [ + "id", + "left" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "left": { + "type": "array", + "items": { + "type": "string" + } + }, + "right": { + "type": "array", + "items": { + "type": "string" + } + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "language": { + "$ref": "#/components/schemas/Language" + } + }, + "type": "object" + }, + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "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", + "version", + "integrationId", + "aclRoleId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" + } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" + } + }, + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "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" + ], + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" + } + } + }, + "type": "object" + }, + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appId", + "name", + "aware" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "flows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Flow" + } + } + }, + "type": "object" + }, + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "description": "Name of the app.", + "type": "string" + }, + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" + }, + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" + }, + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" + }, + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "description": "Name of the app.", + "type": "string" + }, + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" + }, + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" + }, + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" + }, + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" + }, + "group": { + "description": "Categorizes script conditions within a specific group.", + "type": "string" + }, + "script": { + "description": "Internal field.", + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" + }, + "group": { + "description": "Categorizes script conditions within a specific group.", + "type": "string" + }, + "script": { + "description": "Internal field.", + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "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" + ], + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "template", + "path", + "active", + "appId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "description": "Template for an app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app template.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "description": "Template for an app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app template.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "B2bBusinessPartnerJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultRoleId": { + "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": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "defaultRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2944ea414640901d532eba5106eb706b" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bBusinessPartner": { + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultRoleId": { + "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 + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "defaultRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + } + }, + "type": "object" + }, + "B2bComponentsAdvancedProductCatalogsJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "organizationId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoAddNewCategories": { + "type": "boolean" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "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": { + "customerGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customerGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "115091b01a7299f28a5ce7e1b712a222" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/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": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "salesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannels" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "986f6f891e90ab91c091ff4a1a460777" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" + }, + "categories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-advanced-product-catalogs/9a15f9857bdcf1231c8fd8d719c177a9/categories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsAdvancedProductCatalogs": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "customerId", + "organizationId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoAddNewCategories": { + "type": "boolean" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "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 + }, + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "organization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "salesChannels": { + "$ref": "#/components/schemas/SalesChannel" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "advancedProductCatalogsCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogsCategory" + } + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + } + }, + "type": "object" + }, + "B2bComponentsAdvancedProductCatalogsCategory": { + "required": [ + "advancedProductCatalogsId", + "categoryId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "advancedProductCatalogsId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "advancedProductCatalog": { + "$ref": "#/components/schemas/B2bComponentsAdvancedProductCatalogs" + }, + "category": { + "$ref": "#/components/schemas/Category" + } + }, + "type": "object" + }, + "B2bComponentsApprovalRuleJsonApi": { + "description": "Added since version: 6.6.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "priority", + "active", + "conditions" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "affectedRoleId": { + "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": { + "businessPartnerCustomer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + } + } + } + }, + "type": "object" + }, + "reviewerRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06ec286ee4d03afb4028caa32c0ef40b" + } + } + } + }, + "type": "object" + }, + "affectedRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "33237c6057eedd7b8c978f77270af3b1" + } + } + } + }, + "type": "object" + }, + "pendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/pendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "2a7cfaa402d9b52e7ecd072ae390d84b" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsApprovalRule": { + "description": "Added since version: 6.6.0.0", + "required": [ + "id", + "name", + "priority", + "active", + "conditions" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "active": { + "type": "boolean" + }, + "conditions": { + "type": "object" + }, + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "affectedRoleId": { + "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 + }, + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" + }, + "reviewerRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "affectedRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "pendingOrders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + } + } + }, + "type": "object" + }, + "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { + "description": "Added since version: 6.6.3.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "identifier", + "active", + "appId" + ], + "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": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/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" + } + ] + }, + "B2bComponentsApprovalRuleAppScriptCondition": { + "description": "Added since version: 6.6.3.0", + "required": [ + "id", + "identifier", + "active", + "appId" + ], + "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" + } + }, + "type": "object" + }, + "B2bComponentsBudgetJsonApi": { + "description": "Added since version: 6.7.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "technicalName", + "amount", + "startDate", + "currencyId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "costCentre": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "amount": { + "type": "number", + "format": "float" + }, + "usedAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "renewsType": { + "type": "string" + }, + "lastRenews": { + "type": "string", + "readOnly": true + }, + "nextRenews": { + "type": "string", + "readOnly": true + }, + "allowApproval": { + "type": "boolean" + }, + "showRemaining": { + "type": "boolean" + }, + "notify": { + "type": "boolean" + }, + "notificationConfig": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "sent": { + "type": "boolean", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "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": { + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "organizations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/organizations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "d9811f03b461a380c0d6b4a497dbac37" + } + } + } + } + }, + "type": "object" + }, + "notificationRecipients": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/notificationRecipients" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "bd4a2b3045182246fac51c0abc10c4d7" + } + } + } + } + }, + "type": "object" + }, + "reviewerRole": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/reviewerRole" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "06ec286ee4d03afb4028caa32c0ef40b" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-budget/1e4002da52224f484ff690aa9b0bfb2a/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" + } + ] + }, + "B2bComponentsBudget": { + "description": "Added since version: 6.7.4.0", + "required": [ + "id", + "name", + "technicalName", + "amount", + "startDate", + "currencyId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "costCentre": { + "type": "string" + }, + "technicalName": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "amount": { + "type": "number", + "format": "float" + }, + "usedAmount": { + "type": "number", + "format": "float", + "readOnly": true + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "renewsType": { + "type": "string" + }, + "lastRenews": { + "type": "string", + "readOnly": true + }, + "nextRenews": { + "type": "string", + "readOnly": true + }, + "allowApproval": { + "type": "boolean" + }, + "showRemaining": { + "type": "boolean" + }, + "notify": { + "type": "boolean" + }, + "notificationConfig": { + "properties": { + "type": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "sent": { + "type": "boolean", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "reviewerRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "organizations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + }, + "notificationRecipients": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "reviewerRole": { + "$ref": "#/components/schemas/B2bComponentsRole" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + } + }, + "type": "object" + }, + "B2bComponentsBudgetNotificationRecipient": { + "description": "Added since version: 6.7.4.0", + "required": [ + "budgetId", + "employeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budgetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budget": { + "$ref": "#/components/schemas/B2bComponentsBudget" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "type": "object" + }, + "B2bComponentsBudgetOrganization": { + "description": "Added since version: 6.7.4.0", + "required": [ + "budgetId", + "organizationId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budgetId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "budget": { + "$ref": "#/components/schemas/B2bComponentsBudget" + }, + "organization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + }, + "type": "object" + }, + "B2bComponentsEmployeeWishlistJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "employeeId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "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": { + "employee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/employee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/salesChannel" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-employee-wishlist/f98316a3fc328d78253ed1a43405272c/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist_product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsEmployeeWishlist": { + "required": [ + "id", + "employeeId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "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 + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlistProduct" + } + } + }, + "type": "object" + }, + "B2bComponentsEmployeeWishlistProductJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "employeeWishlistId", + "productId", + "productVersionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeWishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "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": { + "employeeWishlist": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/employeeWishlist" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "396edf0709663088597d101284333942" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-employee-wishlist-product/897dd62afed3c3d7592a194fe2df9218/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" + } + ] + }, + "B2bComponentsEmployeeWishlistProduct": { + "required": [ + "id", + "employeeWishlistId", + "productId", + "productVersionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeWishlistId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "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 + }, + "employeeWishlist": { + "$ref": "#/components/schemas/B2bComponentsEmployeeWishlist" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingJsonApi": { + "description": "Added since version: 6.7.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "active", + "showStrikeThrough", + "name", + "target", + "priority", + "applyToAllProducts", + "useValidityRange", + "actionType", + "tiers" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "target": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "applyToAllProducts": { + "type": "boolean" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useValidityRange": { + "type": "boolean" + }, + "validFrom": { + "type": "string" + }, + "validUntil": { + "type": "string" + }, + "description": { + "type": "string" + }, + "actionType": { + "type": "string" + }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/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": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "productStream": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/productStream" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "49561f6faa0badfce831a183d2ec7c2f" + } + } + } + }, + "type": "object" + }, + "tiers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/tiers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_tier" + }, + "id": { + "type": "string", + "example": "49f466e28285d1d4989b49139c4b265e" + } + } + } + } + }, + "type": "object" + }, + "companyAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/companyAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "e02294f7c7e9c5f3829bfcc5fc9aadd6" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing/4398cd1810a050caffbc7dc121434fb5/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsIndividualPricing": { + "description": "Added since version: 6.7.8.0", + "required": [ + "id", + "active", + "showStrikeThrough", + "name", + "target", + "priority", + "applyToAllProducts", + "useValidityRange", + "actionType", + "tiers" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "target": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "applyToAllProducts": { + "type": "boolean" + }, + "productStreamId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useValidityRange": { + "type": "boolean" + }, + "validFrom": { + "type": "string" + }, + "validUntil": { + "type": "string" + }, + "description": { + "type": "string" + }, + "actionType": { + "type": "string" + }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "tiers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingTier" + } + }, + "companyAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingCompanyAssignmentJsonApi": { + "description": "Added since version: 6.7.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "individualPricingId", + "customerId", + "scope" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scope": { + "type": "string" + }, + "organizationUnitIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "individualPricing": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/individualPricing" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5fe7ef4389efb412d4e35056093e10ab" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "units": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing-company-assignment/b73c0318c6308826d7501ab4df0db333/units" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsIndividualPricingCompanyAssignment": { + "description": "Added since version: 6.7.8.0", + "required": [ + "id", + "individualPricingId", + "customerId", + "scope" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "scope": { + "type": "string" + }, + "organizationUnitIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "individualPricing": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingCompanyAssignmentUnit": { + "description": "Added since version: 6.7.8.0", + "required": [ + "assignmentId", + "orgUnitId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "assignmentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orgUnitId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "assignment": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricingCompanyAssignment" + }, + "orgUnit": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingComputedCacheJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "individualPricingId", + "actionType", + "priority", + "activatedAt" + ], + "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}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionType": { + "type": "string" + }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "price": { + "type": "object" + }, + "activatedAt": { + "type": "string", + "format": "date-time" + }, + "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": "/b2b-components-individual-pricing-computed-cache/844b7f47ba74cc63454301f0b4ca1c82/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" + } + ] + }, + "B2bComponentsIndividualPricingComputedCache": { + "required": [ + "id", + "individualPricingId", + "actionType", + "priority", + "activatedAt" + ], + "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}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionType": { + "type": "string" + }, + "actionAmount": { + "type": "number", + "format": "float" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "validFrom": { + "type": "string", + "format": "date-time" + }, + "validUntil": { + "type": "string", + "format": "date-time" + }, + "showStrikeThrough": { + "type": "boolean" + }, + "price": { + "type": "object" + }, + "activatedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingTag": { + "description": "Added since version: 6.7.8.0", + "required": [ + "individualPricingId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricing": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + }, + "tag": { + "$ref": "#/components/schemas/Tag" + } + }, + "type": "object" + }, + "B2bComponentsIndividualPricingTierJsonApi": { + "description": "Added since version: 6.7.8.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "individualPricingId", + "id", + "qtyFrom", + "price" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "qtyFrom": { + "type": "integer", + "format": "int64" + }, + "qtyTo": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "individualPricing": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-individual-pricing-tier/8430b2435525569963232095b1a5a6dd/individualPricing" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5fe7ef4389efb412d4e35056093e10ab" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsIndividualPricingTier": { + "description": "Added since version: 6.7.8.0", + "required": [ + "individualPricingId", + "id", + "qtyFrom", + "price" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "individualPricingId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "qtyFrom": { + "type": "integer", + "format": "int64" + }, + "qtyTo": { + "type": "integer", + "format": "int64" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "individualPricing": { + "$ref": "#/components/schemas/B2bComponentsIndividualPricing" + } + }, + "type": "object" + }, + "B2bComponentsOrganizationJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "customerId", + "defaultShippingAddressId", + "defaultBillingAddressId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "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 + }, + "extensions": { + "properties": { + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/budgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignmentUnits": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignmentUnits" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment_unit" + }, + "id": { + "type": "string", + "example": "2de375eb5502ab387a10c69ea5789649" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "employees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/employees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + } + } + } + } + }, + "type": "object" + }, + "organizationCustomerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/organizationCustomerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization_customer_address" + }, + "id": { + "type": "string", + "example": "ada6a19a929bea8dbec29edb3d68df58" + } + } + } + } + }, + "type": "object" + }, + "paymentMethods": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/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": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/shippingMethods" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "shipping_method" + }, + "id": { + "type": "string", + "example": "8268b0a6c902fbde485094c2f627b854" + } + } + } + } + }, + "type": "object" + }, + "defaultShippingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8218c377171d06883caea7e2baf67f31" + } + } + } + }, + "type": "object" + }, + "defaultBillingAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/defaultBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "263d0f6e5d8d71fc4c288736f7c90990" + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/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": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/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" + } + ] + }, + "B2bComponentsOrganization": { + "required": [ + "id", + "name", + "customerId", + "defaultShippingAddressId", + "defaultBillingAddressId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, - "users": { + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/budgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignmentUnits": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignmentUnits" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment_unit" + }, + "id": { + "type": "string", + "example": "2de375eb5502ab387a10c69ea5789649" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization/59ca973b4d3a8dc22a45847c980f1152/individualPricingCompanyAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "employees": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/B2bEmployee" } }, - "app": { - "$ref": "#/components/schemas/App" + "organizationCustomerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsOrganizationCustomerAddress" + } }, - "integrations": { + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/Integration" + "$ref": "#/components/schemas/PaymentMethod" + } + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" } + }, + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "AclUserRole": { - "description": "Added since version: 6.0.0.0", + "B2bComponentsOrganizationCustomerAddressJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "organizationId", + "customerAddressId", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "organizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customerAddress": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-organization-customer-address/01f4816d6912a00b6c3f7cfd02672e16/customerAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ede14a49881da866970ac311e0ac78f8" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsOrganizationCustomerAddress": { "required": [ - "userId", - "aclRoleId" + "id", + "organizationId", + "customerAddressId", + "type" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "organizationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { + "customerAddressId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "type": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -26437,16 +46232,68 @@ "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "customerAddress": { + "$ref": "#/components/schemas/CustomerAddress" + } + }, + "type": "object" + }, + "B2bComponentsOrganizationPaymentMethod": { + "required": [ + "b2bComponentsOrganizationId", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "aclRole": { - "$ref": "#/components/schemas/AclRole" + "b2bComponentsOrganizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" }, - "AdvancedSearchActionJsonApi": { + "B2bComponentsOrganizationShippingMethod": { + "required": [ + "b2bComponentsOrganizationId", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganizationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "b2bComponentsOrganization": { + "$ref": "#/components/schemas/B2bComponentsOrganization" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "type": "object" + }, + "B2bComponentsPendingOrderJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -26454,37 +46301,205 @@ { "required": [ "id", - "configId", - "type", - "name" + "billingAddressId", + "customerId", + "employeeId", + "stateId", + "currencyId", + "countryId", + "salesChannelId", + "shippingMethodId", + "paymentMethodId", + "languageId", + "number", + "cartPayload", + "itemRounding", + "totalRounding", + "lineItemCount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "validFrom": { + "orderVersionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "validTo": { + "billingAddressId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "decidedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "approvalRuleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "number": { + "type": "string" + }, + "cartPayload": { + "type": "string" + }, + "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" + }, + "originalPrice": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reason": { + "type": "string" + }, + "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" }, - "type": { - "type": "string" + "lineItemCount": { + "type": "integer", + "format": "int64" }, - "name": { - "type": "string" + "designatedPayerIds": { + "type": "array", + "items": { + "type": "string" + } }, - "typeConfig": { + "customFields": { "type": "object" }, "createdAt": { @@ -26497,9 +46512,43 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { - "searchTerms": { + "order": { "properties": { "links": { "type": "object", @@ -26507,30 +46556,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/searchTerms" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/order" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_action_search_term" - }, - "id": { - "type": "string", - "example": "952c07f523c564f09844ca7f880c2467" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "config": { + "billingAddress": { "properties": { "links": { "type": "object", @@ -26538,7 +46585,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action/2a6023897ca55437c49e4a41b8f76f77/config" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/billingAddress" } } }, @@ -26547,125 +46594,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_config" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" + "example": "7fee8ff88b768662dd8fc06e1b6997d2" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AdvancedSearchAction": { - "required": [ - "id", - "configId", - "type", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { - "type": "string", - "format": "date-time" - }, - "active": { - "type": "boolean" - }, - "type": { - "type": "string" - }, - "name": { - "type": "string" - }, - "typeConfig": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "searchTerms": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchActionSearchTerm" - } - }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" - } - }, - "type": "object" - }, - "AdvancedSearchActionSearchTermJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "term", - "salesChannelId", - "actionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "term": { - "type": "string" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionId": { - "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": { + }, + "customer": { "properties": { "links": { "type": "object", @@ -26673,7 +46614,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/salesChannel" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/customer" } } }, @@ -26682,19 +46623,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "action": { + "employee": { "properties": { "links": { "type": "object", @@ -26702,7 +46643,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-action-search-term/a7e591b2d328bc4e62fbd4fd300da858/action" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/employee" } } }, @@ -26711,128 +46652,222 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_action" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "418c5509e2171d55b0aee5c2ea4442b5" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AdvancedSearchActionSearchTerm": { - "required": [ - "id", - "term", - "salesChannelId", - "actionId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "term": { - "type": "string" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "actionId": { - "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" - }, - "action": { - "$ref": "#/components/schemas/AdvancedSearchAction" - } - }, - "type": "object" - }, - "AdvancedSearchBoostingJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "boost", - "name", - "configId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "validFrom": { - "type": "string", - "format": "date-time" - }, - "validTo": { - "type": "string", - "format": "date-time" - }, - "boost": { - "type": "number", - "format": "float" - }, - "active": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "productStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entityStreamId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "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": { - "productStream": { + }, + "decidedBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/decidedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b293e6616bcffea8e393a4066a4a4230" + } + } + } + }, + "type": "object" + }, + "approvalRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/approvalRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2beeb3d6f9f7be5fb67d4cd9d9f9ba25" + } + } + } + }, + "type": "object" + }, + "stateMachineState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/stateMachineState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" + } + } + } + }, + "type": "object" + }, + "currency": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/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": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/country" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" + } + } + } + }, + "type": "object" + }, + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/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": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" + } + } + } + }, + "type": "object" + }, + "paymentMethod": { "properties": { "links": { "type": "object", @@ -26840,7 +46875,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/productStream" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/paymentMethod" } } }, @@ -26849,19 +46884,19 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "payment_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "49561f6faa0badfce831a183d2ec7c2f" + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, - "entityStream": { + "shippingMethod": { "properties": { "links": { "type": "object", @@ -26869,7 +46904,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/entityStream" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/shippingMethod" } } }, @@ -26878,19 +46913,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62acf68da615789a0175ef827f74acbb" + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "config": { + "addresses": { "properties": { "links": { "type": "object", @@ -26898,21 +46933,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-boosting/594f5cafa4dccca1634893a5a0a86ec9/config" + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/addresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } } } } @@ -26927,48 +46964,211 @@ } ] }, - "AdvancedSearchBoosting": { + "B2bComponentsPendingOrder": { + "description": "Added since version: 6.6.0.0", "required": [ "id", - "boost", - "name", - "configId" + "billingAddressId", + "customerId", + "employeeId", + "stateId", + "currencyId", + "countryId", + "salesChannelId", + "shippingMethodId", + "paymentMethodId", + "languageId", + "number", + "cartPayload", + "itemRounding", + "totalRounding", + "lineItemCount" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "validFrom": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "validTo": { + "orderVersionId": { "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "boost": { - "type": "number", - "format": "float" + "billingAddressId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "productStreamId": { + "decidedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "approvalRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "number": { + "type": "string" + }, + "cartPayload": { + "type": "string" + }, + "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" + }, + "originalPrice": { + "type": "number", + "format": "float" + }, + "taxStatus": { + "type": "string", + "readOnly": true + }, + "amountTotal": { + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "type": "number", + "format": "float", + "readOnly": true + }, + "reason": { + "type": "string" + }, + "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" + }, + "lineItemCount": { + "type": "integer", + "format": "int64" + }, + "designatedPayerIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -26979,19 +47179,90 @@ "format": "date-time", "readOnly": true }, - "productStream": { - "$ref": "#/components/schemas/ProductStream" + "extensions": { + "properties": { + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "entityStream": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "order": { + "$ref": "#/components/schemas/Order" }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" + "billingAddress": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "decidedBy": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "approvalRule": { + "$ref": "#/components/schemas/B2bComponentsApprovalRule" + }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState" + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + }, + "addresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" + } } }, "type": "object" }, - "AdvancedSearchConfigJsonApi": { + "B2bComponentsPendingOrderAddressJsonApi": { + "description": "Added since version: 6.6.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -26999,69 +47270,71 @@ { "required": [ "id", - "salesChannelId" + "countryId", + "pendingOrderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "esEnabled": { - "type": "boolean" + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "andLogic": { - "type": "boolean" + "pendingOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "minSearchLength": { - "type": "integer", - "format": "int64" + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "hitCount": { - "properties": { - "product": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "product_manufacturer": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "category": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - } - }, + "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": { @@ -27076,7 +47349,7 @@ }, "relationships": { "properties": { - "salesChannel": { + "country": { "properties": { "links": { "type": "object", @@ -27084,7 +47357,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/salesChannel" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/country" } } }, @@ -27093,50 +47366,106 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "fields": { + "countryState": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/countryState" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "country_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cb6a9764567191fb74fe28d8d6a4819d" + } + } + } + }, + "type": "object" + }, + "pendingOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/pendingOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1fd94955ea55110a2cf95eeb6fb1679f" + } + } + } + }, + "type": "object" + }, + "salutation": { "properties": { "links": { "type": "object", "properties": { "related": { "type": "string", - "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/fields" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "advanced_search_config_field" - }, - "id": { - "type": "string", - "example": "d05b6ed7d2345020440df396d6da7f73" - } + "format": "uri-reference", + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "boostings": { + "billingAddressPendingOrders": { "properties": { "links": { "type": "object", @@ -27144,7 +47473,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config/63246bc46dc5b3716c6f5f92044238e4/boostings" + "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/billingAddressPendingOrders" } } }, @@ -27155,11 +47484,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_boosting" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "8e571802e4ea39b214104ca60e13b5a6" + "example": "b4e47f63a7c39869d14bf20e25a45489" } } } @@ -27175,72 +47504,75 @@ } ] }, - "AdvancedSearchConfig": { + "B2bComponentsPendingOrderAddress": { + "description": "Added since version: 6.6.0.0", "required": [ "id", - "salesChannelId" + "countryId", + "pendingOrderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "esEnabled": { - "type": "boolean" + "countryStateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "andLogic": { - "type": "boolean" + "pendingOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "minSearchLength": { - "type": "integer", - "format": "int64" + "salutationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "hitCount": { - "properties": { - "product": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "product_manufacturer": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - }, - "category": { - "properties": { - "maxSuggestCount": { - "type": "integer", - "format": "int64" - }, - "maxSearchCount": { - "type": "integer", - "format": "int64" - } - }, - "type": "object" - } - }, + "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": { @@ -27253,25 +47585,28 @@ "format": "date-time", "readOnly": true }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "country": { + "$ref": "#/components/schemas/Country" }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AdvancedSearchConfigField" - } + "countryState": { + "$ref": "#/components/schemas/CountryState" }, - "boostings": { + "pendingOrder": { + "$ref": "#/components/schemas/B2bComponentsPendingOrder" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" + }, + "billingAddressPendingOrders": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "$ref": "#/components/schemas/B2bComponentsPendingOrder" } } }, "type": "object" }, - "AdvancedSearchConfigFieldJsonApi": { + "B2bComponentsRoleJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -27279,39 +47614,34 @@ { "required": [ "id", - "configId", - "entity", - "field" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldId": { + "businessPartnerCustomerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { + "name": { "type": "string" }, - "field": { - "type": "string" + "permissions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "tokenize": { - "type": "boolean" + "customFields": { + "type": "object" }, - "searchable": { + "default": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "ranking": { - "type": "integer", - "format": "int64" - }, "createdAt": { "type": "string", "format": "date-time", @@ -27322,9 +47652,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "config": { + "b2bBusinessPartner": { "properties": { "links": { "type": "object", @@ -27332,7 +47662,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/config" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" } } }, @@ -27341,19 +47671,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_config" + "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2245023265ae4cf87d02c8b6ba991139" + "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, - "customField": { + "b2bReviewerApprovalRules": { "properties": { "links": { "type": "object", @@ -27361,21 +47691,85 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-config-field/34ed84349128fa95e8aa7d3a69bd99c9/customField" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "25fd4841a35dd38cba144c6a480b52bb" + } + } + } + } + }, + "type": "object" + }, + "b2bAffectedApprovalRules": { + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "custom_field" - }, - "id": { + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "844042c07d902b98a574a2e21845c1e6" + } + } + } + } + }, + "type": "object" + }, + "reviewerBudgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ed2028a1c479c7e0065da597452d9c11" + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/reviewerBudgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "cc0b9649925b8bf844adbf00bc3b3346" + } } } } @@ -27384,106 +47778,10 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "AdvancedSearchConfigField": { - "required": [ - "id", - "configId", - "entity", - "field" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "configId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "entity": { - "type": "string" - }, - "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 - }, - "config": { - "$ref": "#/components/schemas/AdvancedSearchConfig" - }, - "customField": { - "$ref": "#/components/schemas/CustomField" - } - }, - "type": "object" - }, - "AdvancedSearchEntityStreamJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "apiFilter": { - "type": "object", - "readOnly": true - }, - "invalid": { - "type": "boolean", - "readOnly": true - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true }, "relationships": { "properties": { - "filters": { + "employees": { "properties": { "links": { "type": "object", @@ -27491,7 +47789,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/filters" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" } } }, @@ -27502,11 +47800,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "2c9885d2b0c7e26971f60a90f33cf718" + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } @@ -27514,7 +47812,7 @@ }, "type": "object" }, - "boosting": { + "businessPartnerCustomer": { "properties": { "links": { "type": "object", @@ -27522,7 +47820,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream/8bc027ef6b979dafaf6e1691bf314134/boosting" + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" } } }, @@ -27531,12 +47829,12 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_boosting" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "6ab105abdd48ced24ce7b0e516ca0970" + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } @@ -27551,26 +47849,36 @@ } ] }, - "AdvancedSearchEntityStream": { + "B2bComponentsRole": { "required": [ "id", - "type" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { "type": "string" }, - "apiFilter": { - "type": "object", - "readOnly": true + "permissions": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } }, - "invalid": { - "type": "boolean", - "readOnly": true + "customFields": { + "type": "object" + }, + "default": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, "createdAt": { "type": "string", @@ -27582,19 +47890,147 @@ "format": "date-time", "readOnly": true }, - "filters": { + "extensions": { + "properties": { + "b2bBusinessPartner": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bBusinessPartner" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_business_partner" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c1736d678c9ca2f952db2f7894193bf3" + } + } + } + }, + "type": "object" + }, + "b2bReviewerApprovalRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bReviewerApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "25fd4841a35dd38cba144c6a480b52bb" + } + } + } + } + }, + "type": "object" + }, + "b2bAffectedApprovalRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/b2bAffectedApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "844042c07d902b98a574a2e21845c1e6" + } + } + } + } + }, + "type": "object" + }, + "reviewerBudgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/reviewerBudgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "cc0b9649925b8bf844adbf00bc3b3346" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "employees": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "$ref": "#/components/schemas/B2bEmployee" } }, - "boosting": { - "$ref": "#/components/schemas/AdvancedSearchBoosting" + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" } }, "type": "object" }, - "AdvancedSearchEntityStreamFilterJsonApi": { + "B2bComponentsShoppingListJsonApi": { + "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -27602,40 +48038,48 @@ { "required": [ "id", - "entityStreamId", - "type" + "salesChannelId", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "type": "string" - }, - "field": { - "type": "string" + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "operator": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "value": { - "type": "string" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "parameters": { + "customFields": { "type": "object" }, - "position": { - "type": "integer", - "format": "int64" + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -27647,9 +48091,43 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { - "entityStream": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -27657,7 +48135,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/entityStream" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/salesChannel" } } }, @@ -27666,19 +48144,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62acf68da615789a0175ef827f74acbb" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "parent": { + "createdBy": { "properties": { "links": { "type": "object", @@ -27686,7 +48164,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/parent" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/createdBy" } } }, @@ -27695,19 +48173,19 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "34998857f537140306898d54d4b970dc" } } } }, "type": "object" }, - "queries": { + "updatedBy": { "properties": { "links": { "type": "object", @@ -27715,7 +48193,94 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-entity-stream-filter/910af2160df3a00f3843e6e06940790f/queries" + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" + } + } + } + }, + "type": "object" + }, + "employee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + } + } + } + }, + "type": "object" + }, + "lineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" } } }, @@ -27726,11 +48291,11 @@ "properties": { "type": { "type": "string", - "example": "advanced_search_entity_stream_filter" + "example": "b2b_components_shopping_list_line_item" }, "id": { "type": "string", - "example": "5da7eb4247add5dbd5776c9c0b38460a" + "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } @@ -27746,43 +48311,52 @@ } ] }, - "AdvancedSearchEntityStreamFilter": { + "B2bComponentsShoppingList": { + "description": "Added since version: 6.6.2.0", "required": [ "id", - "entityStreamId", - "type" + "salesChannelId", + "customerId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityStreamId": { + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "type": { - "type": "string" - }, - "field": { - "type": "string" + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "operator": { - "type": "string" + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "value": { - "type": "string" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "parameters": { + "customFields": { "type": "object" }, - "position": { - "type": "integer", - "format": "int64" + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } }, "createdAt": { "type": "string", @@ -27794,22 +48368,66 @@ "format": "date-time", "readOnly": true }, - "entityStream": { - "$ref": "#/components/schemas/AdvancedSearchEntityStream" + "extensions": { + "properties": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "parent": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "queries": { + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, + "lineItems": { "type": "array", "items": { - "$ref": "#/components/schemas/AdvancedSearchEntityStreamFilter" + "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" } } }, "type": "object" }, - "AdvancedSearchSynonymJsonApi": { + "B2bComponentsShoppingListLineItemJsonApi": { + "description": "Added since version: 6.6.2.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -27817,28 +48435,37 @@ { "required": [ "id", - "left" + "quantity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "left": { - "type": "array", - "items": { - "type": "string" - } + "shoppingListId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "right": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Price" } }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -27852,7 +48479,7 @@ }, "relationships": { "properties": { - "language": { + "shoppingList": { "properties": { "links": { "type": "object", @@ -27860,7 +48487,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/advanced-search-synonym/f8fe978e49caae961d38f793b4901801/language" + "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/shoppingList" } } }, @@ -27869,12 +48496,41 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "75cf6f56c85d6cbfe36939709500418b" + } + } + } + }, + "type": "object" + }, + "product": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/product" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } @@ -27889,31 +48545,41 @@ } ] }, - "AdvancedSearchSynonym": { + "B2bComponentsShoppingListLineItem": { + "description": "Added since version: 6.6.2.0", "required": [ "id", - "left" + "quantity" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "left": { - "type": "array", - "items": { - "type": "string" - } + "shoppingListId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "right": { + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Price" } }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "quantity": { + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -27925,125 +48591,36 @@ "format": "date-time", "readOnly": true }, - "language": { - "$ref": "#/components/schemas/Language" - } - }, - "type": "object" - }, - "AppJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "shoppingList": { + "$ref": "#/components/schemas/B2bComponentsShoppingList" }, - { - "required": [ - "id", - "name", - "path", - "version", - "integrationId", - "aclRoleId", - "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" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "label": { - "type": "string" - }, - "description": { - "type": "string" - }, - "privacyPolicyExtensions": { - "type": "string" - }, - "customFields": { - "type": "object" + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "B2bComponentsSubscriptionEmployeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "subscriptionId", + "employeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "integrationId": { + "subscriptionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "aclRoleId": { + "employeeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28057,12 +48634,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "integration": { + "subscription": { "properties": { "links": { "type": "object", @@ -28070,7 +48644,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/integration" + "example": "/b2b-components-subscription-employee/b233445cd710dfeed718800dc0818c4d/subscription" } } }, @@ -28079,19 +48653,19 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "776ea3bf11df5829827f7afb43c37174" + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, - "aclRole": { + "employee": { "properties": { "links": { "type": "object", @@ -28099,7 +48673,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/aclRole" + "example": "/b2b-components-subscription-employee/b233445cd710dfeed718800dc0818c4d/employee" } } }, @@ -28108,19 +48682,131 @@ "properties": { "type": { "type": "string", - "example": "acl_role" + "example": "b2b_employee" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "250aa1c64b973365fd6fd489eefbdefc" + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } }, "type": "object" - }, - "customFieldSets": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "B2bComponentsSubscriptionEmployee": { + "required": [ + "id", + "subscriptionId", + "employeeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "subscriptionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "subscription": { + "$ref": "#/components/schemas/Subscription" + }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + } + }, + "type": "object" + }, + "B2bEmployeeJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "languageId", + "firstName", + "lastName", + "email" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "email": { + "type": "string" + }, + "recoveryTime": { + "type": "string", + "format": "date-time" + }, + "customFields": { + "type": "object" + }, + "status": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "quotes": { "properties": { "links": { "type": "object", @@ -28128,7 +48814,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/customFieldSets" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" } } }, @@ -28139,11 +48825,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set" + "example": "quote_employee" }, "id": { "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -28151,7 +48837,7 @@ }, "type": "object" }, - "actionButtons": { + "quoteComments": { "properties": { "links": { "type": "object", @@ -28159,7 +48845,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/actionButtons" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quoteComments" } } }, @@ -28170,11 +48856,11 @@ "properties": { "type": { "type": "string", - "example": "app_action_button" + "example": "quote_comment" }, "id": { "type": "string", - "example": "2c7967427ed432e546ef1c0cb8d5da9e" + "example": "98dec49a83119c512f84645e81ea52d8" } } } @@ -28182,7 +48868,7 @@ }, "type": "object" }, - "templates": { + "organization": { "properties": { "links": { "type": "object", @@ -28190,61 +48876,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/templates" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" } } }, "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": { "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" - } + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" } } } }, "type": "object" }, - "paymentMethods": { + "b2bOrderEmployees": { "properties": { "links": { "type": "object", @@ -28252,7 +48905,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/paymentMethods" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" } } }, @@ -28263,11 +48916,11 @@ "properties": { "type": { "type": "string", - "example": "app_payment_method" + "example": "b2b_order_employee" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "6d4a2ca331b1f28767d02f210af4ac7b" } } } @@ -28275,7 +48928,7 @@ }, "type": "object" }, - "taxProviders": { + "subscriptionEmployees": { "properties": { "links": { "type": "object", @@ -28283,7 +48936,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/taxProviders" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/subscriptionEmployees" } } }, @@ -28294,11 +48947,11 @@ "properties": { "type": { "type": "string", - "example": "tax_provider" + "example": "b2b_components_subscription_employee" }, "id": { "type": "string", - "example": "01a1a9d428b6402dc8255d99c787a00e" + "example": "b4ee45a6e3ed163cb60859b89a0c7ce6" } } } @@ -28306,7 +48959,7 @@ }, "type": "object" }, - "cmsBlocks": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -28314,7 +48967,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" } } }, @@ -28325,11 +48978,11 @@ "properties": { "type": { "type": "string", - "example": "app_cms_block" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -28337,7 +48990,7 @@ }, "type": "object" }, - "flowActions": { + "b2bDecidedPendingOrders": { "properties": { "links": { "type": "object", @@ -28345,7 +48998,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowActions" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" } } }, @@ -28356,11 +49009,11 @@ "properties": { "type": { "type": "string", - "example": "app_flow_action" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "8d83a8af9d1b8b85dae9bdb76b7dbe7f" + "example": "c231abdb725547458353efbf48c35d43" } } } @@ -28368,7 +49021,7 @@ }, "type": "object" }, - "flowEvents": { + "shoppingLists": { "properties": { "links": { "type": "object", @@ -28376,7 +49029,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app/ac863f346e618f9a959b5c95d5d28941/flowEvents" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" } } }, @@ -28387,11 +49040,11 @@ "properties": { "type": { "type": "string", - "example": "app_flow_event" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "045e9ec14eafd26d17854fb4fe7c9cae" + "example": "efa2c2d016771a1e072e6b05091fb584" } } } @@ -28399,7 +49052,7 @@ }, "type": "object" }, - "appShippingMethods": { + "budgetNotifications": { "properties": { "links": { "type": "object", @@ -28407,286 +49060,35 @@ "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" - } + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/budgetNotifications" } } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "App": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "name", - "path", - "version", - "integrationId", - "aclRoleId", - "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" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "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", - "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": { + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "a6b1894d8fb4962df1b416d3a3241bbb" + } + } + } + } + }, + "type": "object" + } + }, "type": "object" }, "relationships": { "properties": { - "app": { + "businessPartnerCustomer": { "properties": { "links": { "type": "object", @@ -28694,7 +49096,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-action-button/5c44158189757c2cf5f047ce1fe3e634/app" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/businessPartnerCustomer" } } }, @@ -28703,217 +49105,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppActionButton": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "entity", - "view", - "url", - "action", - "appId", - "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" - ], - "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" - ], - "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", - "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": { + }, + "role": { "properties": { "links": { "type": "object", @@ -28921,7 +49125,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/role" } } }, @@ -28930,12 +49134,41 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "b2b_components_role" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "29a7e96467b69a9f5a93332e29e9b0de" + } + } + } + }, + "type": "object" + }, + "language": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/language" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } @@ -28950,40 +49183,54 @@ } ] }, - "AppCmsBlock": { - "description": "Added since version: 6.4.2.0", + "B2bEmployee": { "required": [ "id", - "name", - "block", - "template", - "styles", - "appId", - "label" + "languageId", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true }, - "block": { - "type": "object" + "businessPartnerCustomerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "template": { + "roleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "styles": { + "lastName": { "type": "string" }, - "label": { + "email": { "type": "string" }, - "appId": { + "recoveryTime": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" + }, + "customFields": { + "type": "object" + }, + "status": { + "type": "string" }, "createdAt": { "type": "string", @@ -28995,266 +49242,301 @@ "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", - "label" - ], + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "badge": { - "type": "string" - }, - "parameters": { + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_employee" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, "type": "object" }, - "config": { + "quoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } + } + } + } + }, "type": "object" }, - "headers": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, "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" + "b2bOrderEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bOrderEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_order_employee" + }, + "id": { + "type": "string", + "example": "6d4a2ca331b1f28767d02f210af4ac7b" + } + } + } + } + }, + "type": "object" }, - "customFields": { + "subscriptionEmployees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/subscriptionEmployees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_employee" + }, + "id": { + "type": "string", + "example": "b4ee45a6e3ed163cb60859b89a0c7ce6" + } + } + } + } + }, "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, "type": "object" }, - "relationships": { + "b2bDecidedPendingOrders": { "properties": { - "app": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/b2bDecidedPendingOrders" } - }, - "type": "object" + } }, - "flowSequences": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c231abdb725547458353efbf48c35d43" + } + } + } + } + }, + "type": "object" + }, + "shoppingLists": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/flowSequences" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/shoppingLists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" - } - } + } + } + } + }, + "type": "object" + }, + "budgetNotifications": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/budgetNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "a6b1894d8fb4962df1b416d3a3241bbb" } } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "AppFlowAction": { - "description": "Added since version: 6.4.10.0", - "required": [ - "id", - "appId", - "name", - "url", - "label" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appId": { - "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" + "businessPartnerCustomer": { + "$ref": "#/components/schemas/Customer" }, - "app": { - "$ref": "#/components/schemas/App" + "role": { + "$ref": "#/components/schemas/B2bComponentsRole" }, - "flowSequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } + "language": { + "$ref": "#/components/schemas/Language" } }, "type": "object" }, - "AppFlowEventJsonApi": { - "description": "Added since version: 6.5.2.0", + "B2bOrderEmployeeJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -29262,30 +49544,36 @@ { "required": [ "id", - "appId", - "name", - "aware" + "orderId", + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "aware": { - "type": "array", - "items": { - "type": "string" - } + "lastName": { + "type": "string" }, - "customFields": { - "type": "object" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -29299,7 +49587,7 @@ }, "relationships": { "properties": { - "app": { + "order": { "properties": { "links": { "type": "object", @@ -29307,7 +49595,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/app" + "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/order" } } }, @@ -29316,19 +49604,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "flows": { + "employee": { "properties": { "links": { "type": "object", @@ -29336,23 +49624,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-flow-event/ee419db2bca734414b0df87b3a919831/flows" + "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/employee" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "example": "0db2dd944f9ee9a131f44b79d331d371" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" } } } @@ -29367,34 +49653,39 @@ } ] }, - "AppFlowEvent": { - "description": "Added since version: 6.5.2.0", + "B2bOrderEmployee": { "required": [ "id", - "appId", - "name", - "aware" + "orderId", + "firstName", + "lastName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "appId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { "type": "string" }, - "aware": { - "type": "array", - "items": { - "type": "string" - } + "lastName": { + "type": "string" }, - "customFields": { - "type": "object" + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -29406,20 +49697,16 @@ "format": "date-time", "readOnly": true }, - "app": { - "$ref": "#/components/schemas/App" + "order": { + "$ref": "#/components/schemas/Order" }, - "flows": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" - } + "employee": { + "$ref": "#/components/schemas/B2bEmployee" } }, "type": "object" }, - "AppPaymentMethodJsonApi": { - "description": "Added since version: 6.4.1.0", + "B2bPermissionJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -29427,50 +49714,25 @@ { "required": [ "id", - "appName", - "identifier", - "paymentMethodId" + "name", + "group" ], "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": { + "name": { "type": "string" }, - "recurringUrl": { + "group": { "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}$" + "dependencies": { + "type": "array", + "items": { + "type": "string" + } }, "createdAt": { "type": "string", @@ -29481,152 +49743,34 @@ "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", + }, + "B2bPermission": { "required": [ "id", - "appName", - "identifier", - "paymentMethodId" + "name", + "group" ], "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": { + "name": { "type": "string" }, - "recurringUrl": { + "group": { "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}$" + "dependencies": { + "type": "array", + "items": { + "type": "string" + } }, "createdAt": { "type": "string", @@ -29637,21 +49781,12 @@ "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", + "ProductJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -29659,9 +49794,10 @@ { "required": [ "id", - "identifier", - "active", - "appId", + "taxId", + "price", + "productNumber", + "stock", "name" ], "properties": { @@ -29669,27 +49805,321 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "name": { + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "manufacturerId": { + "description": "Unique identity of the manufacturer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "description": "Unique identity of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "featureSetId": { + "description": "Unique identity of feature set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, + "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", + "type": "integer", + "format": "int64" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, - "group": { + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", + "readOnly": true + }, + "isCloseout": { + "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", + "format": "int64" + }, + "variation": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, - "script": { + "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, - "config": { - "type": "object" + "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", + "type": "integer", + "format": "int64" }, - "appId": { + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" + }, + "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", + "type": "number", + "format": "float" + }, + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" + }, + "purchasePrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" + }, + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" + }, + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" + }, + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" + }, + "length": { + "description": "The length of the product.", + "type": "number", + "format": "float" + }, + "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" + }, + "ratingAverage": { + "description": "Average of all the ratings.", + "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": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", + "type": "boolean" + }, + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "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 + } + }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true }, "createdAt": { "type": "string", @@ -29704,9 +50134,9 @@ "translated": { "type": "object" }, - "relationships": { + "extensions": { "properties": { - "app": { + "customPrice": { "properties": { "links": { "type": "object", @@ -29714,28 +50144,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" + "example": "/product/deb10517653c255364175796ace3553f/customPrice" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } } } } }, "type": "object" }, - "ruleConditions": { + "subscriptionPlans": { "properties": { "links": { "type": "object", @@ -29743,7 +50175,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/ruleConditions" + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" } } }, @@ -29754,136 +50186,50 @@ "properties": { "type": { "type": "string", - "example": "rule_condition" + "example": "subscription_plan" }, "id": { "type": "string", - "example": "24bfabce4195894c9aed9b8bcfb0b748" + "example": "ed94874505da2886dc66a3a3d3968972" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppScriptCondition": { - "description": "Added since version: 6.4.10.3", - "required": [ - "id", - "identifier", - "active", - "appId", - "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" - ], - "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": { + }, + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } + } + }, + "type": "object" + }, + "warehouses": { "properties": { "links": { "type": "object", @@ -29891,28 +50237,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/app" + "example": "/product/deb10517653c255364175796ace3553f/warehouses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_warehouse" + }, + "id": { + "type": "string", + "example": "544959798565126142ca2820b4f56271" + } } } } }, "type": "object" }, - "shippingMethod": { + "orderWarehouses": { "properties": { "links": { "type": "object", @@ -29920,28 +50268,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/shippingMethod" + "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "5331369e2f71d048521bd35d80975314" + } } } } }, "type": "object" }, - "originalMedia": { + "reviewSummaries": { "properties": { "links": { "type": "object", @@ -29949,133 +50299,33 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-shipping-method/de94cc387f2598e321fc402da2abda66/originalMedia" + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "56386c66f82d9cd5639a5a7447971ead" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "c9c718522e64ffa5effb26cef94f4849" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppShippingMethod": { - "description": "Added since version: 6.5.7.0", - "required": [ - "id", - "appName", - "identifier", - "shippingMethodId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "originalMedia": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "template", - "path", - "active", - "appId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "template": { - "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": { + }, + "search": { + "type": "object" + }, + "quoteLineItems": { "properties": { "links": { "type": "object", @@ -30083,116 +50333,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/app-template/ca9106b8b82ff55b6fdce530ccb952a7/app" + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "AppTemplate": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "template", - "path", - "active", - "appId" - ], - "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" - }, - "B2bBusinessPartnerJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultRoleId": { - "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": { - "customer": { + }, + "shoppingListLineItems": { "properties": { "links": { "type": "object", @@ -30200,28 +50364,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/customer" + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "ce593c6d1db236f22dc387a2ee20dfd6" + } } } } }, "type": "object" }, - "defaultRole": { + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", "properties": { "links": { "type": "object", @@ -30229,134 +50396,96 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-business-partner/7ba58cf5989d881e8226f193613ed414/defaultRole" + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "d7706d2e11bc4878ffb242403ea5b274" + } + } + } + } + }, + "type": "object" + }, + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "b2b_components_role" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2944ea414640901d532eba5106eb706b" + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bBusinessPartner": { - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultRoleId": { - "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 - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "defaultRole": { - "$ref": "#/components/schemas/B2bComponentsRole" - } - }, - "type": "object" - }, - "B2bComponentsApprovalRuleJsonApi": { - "description": "Added since version: 6.6.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "priority", - "active", - "conditions" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "conditions": { - "type": "object" - }, - "reviewerRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "affectedRoleId": { - "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": { - "businessPartnerCustomer": { + }, + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" + } + } + } + } + }, + "type": "object", + "readOnly": true + }, + "items": { + "description": "Products referenced as bundle items of this bundle.", "properties": { "links": { "type": "object", @@ -30364,28 +50493,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/businessPartnerCustomer" + "example": "/product/deb10517653c255364175796ace3553f/items" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "691d502cfd0e0626cd3b058e5682ad1c" + } } } } }, "type": "object" }, - "reviewerRole": { + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", "properties": { "links": { "type": "object", @@ -30393,28 +50525,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/reviewerRole" + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_role" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "06ec286ee4d03afb4028caa32c0ef40b" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" + } } } } }, "type": "object" }, - "affectedRole": { + "bundles": { + "description": "Bundles that include this product as an item.", "properties": { "links": { "type": "object", @@ -30422,156 +50557,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule/7181d2e3f46190b96b7cb8242c761a03/affectedRole" + "example": "/product/deb10517653c255364175796ace3553f/bundles" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_role" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "33237c6057eedd7b8c978f77270af3b1" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "9e21e19f42862a3b26cd7aae135a3f74" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bComponentsApprovalRule": { - "description": "Added since version: 6.6.0.0", - "required": [ - "id", - "name", - "priority", - "active", - "conditions" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "priority": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "conditions": { - "type": "object" - }, - "reviewerRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "affectedRoleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" - }, - "reviewerRole": { - "$ref": "#/components/schemas/B2bComponentsRole" - }, - "affectedRole": { - "$ref": "#/components/schemas/B2bComponentsRole" - } - }, - "type": "object" - }, - "B2bComponentsApprovalRuleAppScriptConditionJsonApi": { - "description": "Added since version: 6.6.3.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "identifier", - "active", - "appId", - "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": { + }, + "employeeWishlists": { "properties": { "links": { "type": "object", @@ -30579,313 +50588,98 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-approval-rule-app-script-condition/031e11005a97d52a5c7950ff98b5f2bb/app" + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist_product" + }, + "id": { + "type": "string", + "example": "e91afc4e24376c8b995cece3ce354b4e" + } + } + } + } + }, + "type": "object" + }, + "individualPricingComputedCaches": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "app" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/individualPricingComputedCaches" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_computed_cache" + }, + "id": { + "type": "string", + "example": "0208611f8e65e3ceffe9b336ea836127" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bComponentsApprovalRuleAppScriptCondition": { - "description": "Added since version: 6.6.3.0", - "required": [ - "id", - "identifier", - "active", - "appId", - "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" - } - }, - "type": "object" - }, - "B2bComponentsPendingOrderJsonApi": { - "description": "Added since version: 6.6.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "billingAddressId", - "customerId", - "employeeId", - "stateId", - "currencyId", - "countryId", - "salesChannelId", - "shippingMethodId", - "paymentMethodId", - "languageId", - "number", - "cartPayload", - "itemRounding", - "totalRounding", - "lineItemCount" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "decidedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "approvalRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "number": { - "type": "string" - }, - "cartPayload": { - "type": "string" - }, - "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" - }, - "originalPrice": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reason": { - "type": "string" - }, - "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" + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, - "lineItemCount": { - "type": "integer", - "format": "int64" - }, - "designatedPayerIds": { - "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": { - "order": { + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -30893,7 +50687,39 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/order" + "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": { + "description": "Unique identity of the product.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/parent" } } }, @@ -30902,19 +50728,20 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "billingAddress": { + "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -30922,7 +50749,39 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/billingAddress" + "example": "/product/deb10517653c255364175796ace3553f/children" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } + } + } + } + }, + "type": "object" + }, + "deliveryTime": { + "description": "Estimated delivery time for the product", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" } } }, @@ -30931,19 +50790,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order_address" + "example": "delivery_time" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7fee8ff88b768662dd8fc06e1b6997d2" + "example": "8c888ae25a7bd42057370e31f7e01044" } } } }, "type": "object" }, - "customer": { + "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -30951,7 +50811,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/customer" + "example": "/product/deb10517653c255364175796ace3553f/tax" } } }, @@ -30960,19 +50820,20 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "tax" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "06565e5611f23fdf8cc43e5077b92b54" } } } }, "type": "object" }, - "employee": { + "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -30980,7 +50841,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/employee" + "example": "/product/deb10517653c255364175796ace3553f/manufacturer" } } }, @@ -30989,19 +50850,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "product_manufacturer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "example": "c2904bca62b22443d6cf5e9d89cab204" } } } }, "type": "object" }, - "decidedBy": { + "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -31009,7 +50871,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/decidedBy" + "example": "/product/deb10517653c255364175796ace3553f/unit" } } }, @@ -31018,19 +50880,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "unit" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "b293e6616bcffea8e393a4066a4a4230" + "example": "3e34bdebd9bd5edda27e8728904a2552" } } } }, "type": "object" }, - "approvalRule": { + "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", @@ -31038,7 +50901,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/approvalRule" + "example": "/product/deb10517653c255364175796ace3553f/cover" } } }, @@ -31047,19 +50910,19 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_approval_rule" + "example": "product_media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2beeb3d6f9f7be5fb67d4cd9d9f9ba25" + "example": "41d0e299ca1abeb2094852da042165c7" } } } }, "type": "object" }, - "stateMachineState": { + "featureSet": { "properties": { "links": { "type": "object", @@ -31067,7 +50930,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/stateMachineState" + "example": "/product/deb10517653c255364175796ace3553f/featureSet" } } }, @@ -31076,19 +50939,20 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "product_feature_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" } } } }, "type": "object" }, - "currency": { + "cmsPage": { + "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", @@ -31096,7 +50960,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/currency" + "example": "/product/deb10517653c255364175796ace3553f/cmsPage" } } }, @@ -31105,19 +50969,20 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, - "country": { + "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", @@ -31125,7 +50990,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/country" + "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" } } }, @@ -31134,19 +50999,19 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "023995a50b56c0de077323e958b2bbcd" } } } }, "type": "object" }, - "salesChannel": { + "prices": { "properties": { "links": { "type": "object", @@ -31154,28 +51019,94 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/salesChannel" + "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": { + "description": "Product images and media gallery", + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "sales_channel" - }, - "id": { + "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": { + "description": "Cross-selling configurations (related products, accessories, similar items)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "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" }, - "language": { + "crossSellingAssignedProducts": { "properties": { "links": { "type": "object", @@ -31183,28 +51114,283 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/language" + "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": { + "description": "Variant configurator settings defining available options for product variants", + "properties": { + "links": { "type": "object", "properties": { - "type": { + "related": { "type": "string", - "example": "language" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "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": { + "description": "Customer reviews and ratings for the product", + "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": { + "description": "Primary category assignments per sales channel for SEO and navigation", + "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": { + "description": "SEO-friendly URLs for the product across different sales channels", + "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" }, - "paymentMethod": { + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -31212,28 +51398,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/paymentMethod" + "example": "/product/deb10517653c255364175796ace3553f/options" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "93da65a9fd0004d9477aeac024e08e15" + } } } } }, "type": "object" }, - "shippingMethod": { + "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -31241,28 +51430,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/shippingMethod" + "example": "/product/deb10517653c255364175796ace3553f/properties" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "shipping_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "property_group_option" + }, + "id": { + "type": "string", + "example": "74693d2fc58b46bd06410f278e39aa71" + } } } } }, "type": "object" }, - "addresses": { + "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -31270,7 +51462,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order/e87c4279c6f83e4de2543a63bf59b373/addresses" + "example": "/product/deb10517653c255364175796ace3553f/categories" } } }, @@ -31281,378 +51473,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order_address" + "example": "category" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "b0b5ccb4a195a07fd3eed14affb8695f" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bComponentsPendingOrder": { - "description": "Added since version: 6.6.0.0", - "required": [ - "id", - "billingAddressId", - "customerId", - "employeeId", - "stateId", - "currencyId", - "countryId", - "salesChannelId", - "shippingMethodId", - "paymentMethodId", - "languageId", - "number", - "cartPayload", - "itemRounding", - "totalRounding", - "lineItemCount" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "billingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "decidedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "approvalRuleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "paymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "number": { - "type": "string" - }, - "cartPayload": { - "type": "string" - }, - "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" - }, - "originalPrice": { - "type": "number", - "format": "float" - }, - "taxStatus": { - "type": "string", - "readOnly": true - }, - "amountTotal": { - "type": "number", - "format": "float", - "readOnly": true - }, - "amountNet": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reason": { - "type": "string" - }, - "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" - }, - "lineItemCount": { - "type": "integer", - "format": "int64" - }, - "designatedPayerIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "billingAddress": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" - }, - "decidedBy": { - "$ref": "#/components/schemas/B2bEmployee" - }, - "approvalRule": { - "$ref": "#/components/schemas/B2bComponentsApprovalRule" - }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "currency": { - "$ref": "#/components/schemas/Currency" - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - }, - "language": { - "$ref": "#/components/schemas/Language" - }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bComponentsPendingOrderAddress" - } - } - }, - "type": "object" - }, - "B2bComponentsPendingOrderAddressJsonApi": { - "description": "Added since version: 6.6.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "countryId", - "pendingOrderId", - "firstName", - "lastName", - "street", - "city" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "countryStateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "pendingOrderId": { - "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": { + }, + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -31660,28 +51494,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/country" + "example": "/product/deb10517653c255364175796ace3553f/streams" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_stream" + }, + "id": { + "type": "string", + "example": "2f6f4768f1c2d7c8f1f54823723f1a70" + } } } } }, "type": "object" }, - "countryState": { + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -31689,28 +51526,31 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/countryState" + "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "7f0702d3a90d965b8c9158c451f43fdb" + } } } } }, "type": "object" }, - "pendingOrder": { + "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -31718,28 +51558,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/pendingOrder" + "example": "/product/deb10517653c255364175796ace3553f/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1fd94955ea55110a2cf95eeb6fb1679f" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "salutation": { + "customFieldSets": { "properties": { "links": { "type": "object", @@ -31747,21 +51589,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-components-pending-order-address/4fce37927007500103484410b28f4b34/salutation" + "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "salutation" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set" + }, + "id": { + "type": "string", + "example": "9b29ba872ce510f033b31364c8602760" + } } } } @@ -31776,77 +51620,337 @@ } ] }, - "B2bComponentsPendingOrderAddress": { - "description": "Added since version: 6.6.0.0", + "Product": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "countryId", - "pendingOrderId", - "firstName", - "lastName", - "street", - "city" + "taxId", + "price", + "productNumber", + "stock", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryStateId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pendingOrderId": { + "parentVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "productManufacturerVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "lastName": { - "type": "string" + "unitId": { + "description": "Unique identity of the unit.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "street": { + "taxId": { + "description": "Unique identity of tax.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productMediaVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "deliveryTimeId": { + "description": "Unique identity of delivery time.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "featureSetId": { + "description": "Unique identity of feature set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductId": { + "description": "Unique identity of canonical product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "canonicalProductVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageId": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, - "zipcode": { + "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", + "type": "integer", + "format": "int64" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", + "type": "boolean" + }, + "available": { + "description": "Indicates weather the product is available or not.", + "type": "boolean", + "readOnly": true + }, + "isCloseout": { + "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", + "format": "int64" + }, + "variation": { + "type": "array", + "items": { + "type": "string" + } + }, + "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "variantListingConfig": { + "type": "object" + }, + "variantRestrictions": { + "type": "object" + }, + "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, - "city": { + "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, - "company": { + "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", + "type": "integer", + "format": "int64" + }, + "maxPurchase": { + "description": "Maximum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "minPurchase": { + "description": "Minimum number of items that can be purchased.", + "type": "integer", + "format": "int64" + }, + "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", + "type": "number", + "format": "float" + }, + "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", + "type": "number", + "format": "float" + }, + "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", + "type": "boolean" + }, + "purchasePrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Price" + } + }, + "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", + "type": "boolean" + }, + "weight": { + "description": "The weight of the product.", + "type": "number", + "format": "float" + }, + "width": { + "description": "The width of the product.", + "type": "number", + "format": "float" + }, + "height": { + "description": "The height of the product.", + "type": "number", + "format": "float" + }, + "length": { + "description": "The length of the product.", + "type": "number", + "format": "float" + }, + "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", + "type": "string", + "format": "date-time" + }, + "ratingAverage": { + "description": "Average of all the ratings.", + "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": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", + "type": "boolean" + }, + "sales": { + "description": "Frequency of the product sales.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaDescription": { "type": "string" }, - "department": { + "name": { "type": "string" }, - "title": { + "keywords": { "type": "string" }, - "vatId": { + "description": { "type": "string" }, - "phoneNumber": { + "metaTitle": { "type": "string" }, - "additionalAddressLine1": { + "packUnit": { "type": "string" }, - "additionalAddressLine2": { + "packUnitPlural": { "type": "string" }, "customFields": { "type": "object" }, + "slotConfig": { + "type": "object" + }, + "customSearchKeywords": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -31857,686 +51961,731 @@ "format": "date-time", "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "pendingOrder": { - "$ref": "#/components/schemas/B2bComponentsPendingOrder" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - } - }, - "type": "object" - }, - "B2bComponentsRoleJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "translated": { + "type": "object" }, - { - "required": [ - "id", - "name" - ], + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customPrice": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/customPrice" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "subscriptionPlans": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_plan" + }, + "id": { + "type": "string", + "example": "ed94874505da2886dc66a3a3d3968972" + } + } + } + } + }, + "type": "object" }, - "name": { - "type": "string" + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } + } + }, + "type": "object" }, - "permissions": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "warehouses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/warehouses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_warehouse" + }, + "id": { + "type": "string", + "example": "544959798565126142ca2820b4f56271" + } + } + } + } + }, + "type": "object" }, - "customFields": { + "orderWarehouses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "5331369e2f71d048521bd35d80975314" + } + } + } + } + }, + "type": "object" + }, + "reviewSummaries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "c9c718522e64ffa5effb26cef94f4849" + } + } + } + } + }, "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "search": { + "type": "object" }, - "relationships": { + "quoteLineItems": { "properties": { - "employees": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/employees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" } - }, - "type": "object" + } }, - "businessPartnerCustomer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-role/a2f4fa227c09d6222701f670a01bb0b0/businessPartnerCustomer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" } } - }, - "type": "object" + } } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "B2bComponentsRole": { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "businessPartnerCustomerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "employees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/B2bEmployee" - } - }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" - } - }, - "type": "object" - }, - "B2bComponentsShoppingListJsonApi": { - "description": "Added since version: 6.6.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "salesChannelId", - "customerId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { + "shoppingListLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list_line_item" + }, + "id": { + "type": "string", + "example": "ce593c6d1db236f22dc387a2ee20dfd6" + } + } + } + } + }, "type": "object" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } + "bundleItems": { + "description": "Bundle items assigned to this grouped bundle product.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "d7706d2e11bc4878ffb242403ea5b274" + } + } + } + } + }, + "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "bundleDiscounts": { + "description": "Discount configurations that belong to this bundle.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", + "bundleSalesChannels": { + "description": "Sales channels in which this bundle is available.", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundleSalesChannels" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "d4aa52cb00cd89c5e047c6a5c72a0384" + } + } + } + } + }, + "type": "object", "readOnly": true }, - "relationships": { + "items": { + "description": "Products referenced as bundle items of this bundle.", "properties": { - "salesChannel": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/items" } - }, - "type": "object" + } }, - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "691d502cfd0e0626cd3b058e5682ad1c" } } - }, - "type": "object" - }, - "updatedBy": { + } + } + }, + "type": "object" + }, + "belongToBundleItems": { + "description": "Reference to the bundle item definition when this product acts as a bundle item.", + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/updatedBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/belongToBundleItems" } - }, - "type": "object" + } }, - "customer": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_item" + }, + "id": { + "type": "string", + "example": "db4ef6a91ceb3a70935c07a3617ea4cd" + } + } + } + } + }, + "type": "object" + }, + "bundles": { + "description": "Bundles that include this product as an item.", + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/customer" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/bundles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "9e21e19f42862a3b26cd7aae135a3f74" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } + } + } + } + }, + "type": "object" + }, + "employeeWishlists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/employeeWishlists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_employee_wishlist_product" + }, + "id": { + "type": "string", + "example": "e91afc4e24376c8b995cece3ce354b4e" } } - }, - "type": "object" - }, - "employee": { + } + } + }, + "type": "object" + }, + "individualPricingComputedCaches": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/employee" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/individualPricingComputedCaches" } - }, - "type": "object" + } }, - "lineItems": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list/23cb3bfda723e05b43cb25a427ee5a25/lineItems" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_computed_cache" + }, + "id": { + "type": "string", + "example": "0208611f8e65e3ceffe9b336ea836127" } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list_line_item" - }, - "id": { - "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" - } - } + } + } + } + }, + "type": "object" + }, + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product/deb10517653c255364175796ace3553f/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" } } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "B2bComponentsShoppingList": { - "description": "Added since version: 6.6.2.0", - "required": [ - "id", - "salesChannelId", - "customerId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductDownload" + } }, - "active": { - "type": "boolean" + "parent": { + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "children": { + "description": "Product variants that inherit from this parent product", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "tax": { + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "manufacturer": { + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, - "employeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unit": { + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, - "customFields": { - "type": "object" + "cover": { + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, - "price": { + "featureSet": { + "$ref": "#/components/schemas/ProductFeatureSet" + }, + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" + }, + "canonicalProduct": { + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" + }, + "prices": { "type": "array", "items": { - "$ref": "#/components/schemas/Price" + "$ref": "#/components/schemas/ProductPrice" } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "media": { + "description": "Product images and media gallery", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductMedia" + } }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSelling" + } }, - "createdBy": { - "$ref": "#/components/schemas/User" + "crossSellingAssignedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" + } }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductConfiguratorSetting" + } }, - "customer": { - "$ref": "#/components/schemas/Customer" + "visibilities": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductVisibility" + } }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "searchKeywords": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchKeyword" + } }, - "lineItems": { + "productReviews": { + "description": "Customer reviews and ratings for the product", "type": "array", "items": { - "$ref": "#/components/schemas/B2bComponentsShoppingListLineItem" + "$ref": "#/components/schemas/ProductReview" } - } - }, - "type": "object" - }, - "B2bComponentsShoppingListLineItemJsonApi": { - "description": "Added since version: 6.6.2.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" }, - { - "required": [ - "id", - "quantity" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shoppingListId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "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": { - "shoppingList": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/shoppingList" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "75cf6f56c85d6cbfe36939709500418b" - } - } - } - }, - "type": "object" - }, - "product": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-components-shopping-list-line-item/30d48c8d92682de24e11d3f72c5dd1ea/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" - } - ] - }, - "B2bComponentsShoppingListLineItem": { - "description": "Added since version: 6.6.2.0", - "required": [ - "id", - "quantity" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } }, - "shoppingListId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" + } }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "orderLineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItem" + } }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "wishlists": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerWishlistProduct" + } }, - "price": { + "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "type": "array", "items": { - "$ref": "#/components/schemas/Price" + "$ref": "#/components/schemas/PropertyGroupOption" } }, - "quantity": { - "type": "integer", - "format": "int64" + "properties": { + "description": "Product properties and characteristics for filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroupOption" + } }, - "customFields": { - "type": "object" + "categories": { + "description": "Categories this product is assigned to", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductStream" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } }, - "shoppingList": { - "$ref": "#/components/schemas/B2bComponentsShoppingList" + "tags": { + "description": "Tags for organizing and filtering products", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "product": { - "$ref": "#/components/schemas/Product" + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" + } } }, "type": "object" }, - "B2bEmployeeJsonApi": { + "BundleDiscountJsonApi": { + "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -32544,125 +52693,78 @@ { "required": [ "id", - "languageId", - "firstName", - "lastName", - "email" + "bundleId", + "type", + "value" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "versionId": { + "description": "Version identifier of the bundle discount entity.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "roleId": { + "bundleId": { + "description": "Bundle product that owns this discount configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "active": { - "type": "boolean" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "email": { + "type": { + "description": "Discount calculation type (absolute or percentage).", "type": "string" }, - "recoveryTime": { - "type": "string", - "format": "date-time" + "active": { + "description": "Indicates if the discount is currently active.", + "type": "boolean" }, - "customFields": { - "type": "object" + "value": { + "description": "Discount amount or percentage value applied to the bundle.", + "type": "number", + "format": "float" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "maxValue": { + "description": "Optional absolute ceiling for discount application.", + "type": "number", + "format": "float" }, - "updatedAt": { + "currencyId": { + "description": "Currency that an absolute discount value refers to.", "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_employee" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "pattern": "^[0-9a-f]{32}$" + }, + "preventCombination": { + "description": "Whether this discount blocks other promotion combinations.", + "type": "boolean" + }, + "exclusionIds": { + "type": "array", + "items": { + "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": { - "businessPartnerCustomer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/businessPartnerCustomer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "798b3bbcdcbca2ce67fe2ef0d7d28cbf" - } - } - } - }, - "type": "object" - }, - "role": { + "currency": { + "description": "Currency entity linked to the discount.", "properties": { "links": { "type": "object", @@ -32670,7 +52772,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/role" + "example": "/bundle-discount/4c760d31c64d2481f1cd5ad19ff22543/currency" } } }, @@ -32679,19 +52781,20 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "29a7e96467b69a9f5a93332e29e9b0de" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "language": { + "rules": { + "description": "Business rules that must match for the discount to apply.", "properties": { "links": { "type": "object", @@ -32699,21 +52802,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/language" + "example": "/bundle-discount/4c760d31c64d2481f1cd5ad19ff22543/rules" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "example": "a4f86f7bfc24194b276c22e0ef158197" + } } } } @@ -32728,49 +52833,71 @@ } ] }, - "B2bEmployee": { + "BundleDiscount": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "languageId", - "firstName", - "lastName", - "email" + "type", + "value", + "active", + "preventCombination" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "businessPartnerCustomerId": { + "versionId": { + "description": "Version identifier of the bundle discount entity.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "roleId": { + "bundleId": { + "description": "Bundle product that owns this discount configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "languageId": { + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "type": { + "description": "Discount calculation type (absolute or percentage).", + "type": "string", + "enum": [ + "absolute", + "percentage" + ] + }, "active": { + "description": "Indicates if the discount is currently active.", "type": "boolean" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" + "value": { + "description": "Discount amount or percentage value applied to the bundle.", + "type": "number", + "format": "float" }, - "email": { - "type": "string" + "maxValue": { + "description": "Optional absolute ceiling for discount application.", + "type": "number", + "format": "float" }, - "recoveryTime": { + "currencyId": { + "description": "Currency that an absolute discount value refers to.", "type": "string", - "format": "date-time" + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "preventCombination": { + "description": "Whether this discount blocks other promotion combinations.", + "type": "boolean" + }, + "exclusionIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } }, "createdAt": { "type": "string", @@ -32782,55 +52909,63 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/b2b-employee/1131eb0b1859b37129289fe3bcc9e70b/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_employee" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Currency entity linked to the discount." }, - "businessPartnerCustomer": { - "$ref": "#/components/schemas/Customer" + "rules": { + "description": "Business rules that must match for the discount to apply.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Rule" + } }, - "role": { - "$ref": "#/components/schemas/B2bComponentsRole" + "apiAlias": { + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "BundleDiscountRule": { + "description": "Added since version: 6.7.9.0", + "required": [ + "bundleDiscountId", + "ruleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "language": { - "$ref": "#/components/schemas/Language" + "bundleDiscountId": { + "description": "Identifier of the bundle discount that references the rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleDiscountVersionId": { + "description": "Version of the bundle discount for this mapping.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "description": "Sales rule that controls the discount visibility.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleDiscount": { + "$ref": "#/components/schemas/BundleDiscount", + "description": "Associated bundle discount entity." + }, + "rule": { + "$ref": "#/components/schemas/Rule", + "description": "Associated rule entity defining eligibility." } }, "type": "object" }, - "B2bOrderEmployeeJsonApi": { + "BundleItemJsonApi": { + "description": "Added since version: 6.7.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -32838,10 +52973,8 @@ { "required": [ "id", - "orderId", - "firstName", - "lastName", - "employeeId" + "productId", + "bundleId" ], "properties": { "id": { @@ -32849,27 +52982,57 @@ "pattern": "^[0-9a-f]{32}$" }, "versionId": { + "description": "Version identifier of the bundle item entity.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "productId": { + "description": "Product that is included as an item in the bundle.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "productVersionId": { + "description": "Version identifier of the referenced product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" + "bundleId": { + "description": "Bundle product that owns this item entry.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "position": { + "description": "Display order for the item inside the bundle.", + "type": "integer", + "format": "int64" + }, + "quantity": { + "description": "Default quantity that will be added to the cart for this item.", + "type": "integer", + "format": "int64" + }, + "min": { + "description": "Minimum selectable quantity of the item within the bundle.", + "type": "integer", + "format": "int64" + }, + "max": { + "description": "Maximum selectable quantity of the bundle item.", + "type": "integer", + "format": "int64" + }, + "showBundleOnItemPdp": { + "type": "boolean" + }, + "required": { + "description": "Indicates whether the item must always be part of the bundle.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -32882,7 +53045,8 @@ }, "relationships": { "properties": { - "order": { + "product": { + "description": "Association to the product entity for this bundle item.", "properties": { "links": { "type": "object", @@ -32890,7 +53054,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/order" + "example": "/bundle-item/be65b30307aaf5570c9d71916c1c650b/product" } } }, @@ -32899,19 +53063,20 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "employee": { + "bundle": { + "description": "Association to the parent bundle product.", "properties": { "links": { "type": "object", @@ -32919,7 +53084,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/b2b-order-employee/5e062ee52486b822aad4eb0918cff56d/employee" + "example": "/bundle-item/be65b30307aaf5570c9d71916c1c650b/bundle" } } }, @@ -32928,12 +53093,12 @@ "properties": { "type": { "type": "string", - "example": "b2b_employee" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + "example": "94377c156735b39dfa4ac607234cb87c" } } } @@ -32948,13 +53113,13 @@ } ] }, - "B2bOrderEmployee": { + "BundleItem": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "orderId", - "firstName", - "lastName", - "employeeId" + "productId", + "quantity", + "min", + "required" ], "properties": { "id": { @@ -32962,27 +53127,61 @@ "pattern": "^[0-9a-f]{32}$" }, "versionId": { + "description": "Version identifier of the bundle item entity.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "productId": { + "description": "Product that is included as an item in the bundle.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "productVersionId": { + "description": "Version identifier of the referenced product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" + "bundleId": { + "description": "Bundle product that owns this item entry.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "employeeId": { + "bundleVersionId": { + "description": "Version identifier of the owning bundle product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "position": { + "description": "Display order for the item inside the bundle.", + "type": "integer", + "format": "int64", + "minimum": 0 + }, + "quantity": { + "description": "Default quantity that will be added to the cart for this item.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "min": { + "description": "Minimum selectable quantity of the item within the bundle.", + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "max": { + "description": "Maximum selectable quantity of the bundle item.", + "type": "integer", + "format": "int64" + }, + "showBundleOnItemPdp": { + "type": "boolean", + "description": "Show bundle on the product detail page of this bundle item." + }, + "required": { + "description": "Indicates whether the item must always be part of the bundle.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -32993,80 +53192,46 @@ "format": "date-time", "readOnly": true }, - "order": { - "$ref": "#/components/schemas/Order" + "product": { + "$ref": "#/components/schemas/BundleItemProduct", + "description": "Association to the product entity for this bundle item." }, - "employee": { - "$ref": "#/components/schemas/B2bEmployee" + "bundle": { + "$ref": "#/components/schemas/Product", + "description": "Association to the parent bundle product." + }, + "apiAlias": { + "type": "string", + "readOnly": true } }, "type": "object" }, - "B2bPermissionJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "group" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "group": { - "type": "string" - }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - } - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - } - }, - "type": "object" - } - ] - }, - "B2bPermission": { + "BundleVisibility": { + "description": "Added since version: 6.7.9.0", "required": [ - "id", - "name", - "group" + "bundleId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "bundleId": { + "description": "Bundle product whose visibility is configured.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "group": { - "type": "string" + "productVersionId": { + "description": "Version identifier of the bundle product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "dependencies": { - "type": "array", - "items": { - "type": "string" - } + "salesChannelId": { + "description": "Sales channel in which the bundle should be visible.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -33077,6 +53242,14 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel", + "description": "Association to the sales channel entity." + }, + "bundle": { + "$ref": "#/components/schemas/Product", + "description": "Association back to the bundle product." } }, "type": "object" @@ -33110,6 +53283,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33118,10 +53292,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -33138,11 +53314,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -33152,15 +53330,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -33207,6 +53389,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33215,6 +53398,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33239,6 +53423,68 @@ "properties": { "search": { "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -33246,6 +53492,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -33275,6 +53522,7 @@ "type": "object" }, "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -33306,6 +53554,7 @@ "type": "object" }, "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -33397,6 +53646,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering categories", "properties": { "links": { "type": "object", @@ -33428,6 +53678,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the category", "properties": { "links": { "type": "object", @@ -33610,6 +53861,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -33672,6 +53924,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33680,10 +53933,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -33700,11 +53955,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -33714,15 +53971,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -33769,6 +54030,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33777,6 +54039,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33801,21 +54064,86 @@ "properties": { "search": { "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogsCategories": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/advancedProductCatalogsCategories" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs_category" + }, + "id": { + "type": "string", + "example": "0a628ceb24e0f626e3355b2ffac1c2f7" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, "parent": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." }, "children": { + "description": "Child categories within this category for hierarchical navigation", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" }, "products": { "type": "array", @@ -33830,13 +54158,15 @@ } }, "tags": { + "description": "Tags for organizing and filtering categories", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" }, "productStream": { "$ref": "#/components/schemas/ProductStream" @@ -33866,6 +54196,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -33924,45 +54255,65 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -33980,20 +54331,13 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "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", @@ -34116,45 +54460,65 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -34172,20 +54536,13 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "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", @@ -34235,12 +54592,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -34252,6 +54612,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34277,6 +54638,7 @@ "relationships": { "properties": { "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -34308,6 +54670,7 @@ "type": "object" }, "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -34368,6 +54731,7 @@ "type": "object" }, "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -34487,12 +54851,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -34504,6 +54871,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34527,13 +54895,15 @@ "type": "object" }, "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "previewMedia": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, "categories": { "type": "array", @@ -34542,6 +54912,7 @@ } }, "landingPages": { + "description": "Landing pages using this CMS layout", "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" @@ -34580,39 +54951,57 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34633,14 +55022,6 @@ "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", @@ -34763,39 +55144,57 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34816,14 +55215,6 @@ "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", @@ -34871,10 +55262,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -34891,13 +55291,7 @@ "readOnly": true }, "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34970,10 +55364,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -34990,13 +55393,7 @@ "readOnly": true }, "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35040,34 +55437,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -35114,21 +55521,26 @@ "type": "object" }, "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", "type": "boolean" }, "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", "type": "boolean" }, "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", "type": "boolean" }, "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, "isEu": { @@ -35179,44 +55591,8 @@ } }, "type": "object" - } - }, - "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": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -35224,7 +55600,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" } } }, @@ -35235,42 +55611,11 @@ "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" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -35278,7 +55623,7 @@ }, "type": "object" }, - "salesChannelDefaultAssignments": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -35286,7 +55631,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" } } }, @@ -35297,19 +55642,25 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } } }, "type": "object" - }, - "salesChannels": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -35317,7 +55668,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/states" } } }, @@ -35328,11 +55679,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "country_state" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "34d955a0df5f7af9c9b4e4dccb3c3564" } } } @@ -35340,7 +55691,7 @@ }, "type": "object" }, - "taxRules": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -35348,7 +55699,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/customerAddresses" } } }, @@ -35359,11 +55710,11 @@ "properties": { "type": { "type": "string", - "example": "tax_rule" + "example": "customer_address" }, "id": { "type": "string", - "example": "1b93ada511aac379c19d3afcba4e4041" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -35371,7 +55722,7 @@ }, "type": "object" }, - "currencyCountryRoundings": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -35379,7 +55730,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/orderAddresses" } } }, @@ -35388,286 +55739,21 @@ "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", - "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" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_address" - }, - "id": { - "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" - } - } - } - } - }, - "type": "object" - } - }, - "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", - "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" - }, - "extensions": { - "properties": { - "subscriptionCustomerAddresses": { + "type": { + "type": "string", + "example": "order_address" + }, + "id": { + "type": "string", + "example": "c3182f0dc0cc20b4982616d3e0221747" + } + } + } + } + }, + "type": "object" + }, + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -35675,7 +55761,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannelDefaultAssignments" } } }, @@ -35686,24 +55772,19 @@ "properties": { "type": { "type": "string", - "example": "subscription_address" + "example": "sales_channel" }, "id": { "type": "string", - "example": "8951627da0210d39cc55d1a91ae21b8d" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "country": { + }, + "salesChannels": { "properties": { "links": { "type": "object", @@ -35711,28 +55792,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/salesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "example": "986f6f891e90ab91c091ff4a1a460777" + } } } } }, "type": "object" }, - "customerAddresses": { + "taxRules": { "properties": { "links": { "type": "object", @@ -35740,7 +55823,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/taxRules" } } }, @@ -35751,11 +55834,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "tax_rule" }, "id": { "type": "string", - "example": "84ed5cbc10cd9f665a8c9f05e49095af" + "example": "1b93ada511aac379c19d3afcba4e4041" } } } @@ -35763,7 +55846,7 @@ }, "type": "object" }, - "orderAddresses": { + "currencyCountryRoundings": { "properties": { "links": { "type": "object", @@ -35771,7 +55854,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/currencyCountryRoundings" } } }, @@ -35782,11 +55865,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "currency_country_rounding" }, "id": { "type": "string", - "example": "c3182f0dc0cc20b4982616d3e0221747" + "example": "35ef8dd5459bf5f08d44cb278bf07cd4" } } } @@ -35802,39 +55885,131 @@ } ] }, - "CountryState": { + "Country": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "countryId", - "shortCode", - "name" + "name", + "addressFormat" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shortCode": { + "name": { "type": "string" }, - "name": { + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" + }, + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "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": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -35858,7 +56033,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/subscriptionCustomerAddresses" } } }, @@ -35880,12 +56055,78 @@ } }, "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/country/59716c97497eb9694541f7c3d37b1a4d/b2bPendingOrderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "7c55a27217c16d4e6395eb18a7f3be2f" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, - "country": { - "$ref": "#/components/schemas/Country" + "states": { + "description": "States/provinces/regions within the country", + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" + } }, "customerAddresses": { "type": "array", @@ -35898,11 +56139,35 @@ "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" }, - "CurrencyJsonApi": { + "CountryStateJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -35911,12 +56176,8 @@ { "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", + "countryId", + "shortCode", "name" ], "properties": { @@ -35924,79 +56185,30 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "type": "number", - "format": "float" - }, - "symbol": { - "type": "string" - }, - "isoCode": { - "type": "string" + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "shortName": { + "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "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", @@ -36012,7 +56224,7 @@ }, "extensions": { "properties": { - "subscriptions": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -36020,7 +56232,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" } } }, @@ -36031,11 +56243,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "subscription_address" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -36043,7 +56255,7 @@ }, "type": "object" }, - "quotes": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -36051,7 +56263,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" } } }, @@ -36062,11 +56274,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } @@ -36079,69 +56291,7 @@ }, "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": { + "country": { "properties": { "links": { "type": "object", @@ -36149,92 +56299,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/country" } } }, "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": { "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": { + "example": "country" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "productExports": { + "customerAddresses": { "properties": { "links": { "type": "object", @@ -36242,7 +56328,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/productExports" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/customerAddresses" } } }, @@ -36253,11 +56339,11 @@ "properties": { "type": { "type": "string", - "example": "product_export" + "example": "customer_address" }, "id": { "type": "string", - "example": "2cd8793787cda582174c0fc329fbc377" + "example": "84ed5cbc10cd9f665a8c9f05e49095af" } } } @@ -36265,7 +56351,7 @@ }, "type": "object" }, - "countryRoundings": { + "orderAddresses": { "properties": { "links": { "type": "object", @@ -36273,7 +56359,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/countryRoundings" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/orderAddresses" } } }, @@ -36284,11 +56370,11 @@ "properties": { "type": { "type": "string", - "example": "currency_country_rounding" + "example": "order_address" }, "id": { "type": "string", - "example": "3de4aa80c8c8822ea10d156a6f58d6f7" + "example": "c3182f0dc0cc20b4982616d3e0221747" } } } @@ -36304,16 +56390,12 @@ } ] }, - "Currency": { + "CountryState": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "factor", - "symbol", - "isoCode", - "itemRounding", - "totalRounding", - "shortName", + "countryId", + "shortCode", "name" ], "properties": { @@ -36321,79 +56403,30 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "factor": { - "type": "number", - "format": "float" - }, - "symbol": { - "type": "string" - }, - "isoCode": { - "type": "string" - }, - "shortName": { + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, - "isSystemDefault": { - "description": "Runtime field, cannot be used as part of the criteria.", + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "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", @@ -36409,7 +56442,7 @@ }, "extensions": { "properties": { - "subscriptions": { + "subscriptionCustomerAddresses": { "properties": { "links": { "type": "object", @@ -36417,7 +56450,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/subscriptionCustomerAddresses" } } }, @@ -36428,11 +56461,11 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "subscription_address" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "8951627da0210d39cc55d1a91ae21b8d" } } } @@ -36440,7 +56473,7 @@ }, "type": "object" }, - "quotes": { + "b2bPendingOrderAddresses": { "properties": { "links": { "type": "object", @@ -36448,7 +56481,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" + "example": "/country-state/e65d972da07a4e37b3d1f8c2f32d9c99/b2bPendingOrderAddresses" } } }, @@ -36459,11 +56492,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_pending_order_address" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "7c55a27217c16d4e6395eb18a7f3be2f" } } } @@ -36474,53 +56507,26 @@ }, "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" - } + "country": { + "$ref": "#/components/schemas/Country" }, - "productExports": { + "customerAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductExport" + "$ref": "#/components/schemas/CustomerAddress" } }, - "countryRoundings": { + "orderAddresses": { "type": "array", "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" + "$ref": "#/components/schemas/OrderAddress" } } }, "type": "object" }, - "CurrencyCountryRoundingJsonApi": { - "description": "Added since version: 6.4.0.0", + "CurrencyJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -36528,23 +56534,54 @@ { "required": [ "id", - "currencyId", - "countryId", + "factor", + "symbol", + "isoCode", "itemRounding", - "totalRounding" + "totalRounding", + "shortName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" }, - "countryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "type": "string" + }, + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" + }, + "shortName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" }, "itemRounding": { "required": [ @@ -36598,9 +56635,12 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "currency": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -36608,28 +56648,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" + "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "currency" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } } } } }, "type": "object" }, - "country": { + "quotes": { "properties": { "links": { "type": "object", @@ -36637,297 +56679,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" + "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } } } } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CurrencyCountryRounding": { - "description": "Added since version: 6.4.0.0", - "required": [ - "id", - "currencyId", - "countryId", - "itemRounding", - "totalRounding" - ], - "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" - ], - "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" - ], - "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" - ], - "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": { + }, + "type": "object" + }, + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -36935,28 +56741,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" + "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "df17e58b74fa5cb09c5e84f3b37141e1" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } } } } }, "type": "object" }, - "productSearchConfigFields": { + "budgets": { "properties": { "links": { "type": "object", @@ -36964,7 +56772,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" + "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" } } }, @@ -36975,11 +56783,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_config_field" + "example": "b2b_components_budget" }, "id": { "type": "string", - "example": "ae6a70432f71d6905502769f184399b1" + "example": "b7d9e68ed31698bcfe971f824ab5fd23" } } } @@ -36989,117 +56797,10 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomField": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "name", - "type" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "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" - ], - "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": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -37107,7 +56808,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannelDefaultAssignments" } } }, @@ -37118,11 +56819,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field" + "example": "sales_channel" }, "id": { "type": "string", - "example": "4e252ff73243c27b4df9002e452fc6a7" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -37130,7 +56831,7 @@ }, "type": "object" }, - "relations": { + "orders": { "properties": { "links": { "type": "object", @@ -37138,7 +56839,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" + "example": "/currency/386c339d37e737a436499d423a77df0c/orders" } } }, @@ -37149,11 +56850,11 @@ "properties": { "type": { "type": "string", - "example": "custom_field_set_relation" + "example": "order" }, "id": { "type": "string", - "example": "06c5b10273a69992d8c6933e294909fa" + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -37161,7 +56862,7 @@ }, "type": "object" }, - "products": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -37169,7 +56870,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" + "example": "/currency/386c339d37e737a436499d423a77df0c/salesChannels" } } }, @@ -37180,11 +56881,11 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "sales_channel" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -37192,7 +56893,7 @@ }, "type": "object" }, - "app": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -37200,21 +56901,116 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" + "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": { - "type": { + "related": { "type": "string", - "example": "app" - }, - "id": { + "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", - "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "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" + } } } } @@ -37229,10 +57025,16 @@ } ] }, - "CustomFieldSet": { + "Currency": { "description": "Added since version: 6.0.0.0", "required": [ "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", "name" ], "properties": { @@ -37240,62 +57042,304 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" + }, + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, - "config": { - "type": "object" + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" }, - "active": { - "type": "boolean" + "shortName": { + "type": "string" }, - "global": { - "type": "boolean" + "name": { + "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, - "appId": { + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, + "type": "object" + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "subscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/subscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "2d5d14f95af035cbd8437948de61f94c" + } + } + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "budgets": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/currency/386c339d37e737a436499d423a77df0c/budgets" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } }, - "customFields": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomField" + "$ref": "#/components/schemas/SalesChannel" } }, - "relations": { + "salesChannelDomains": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/SalesChannelDomain" } }, - "products": { + "promotionDiscountPrices": { "type": "array", "items": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/PromotionDiscountPrices" } }, - "app": { - "$ref": "#/components/schemas/App" + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + }, + "countryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" + } } }, "type": "object" }, - "CustomFieldSetRelationJsonApi": { - "description": "Added since version: 6.0.0.0", + "CurrencyCountryRoundingJsonApi": { + "description": "Added since version: 6.4.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -37303,138 +57347,64 @@ { "required": [ "id", - "customFieldSetId", - "entityName" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customFieldSetId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entityName": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { + "countryId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "relationships": { + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "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" + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomFieldSetRelation": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "customFieldSetId", - "entityName" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFieldSetId": { - "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" - }, - "CustomPriceJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "productId", - "price" - ], - "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}$" - }, - "customerGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "price": { + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, "type": "object" }, "createdAt": { @@ -37449,36 +57419,7 @@ }, "relationships": { "properties": { - "customer": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customer" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" - } - } - } - }, - "type": "object" - }, - "customerGroup": { + "currency": { "properties": { "links": { "type": "object", @@ -37486,7 +57427,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/currency" } } }, @@ -37495,19 +57436,19 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "currency" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "115091b01a7299f28a5ce7e1b712a222" + "example": "1af0389838508d7016a9841eb6273962" } } } }, "type": "object" }, - "product": { + "country": { "properties": { "links": { "type": "object", @@ -37515,7 +57456,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/product" + "example": "/currency-country-rounding/1d1957074c6776cfcf655c28fc42dc64/country" } } }, @@ -37524,12 +57465,12 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } @@ -37544,34 +57485,68 @@ } ] }, - "CustomPrice": { + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", "required": [ "id", - "productId", - "price" + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { + "currencyId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "countryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerGroupId": { - "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" }, - "price": { + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" + } + }, "type": "object" }, "createdAt": { @@ -37584,20 +57559,17 @@ "format": "date-time", "readOnly": true }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "customerGroup": { - "$ref": "#/components/schemas/CustomerGroup" + "currency": { + "$ref": "#/components/schemas/Currency" }, - "product": { - "$ref": "#/components/schemas/Product" + "country": { + "$ref": "#/components/schemas/Country" } }, "type": "object" }, - "CustomerJsonApi": { - "description": "Added since version: 6.0.0.0", + "CustomEntityJsonApi": { + "description": "Added since version: 6.4.9.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -37605,172 +57577,184 @@ { "required": [ "id", - "groupId", - "salesChannelId", - "languageId", - "defaultBillingAddressId", - "defaultShippingAddressId", - "customerNumber", - "firstName", - "lastName", - "email", - "defaultPaymentMethodId" + "name", + "fields" ], "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}$" + "name": { + "description": "Unique name of the entity.", + "type": "string" }, - "lastPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "fields": { + "type": "object" }, - "defaultBillingAddressId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "flags": { + "type": "object" }, - "defaultShippingAddressId": { + "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "autoIncrement": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customerNumber": { - "type": "string" - }, - "salutationId": { + "pluginId": { + "description": "Unique identity of plugin.", "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": { + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "doubleOptInRegistration": { + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "boolean" }, - "doubleOptInEmailSentDate": { - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "type": "string", - "format": "date-time" - }, - "hash": { - "type": "string" - }, - "guest": { + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, - "firstLogin": { - "type": "string", - "format": "date-time" + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" }, - "lastLogin": { + "deletedAt": { "type": "string", "format": "date-time" }, - "birthday": { - "type": "string" - }, - "lastOrderDate": { + "createdAt": { "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", + "updatedAt": { + "type": "string", + "format": "date-time", "readOnly": true + } + }, + "type": "object" + } + ] + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "required": [ + "id", + "name", + "fields" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the entity.", + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" + }, + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "type": "object" + }, + "CustomFieldJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "name": { + "description": "Unique name of a custom field.", + "type": "string" }, - "remoteAddress": { + "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true + "config": { + "type": "object" }, - "requestedGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" }, - "boundSalesChannelId": { + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "accountType": { - "type": "string" + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "storeApiAware": { + "type": "boolean" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "includeInSearch": { + "type": "boolean" }, "createdAt": { "type": "string", @@ -37784,7 +57768,7 @@ }, "extensions": { "properties": { - "customPrice": { + "advancedSearchConfigFields": { "properties": { "links": { "type": "object", @@ -37792,7 +57776,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" } } }, @@ -37803,19 +57787,24 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "advanced_search_config_field" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" } } } } }, "type": "object" - }, - "subscriptionCustomers": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -37823,92 +57812,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/customFieldSet" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_customer" - }, - "id": { - "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" - } - } - } - } - }, - "type": "object" - }, - "delayActions": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - }, - "employees": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { + "example": "custom_field_set" + }, + "id": { "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" - } + "pattern": "^[0-9a-f]{32}$", + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" }, - "roles": { + "productSearchConfigFields": { "properties": { "links": { "type": "object", @@ -37916,7 +57841,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/productSearchConfigFields" } } }, @@ -37927,77 +57852,184 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_role" + "example": "product_search_config_field" }, "id": { "type": "string", - "example": "4295e8065f2f640103f566df3329e17f" + "example": "ae6a70432f71d6905502769f184399b1" } } } } }, "type": "object" - }, - "b2bBusinessPartner": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomField": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field.", + "type": "string" + }, + "type": { + "description": "Custom field type can be selection, media , etc", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" + }, + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" + }, + "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "advancedSearchConfigFields": { + "properties": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_business_partner" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field/8c9d2c73a2f564420ef091ee69b564b9/advancedSearchConfigFields" } - }, - "type": "object" + } }, - "specificFeatures": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_specific_features" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "5cfb6fcb7542e25892e1a35cd6a06c54" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config_field" + }, + "id": { + "type": "string", + "example": "bdf4d1c41d2b0aa72620e925951c2b0d" } } - }, - "type": "object" - }, - "ssoProviderCustomers": { + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "productSearchConfigFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" + } + } + }, + "type": "object" + }, + "CustomFieldSetJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field set.", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" + }, + "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" + }, + "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", + "type": "integer", + "format": "int64" + }, + "appId": { + "description": "Unique identity of an app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFields": { "properties": { "links": { "type": "object", @@ -38005,7 +58037,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/customFields" } } }, @@ -38016,11 +58048,11 @@ "properties": { "type": { "type": "string", - "example": "sso_provider_customer" + "example": "custom_field" }, "id": { "type": "string", - "example": "6f2bd941c85a0835cd1889fd0a2c835a" + "example": "4e252ff73243c27b4df9002e452fc6a7" } } } @@ -38028,7 +58060,7 @@ }, "type": "object" }, - "quotes": { + "relations": { "properties": { "links": { "type": "object", @@ -38036,7 +58068,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" } } }, @@ -38047,11 +58079,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "custom_field_set_relation" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "06c5b10273a69992d8c6933e294909fa" } } } @@ -38059,7 +58091,7 @@ }, "type": "object" }, - "quoteComments": { + "products": { "properties": { "links": { "type": "object", @@ -38067,7 +58099,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/products" } } }, @@ -38078,82 +58110,19 @@ "properties": { "type": { "type": "string", - "example": "quote_comment" + "example": "product" }, "id": { "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "group": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" - } - } - } - }, - "type": "object" - }, - "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": { + "app": { "properties": { "links": { "type": "object", @@ -38161,7 +58130,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/app" } } }, @@ -38170,19 +58139,135 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" - }, - "lastPaymentMethod": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomFieldSet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field set.", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" + }, + "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" + }, + "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", + "type": "integer", + "format": "int64" + }, + "appId": { + "description": "Unique identity of an app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" + } + }, + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "app": { + "$ref": "#/components/schemas/App" + } + }, + "type": "object" + }, + "CustomFieldSetRelationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customFieldSetId", + "entityName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "description": "Unique identity of a custom field set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "description": "Name of the entity.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFieldSet": { "properties": { "links": { "type": "object", @@ -38190,7 +58275,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" + "example": "/custom-field-set-relation/9686e510825802f328b6a861ccaa977e/customFieldSet" } } }, @@ -38199,19 +58284,111 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "custom_field_set" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "bb083200005a374b86f6f5fbbff6f0e0" + "example": "df17e58b74fa5cb09c5e84f3b37141e1" } } } }, "type": "object" - }, - "defaultBillingAddress": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomFieldSetRelation": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customFieldSetId", + "entityName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "description": "Unique identity of a custom field set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "description": "Name of the entity.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + } + }, + "type": "object" + }, + "CustomPriceJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "price" + ], + "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}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "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", @@ -38219,7 +58396,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customer" } } }, @@ -38228,19 +58405,19 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "263d0f6e5d8d71fc4c288736f7c90990" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "defaultShippingAddress": { + "customerGroup": { "properties": { "links": { "type": "object", @@ -38248,7 +58425,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/customerGroup" } } }, @@ -38257,19 +58434,19 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" + "example": "115091b01a7299f28a5ce7e1b712a222" } } } }, "type": "object" }, - "salutation": { + "product": { "properties": { "links": { "type": "object", @@ -38277,7 +58454,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" + "example": "/custom-price/15ffcf0a24168224e50e7fa559015d05/product" } } }, @@ -38286,19 +58463,280 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" - }, - "addresses": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomPrice": { + "required": [ + "id", + "productId", + "price" + ], + "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}$" + }, + "customerGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "customerGroup": { + "$ref": "#/components/schemas/CustomerGroup" + }, + "product": { + "$ref": "#/components/schemas/Product" + } + }, + "type": "object" + }, + "CustomerJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "email": { + "description": "Email ID of the customer.", + "type": "string" + }, + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" + }, + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Password hash for customer recovery.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "customPrice": { "properties": { "links": { "type": "object", @@ -38306,7 +58744,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" } } }, @@ -38317,11 +58755,11 @@ "properties": { "type": { "type": "string", - "example": "customer_address" + "example": "custom_price" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } @@ -38329,7 +58767,7 @@ }, "type": "object" }, - "orderCustomers": { + "subscriptionCustomers": { "properties": { "links": { "type": "object", @@ -38337,7 +58775,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" } } }, @@ -38348,11 +58786,11 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "subscription_customer" }, "id": { "type": "string", - "example": "1e7dbe7e3bcb48d233fd80588f54c980" + "example": "ee8811605866488e8f21308857e1e5a8" } } } @@ -38360,7 +58798,7 @@ }, "type": "object" }, - "tags": { + "delayActions": { "properties": { "links": { "type": "object", @@ -38368,7 +58806,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" } } }, @@ -38379,11 +58817,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "edfed55799054673006c4b5a643489ac" } } } @@ -38391,7 +58829,7 @@ }, "type": "object" }, - "promotions": { + "employees": { "properties": { "links": { "type": "object", @@ -38399,7 +58837,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/promotions" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" } } }, @@ -38410,11 +58848,11 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "ea6aeb050f871384f25fba9c869cfe21" + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" } } } @@ -38422,7 +58860,7 @@ }, "type": "object" }, - "productReviews": { + "roles": { "properties": { "links": { "type": "object", @@ -38430,7 +58868,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/productReviews" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" } } }, @@ -38441,11 +58879,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "b2b_components_role" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "4295e8065f2f640103f566df3329e17f" } } } @@ -38453,7 +58891,7 @@ }, "type": "object" }, - "recoveryCustomer": { + "b2bBusinessPartner": { "properties": { "links": { "type": "object", @@ -38461,7 +58899,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" } } }, @@ -38470,19 +58908,19 @@ "properties": { "type": { "type": "string", - "example": "customer_recovery" + "example": "b2b_business_partner" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ce9d8d13e51bf43bc70a4be38950823b" + "example": "c1736d678c9ca2f952db2f7894193bf3" } } } }, "type": "object" }, - "requestedGroup": { + "specificFeatures": { "properties": { "links": { "type": "object", @@ -38490,7 +58928,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" } } }, @@ -38499,19 +58937,19 @@ "properties": { "type": { "type": "string", - "example": "customer_group" + "example": "customer_specific_features" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "46cf25a3f20102ff5e1e17526fb73b62" + "example": "5cfb6fcb7542e25892e1a35cd6a06c54" } } } }, "type": "object" }, - "boundSalesChannel": { + "ssoProviderCustomers": { "properties": { "links": { "type": "object", @@ -38519,28 +58957,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "dfe8aec35136b1f62669b388a291a4c7" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" + } } } } }, "type": "object" }, - "wishlists": { + "quotes": { "properties": { "links": { "type": "object", @@ -38548,7 +58988,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" } } }, @@ -38559,11 +58999,11 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist" + "example": "quote" }, "id": { "type": "string", - "example": "4ec38c6b2208529c1fadccc7d55d7947" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -38571,7 +59011,7 @@ }, "type": "object" }, - "createdBy": { + "quoteComments": { "properties": { "links": { "type": "object", @@ -38579,28 +59019,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } } } } }, "type": "object" }, - "updatedBy": { + "organizationUnits": { "properties": { "links": { "type": "object", @@ -38608,28 +59050,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/updatedBy" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "4ab85f040b199b758bfb81e383c50b4b" + } } } } }, "type": "object" }, - "defaultPaymentMethod": { + "b2bApprovalRules": { "properties": { "links": { "type": "object", @@ -38637,691 +59081,123 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultPaymentMethod" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8f35e31802b72bf010a333999b26f3a6" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "545759fb10fcbebd03f04277239baace" + } } } } }, "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", - "defaultPaymentMethodId" - ], - "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 - }, - "extensions": { - "properties": { - "customPrice": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } - } - } - } - }, - "type": "object" - }, - "subscriptionCustomers": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_customer" - }, - "id": { - "type": "string", - "example": "ee8811605866488e8f21308857e1e5a8" - } - } - } - } - }, - "type": "object" - }, - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - }, - "employees": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_employee" - }, - "id": { - "type": "string", - "example": "582ca3f7cbaf4edcc1b445f8ea90b503" - } - } - } - } - }, - "type": "object" - }, - "roles": { - "properties": { - "links": { - "type": "object", + "b2bPendingOrders": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_role" - }, - "id": { - "type": "string", - "example": "4295e8065f2f640103f566df3329e17f" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" + } } - } - } - } - }, - "type": "object" - }, - "b2bBusinessPartner": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_business_partner" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c1736d678c9ca2f952db2f7894193bf3" - } - } - } - }, - "type": "object" - }, - "specificFeatures": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_specific_features" }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "5cfb6fcb7542e25892e1a35cd6a06c54" - } - } - } - }, - "type": "object" - }, - "ssoProviderCustomers": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sso_provider_customer" - }, - "id": { - "type": "string", - "example": "6f2bd941c85a0835cd1889fd0a2c835a" - } - } - } - } - }, - "type": "object" - }, - "quotes": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote" - }, - "id": { - "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } } } - } - } - }, - "type": "object" - }, - "quoteComments": { - "properties": { - "links": { - "type": "object", + }, + "type": "object" + }, + "shoppingLists": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" + } + } + } } - } + }, + "type": "object" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_comment" - }, - "id": { - "type": "string", - "example": "98dec49a83119c512f84645e81ea52d8" + "b2bAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "912596af64fb66beeb84defb9535e16d" + } + } } } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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" - ], - "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": { + }, + "type": "object" + }, + "budgets": { "properties": { "links": { "type": "object", @@ -39329,28 +59205,67 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" + } + } + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" + } } } } }, "type": "object" - }, - "country": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -39358,7 +59273,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" } } }, @@ -39367,19 +59282,19 @@ "properties": { "type": { "type": "string", - "example": "country" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "example": "db0f6f37ebeb6ea09489124345af2a45" } } } }, "type": "object" }, - "countryState": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -39387,7 +59302,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" } } }, @@ -39396,19 +59311,20 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "salutation": { + "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -39416,7 +59332,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" } } }, @@ -39425,175 +59341,20 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "language" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerAddress": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "customerId", - "countryId", - "firstName", - "lastName", - "city", - "street" - ], - "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", - "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" - }, - "extensions": { - "properties": { - "customPrice": { + }, + "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -39601,35 +59362,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bb083200005a374b86f6f5fbbff6f0e0" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "customers": { + }, + "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { "links": { "type": "object", @@ -39637,30 +59392,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "example": "4b6f7d34a58ba399f077685951d06738" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "263d0f6e5d8d71fc4c288736f7c90990" } } } }, "type": "object" }, - "salesChannels": { + "activeBillingAddress": { + "description": "Currently active billing address in the session", "properties": { "links": { "type": "object", @@ -39668,30 +59422,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" } } } }, "type": "object" }, - "registrationSalesChannels": { + "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -39699,212 +59452,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "ffc8e76c1fe257d563b9d0024a50620b" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8218c377171d06883caea7e2baf67f31" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerGroup": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "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" - }, - "extensions": { - "properties": { - "customPrice": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" - } - } }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } - } - } - } - }, - "type": "object" - } - }, - "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" - ], - "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" - ], - "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": { + "activeShippingAddress": { + "description": "Currently active shipping address in the session", "properties": { "links": { "type": "object", @@ -39912,7 +59482,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" } } }, @@ -39921,97 +59491,20 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "customer_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "f6e2f5dd29b543b8547e30d2d71a6974" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerRecovery": { - "description": "Added since version: 6.1.0.0", - "required": [ - "id", - "hash", - "customerId" - ], - "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" - }, - "CustomerSpecificFeaturesJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "customerId", - "features" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "features": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "customer": { + }, + "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -40019,7 +59512,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" } } }, @@ -40028,129 +59521,83 @@ "properties": { "type": { "type": "string", - "example": "customer" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerSpecificFeatures": { - "required": [ - "id", - "customerId", - "features" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "features": { - "type": "object" - }, - "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" - ], - "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": { + }, + "addresses": { + "description": "All addresses saved for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } + } + } + } + }, + "type": "object" + }, + "orderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/orderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_customer" + }, + "id": { + "type": "string", + "example": "1e7dbe7e3bcb48d233fd80588f54c980" + } + } + } + } + }, + "type": "object" + }, + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -40158,7 +59605,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" } } }, @@ -40169,11 +59616,11 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist_product" + "example": "tag" }, "id": { "type": "string", - "example": "86024cad1e83101d97359d7351051156" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -40181,7 +59628,7 @@ }, "type": "object" }, - "customer": { + "promotions": { "properties": { "links": { "type": "object", @@ -40189,28 +59636,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" + "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": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "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" }, - "salesChannel": { + "recoveryCustomer": { "properties": { "links": { "type": "object", @@ -40218,7 +59698,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/recoveryCustomer" } } }, @@ -40227,116 +59707,19 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "customer_recovery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "ce9d8d13e51bf43bc70a4be38950823b" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerWishlist": { - "description": "Added since version: 6.3.4.0", - "required": [ - "id", - "customerId", - "salesChannelId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "CustomerWishlistProductJsonApi": { - "description": "Added since version: 6.3.4.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "productId", - "wishlistId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "wishlistId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "wishlist": { + }, + "requestedGroup": { "properties": { "links": { "type": "object", @@ -40344,7 +59727,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/wishlist" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/requestedGroup" } } }, @@ -40353,19 +59736,19 @@ "properties": { "type": { "type": "string", - "example": "customer_wishlist" + "example": "customer_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "723edf7c24638ed18d2fa831e647a5cc" + "example": "46cf25a3f20102ff5e1e17526fb73b62" } } } }, "type": "object" }, - "product": { + "boundSalesChannel": { "properties": { "links": { "type": "object", @@ -40373,7 +59756,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/customer-wishlist-product/d6e178a98d861482131b9e2356460d16/product" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/boundSalesChannel" } } }, @@ -40382,121 +59765,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "dfe8aec35136b1f62669b388a291a4c7" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CustomerWishlistProduct": { - "description": "Added since version: 6.3.4.0", - "required": [ - "id", - "productId", - "wishlistId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "wishlistId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "wishlist": { - "$ref": "#/components/schemas/CustomerWishlist" - }, - "product": { - "$ref": "#/components/schemas/Product" - } - }, - "type": "object" - }, - "DeliveryTimeJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "min", - "max", - "unit" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "min": { - "type": "integer", - "format": "int64" - }, - "max": { - "type": "integer", - "format": "int64" - }, - "unit": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "shippingMethods": { + }, + "wishlists": { "properties": { "links": { "type": "object", @@ -40504,7 +59785,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/shippingMethods" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/wishlists" } } }, @@ -40515,11 +59796,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "customer_wishlist" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "4ec38c6b2208529c1fadccc7d55d7947" } } } @@ -40527,7 +59808,7 @@ }, "type": "object" }, - "products": { + "createdBy": { "properties": { "links": { "type": "object", @@ -40535,23 +59816,50 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/delivery-time/23679aa2a9d2aa429662de0be1213305/products" + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/createdBy" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } + "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" } } } @@ -40566,36 +59874,189 @@ } ] }, - "DeliveryTime": { + "Customer": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "min", - "max", - "unit" + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, - "min": { + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "email": { + "description": "Email ID of the customer.", + "type": "string" + }, + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" + }, + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Password hash for customer recovery.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", - "format": "int64" + "format": "int64", + "readOnly": true }, - "max": { + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", - "format": "int64" + "format": "int64", + "readOnly": true }, - "unit": { + "customFields": { + "type": "object" + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, - "customFields": { - "type": "object" + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -40607,340 +60068,626 @@ "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" - ], + "extensions": { "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fileType": { - "type": "string" + "customPrice": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/customPrice" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_price" + }, + "id": { + "type": "string", + "example": "35ed8bfa9c73171a7b417f13ab07d57a" + } + } + } + } + }, + "type": "object" }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "subscriptionCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/subscriptionCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription_customer" + }, + "id": { + "type": "string", + "example": "ee8811605866488e8f21308857e1e5a8" + } + } + } + } + }, + "type": "object" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/delayActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, + "type": "object" }, - "documentMediaFileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "employees": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/employees" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "example": "582ca3f7cbaf4edcc1b445f8ea90b503" + } + } + } + } + }, + "type": "object" }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "roles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/roles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_role" + }, + "id": { + "type": "string", + "example": "4295e8065f2f640103f566df3329e17f" + } + } + } + } + }, + "type": "object" }, - "config": { + "b2bBusinessPartner": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bBusinessPartner" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_business_partner" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c1736d678c9ca2f952db2f7894193bf3" + } + } + } + }, "type": "object" }, - "sent": { - "type": "boolean" + "specificFeatures": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/specificFeatures" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_specific_features" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5cfb6fcb7542e25892e1a35cd6a06c54" + } + } + } + }, + "type": "object" }, - "static": { - "type": "boolean" + "ssoProviderCustomers": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/ssoProviderCustomers" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider_customer" + }, + "id": { + "type": "string", + "example": "6f2bd941c85a0835cd1889fd0a2c835a" + } + } + } + } + }, + "type": "object" }, - "deepLinkCode": { - "type": "string" + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" }, - "documentNumber": { - "type": "string" + "quoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/quoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "98dec49a83119c512f84645e81ea52d8" + } + } + } + } + }, + "type": "object" }, - "customFields": { + "organizationUnits": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/organizationUnits" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "4ab85f040b199b758bfb81e383c50b4b" + } + } + } + } + }, "type": "object" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "b2bApprovalRules": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bApprovalRules" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule" + }, + "id": { + "type": "string", + "example": "545759fb10fcbebd03f04277239baace" + } + } + } + } + }, + "type": "object" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" }, - "relationships": { + "shoppingLists": { "properties": { - "documentType": { + "links": { + "type": "object", "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/shoppingLists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" - } + } + } + } + }, + "type": "object" + }, + "b2bAdvancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/b2bAdvancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "912596af64fb66beeb84defb9535e16d" } } - }, - "type": "object" - }, - "order": { + } + } + }, + "type": "object" + }, + "budgets": { + "properties": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/budgets" } - }, - "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" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "example": "b7d9e68ed31698bcfe971f824ab5fd23" } } - }, - "type": "object" - }, - "dependentDocuments": { + } + } + }, + "type": "object" + }, + "individualPricingCompanyAssignments": { + "properties": { + "links": { + "type": "object", "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" - } - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/individualPricingCompanyAssignments" } - }, - "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" - } + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing_company_assignment" + }, + "id": { + "type": "string", + "example": "78fc5e012f88233a08401f2351a299a9" } } - }, - "type": "object" + } } }, "type": "object" } }, "type": "object" - } - ] - }, - "Document": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "fileType", - "orderId", - "config", - "deepLinkCode" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, - "fileType": { - "type": "string" + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "language": { + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, - "documentMediaFileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, - "orderVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, - "config": { - "type": "object" + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" }, - "sent": { - "type": "boolean" + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" }, - "static": { - "type": "boolean" + "salutation": { + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, - "deepLinkCode": { - "type": "string" + "addresses": { + "description": "All addresses saved for the customer", + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "documentNumber": { - "type": "string" + "orderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" + } }, - "customFields": { - "type": "object" + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" + } }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" + "recoveryCustomer": { + "$ref": "#/components/schemas/CustomerRecovery" }, - "order": { - "$ref": "#/components/schemas/Order" + "requestedGroup": { + "$ref": "#/components/schemas/CustomerGroup" }, - "referencedDocument": { - "$ref": "#/components/schemas/Document" + "boundSalesChannel": { + "$ref": "#/components/schemas/SalesChannel" }, - "dependentDocuments": { + "wishlists": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/CustomerWishlist" } }, - "documentMediaFile": { - "$ref": "#/components/schemas/Media" + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "DocumentBaseConfigJsonApi": { + "CustomerAddressJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -40949,38 +60696,87 @@ { "required": [ "id", - "documentTypeId", - "name" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "logoId": { + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", "type": "string" }, - "filenamePrefix": { + "lastName": { + "description": "Last name of the customer.", "type": "string" }, - "filenameSuffix": { + "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, - "global": { - "type": "boolean" + "city": { + "description": "Name of customer's city.", + "type": "string" }, - "documentNumber": { + "company": { + "description": "Name of customer's company.", "type": "string" }, - "config": { + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -40988,17 +60784,14 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "documentType": { + "organizationCustomerAddresses": { "properties": { "links": { "type": "object", @@ -41006,28 +60799,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "document_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization_customer_address" + }, + "id": { + "type": "string", + "example": "ada6a19a929bea8dbec29edb3d68df58" + } } } } }, "type": "object" }, - "logo": { + "organizationDefaultShippingAddresses": { "properties": { "links": { "type": "object", @@ -41035,28 +60830,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "789476f40e97708274b7ff68e5dfd729" + } } } } }, "type": "object" }, - "salesChannels": { + "organizationDefaultBillingAddresses": { "properties": { "links": { "type": "object", @@ -41064,7 +60861,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" } } }, @@ -41075,11 +60872,11 @@ "properties": { "type": { "type": "string", - "example": "document_base_config_sales_channel" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" + "example": "7b0213487f5e71c973532f6f31740e5a" } } } @@ -41089,119 +60886,39 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "DocumentBaseConfig": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "name" - ], - "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" - ], - "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": { + "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", @@ -41209,7 +60926,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/country" } } }, @@ -41218,19 +60935,19 @@ "properties": { "type": { "type": "string", - "example": "document_type" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "2e45fec65781ec559e2aea39372a55cd" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "documentBaseConfig": { + "countryState": { "properties": { "links": { "type": "object", @@ -41238,7 +60955,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/countryState" } } }, @@ -41247,19 +60964,19 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56e59df02965ebf8eadea49fa0aadd47" + "example": "cb6a9764567191fb74fe28d8d6a4819d" } } } }, "type": "object" }, - "salesChannel": { + "salutation": { "properties": { "links": { "type": "object", @@ -41267,7 +60984,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/salutation" } } }, @@ -41276,12 +60993,12 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -41296,29 +61013,93 @@ } ] }, - "DocumentBaseConfigSalesChannel": { + "CustomerAddress": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "documentBaseConfigId" + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentBaseConfigId": { + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "salesChannelId": { + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "documentTypeId": { + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" + }, + "city": { + "description": "Name of customer's city.", + "type": "string" + }, + "company": { + "description": "Name of customer's company.", + "type": "string" + }, + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41329,19 +61110,120 @@ "format": "date-time", "readOnly": true }, - "documentType": { - "$ref": "#/components/schemas/DocumentType" + "extensions": { + "properties": { + "organizationCustomerAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationCustomerAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization_customer_address" + }, + "id": { + "type": "string", + "example": "ada6a19a929bea8dbec29edb3d68df58" + } + } + } + } + }, + "type": "object" + }, + "organizationDefaultShippingAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultShippingAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "789476f40e97708274b7ff68e5dfd729" + } + } + } + } + }, + "type": "object" + }, + "organizationDefaultBillingAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/organizationDefaultBillingAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "7b0213487f5e71c973532f6f31740e5a" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "documentBaseConfig": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "country": { + "$ref": "#/components/schemas/Country" + }, + "countryState": { + "$ref": "#/components/schemas/CountryState" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "DocumentTypeJsonApi": { + "CustomerGroupJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -41350,7 +61232,6 @@ { "required": [ "id", - "technicalName", "name" ], "properties": { @@ -41361,7 +61242,27 @@ "name": { "type": "string" }, - "technicalName": { + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { "type": "string" }, "createdAt": { @@ -41374,15 +61275,12 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, "extensions": { "properties": { - "quoteDocuments": { + "customPrice": { "properties": { "links": { "type": "object", @@ -41390,7 +61288,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, @@ -41401,24 +61299,53 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "custom_price" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" + }, + "advancedProductCatalog": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ff9540fcefd24264341c5a70314b71be" + } + } + } + }, + "type": "object" } }, "type": "object" }, "relationships": { "properties": { - "documents": { + "customers": { "properties": { "links": { "type": "object", @@ -41426,7 +61353,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customers" } } }, @@ -41437,11 +61364,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "customer" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -41449,7 +61376,7 @@ }, "type": "object" }, - "documentBaseConfigs": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -41457,7 +61384,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/salesChannels" } } }, @@ -41468,11 +61395,11 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "sales_channel" }, "id": { "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -41480,7 +61407,7 @@ }, "type": "object" }, - "documentBaseConfigSalesChannels": { + "registrationSalesChannels": { "properties": { "links": { "type": "object", @@ -41488,7 +61415,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/registrationSalesChannels" } } }, @@ -41499,11 +61426,11 @@ "properties": { "type": { "type": "string", - "example": "document_base_config_sales_channel" + "example": "sales_channel" }, "id": { "type": "string", - "example": "9c990fde5b38ff70fc1a07bf84c12a17" + "example": "ffc8e76c1fe257d563b9d0024a50620b" } } } @@ -41519,11 +61446,10 @@ } ] }, - "DocumentType": { + "CustomerGroup": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "technicalName", "name" ], "properties": { @@ -41534,7 +61460,27 @@ "name": { "type": "string" }, - "technicalName": { + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "type": "boolean" + }, + "registrationTitle": { + "type": "string" + }, + "registrationIntroduction": { + "type": "string" + }, + "registrationOnlyCompanyRegistration": { + "type": "boolean" + }, + "registrationSeoMetaDescription": { "type": "string" }, "createdAt": { @@ -41547,15 +61493,12 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, "extensions": { "properties": { - "quoteDocuments": { + "customPrice": { "properties": { "links": { "type": "object", @@ -41563,7 +61506,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/customPrice" } } }, @@ -41574,44 +61517,106 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "custom_price" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "35ed8bfa9c73171a7b417f13ab07d57a" } } } } }, "type": "object" + }, + "advancedProductCatalog": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-group/2c5176146d938e15c9f0e3d5203c19bf/advancedProductCatalog" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ff9540fcefd24264341c5a70314b71be" + } + } + } + }, + "type": "object" } }, "type": "object" }, - "documents": { + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/Customer" } }, - "documentBaseConfigs": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/SalesChannel" } }, - "documentBaseConfigSalesChannels": { + "registrationSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" + "$ref": "#/components/schemas/SalesChannel" } } }, "type": "object" }, - "FlowJsonApi": { - "description": "Added since version: 6.4.6.0", + "CustomerGroupRegistrationSalesChannels": { + "description": "Added since version: 6.3.1.0", + "required": [ + "customerGroupId", + "salesChannelId" + ], + "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" @@ -41619,38 +61624,20 @@ { "required": [ "id", - "name", - "eventName" + "hash", + "customerId" ], "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": { + "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, - "customFields": { - "type": "object" - }, - "appFlowEventId": { + "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41664,9 +61651,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "delayActions": { + "customer": { "properties": { "links": { "type": "object", @@ -41674,23 +61661,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" + "example": "/customer-recovery/5c91cd3c845f51250c566f72e5fec3bf/customer" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -41699,41 +61684,85 @@ } }, "type": "object" + } + }, + "type": "object" + } + ] + }, + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "hash", + "customerId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "description": "Password hash for customer's account recovery.", + "type": "string" + }, + "customerId": { + "description": "Unique identity of the customer.", + "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" + }, + "CustomerSpecificFeaturesJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "features" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "features": { + "type": "object" + }, + "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": { + "customer": { "properties": { "links": { "type": "object", @@ -41741,7 +61770,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" + "example": "/customer-specific-features/e56b0d78d82e9de6aa5c6e3d37b4a360/customer" } } }, @@ -41750,12 +61779,12 @@ "properties": { "type": { "type": "string", - "example": "app_flow_event" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d92d404135abc21e31337d9509cbe62f" + "example": "91ec1f9324753048c0096d036a694f86" } } } @@ -41770,45 +61799,24 @@ } ] }, - "Flow": { - "description": "Added since version: 6.4.6.0", + "CustomerSpecificFeatures": { "required": [ "id", - "name", - "eventName" + "customerId", + "features" ], "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": { + "customerId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "features": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -41819,56 +61827,42 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "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}$" }, - "sequences": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } + "customerId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "appFlowEvent": { - "$ref": "#/components/schemas/AppFlowEvent" + "tagId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "tag": { + "$ref": "#/components/schemas/Tag" } }, "type": "object" }, - "FlowSequenceJsonApi": { - "description": "Added since version: 6.4.6.0", + "CustomerWishlistJsonApi": { + "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -41876,49 +61870,27 @@ { "required": [ "id", - "flowId" + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "flowId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { + "customerId": { + "description": "Unique identity of the customer.", "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": { + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -41929,40 +61901,9 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - }, - "webhookEventLogs": { + "products": { "properties": { "links": { "type": "object", @@ -41970,7 +61911,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/products" } } }, @@ -41981,82 +61922,19 @@ "properties": { "type": { "type": "string", - "example": "webhook_event_log" + "example": "customer_wishlist_product" }, "id": { "type": "string", - "example": "82557f6f51ca956bee524cede1375331" + "example": "86024cad1e83101d97359d7351051156" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "flow": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "cff5497121104c2b8e0cb41ed2083a9b" - } - } - } - }, - "type": "object" - }, - "rule": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" - } - } - } - }, - "type": "object" }, - "parent": { + "customer": { "properties": { "links": { "type": "object", @@ -42064,7 +61942,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/customer" } } }, @@ -42073,50 +61951,19 @@ "properties": { "type": { "type": "string", - "example": "flow_sequence" + "example": "customer" }, "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" - } + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "appFlowAction": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -42124,7 +61971,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" + "example": "/customer-wishlist/cae717e5aef3f7f9a2356eff6cb7fad1/salesChannel" } } }, @@ -42133,12 +61980,12 @@ "properties": { "type": { "type": "string", - "example": "app_flow_action" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8ba9ae8a60ecf9be421e333b95703a68" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -42153,53 +62000,31 @@ } ] }, - "FlowSequence": { - "description": "Added since version: 6.4.6.0", + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", "required": [ "id", - "flowId" + "customerId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "flowId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "ruleId": { + "customerId": { + "description": "Unique identity of the customer.", "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": { + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "appFlowActionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -42210,96 +62035,23 @@ "format": "date-time", "readOnly": true }, - "extensions": { - "properties": { - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" - }, - "webhookEventLogs": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "webhook_event_log" - }, - "id": { - "type": "string", - "example": "82557f6f51ca956bee524cede1375331" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "flow": { - "$ref": "#/components/schemas/Flow" - }, - "rule": { - "$ref": "#/components/schemas/Rule" - }, - "parent": { - "$ref": "#/components/schemas/FlowSequence" - }, - "children": { + "products": { "type": "array", "items": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/CustomerWishlistProduct" } }, - "appFlowAction": { - "$ref": "#/components/schemas/AppFlowAction" + "customer": { + "$ref": "#/components/schemas/Customer" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "FlowTemplateJsonApi": { - "description": "Added since version: 6.4.18.0", + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -42307,50 +62059,131 @@ { "required": [ "id", - "name" + "productId", + "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "description": "Unique identity of the wishlist.", + "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" - }, - "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", + "CustomerWishlistProduct": { + "description": "Added since version: 6.3.4.0", "required": [ "id", - "name" + "productId", + "wishlistId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "config": { - "type": "object" + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "description": "Unique identity of the wishlist.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -42361,11 +62194,17 @@ "type": "string", "format": "date-time", "readOnly": true + }, + "wishlist": { + "$ref": "#/components/schemas/CustomerWishlist" + }, + "product": { + "$ref": "#/components/schemas/Product" } }, "type": "object" }, - "ImportExportFileJsonApi": { + "DeliveryTimeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -42374,32 +62213,36 @@ { "required": [ "id", - "originalName", - "path", - "expireDate" + "name", + "min", + "max", + "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalName": { - "type": "string" - }, - "path": { + "name": { "type": "string" }, - "expireDate": { - "type": "string", - "format": "date-time" + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" }, - "size": { + "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, - "accessToken": { + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42410,9 +62253,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "log": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -42420,21 +62266,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" + "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": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" + "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" + } } } } @@ -42449,36 +62328,40 @@ } ] }, - "ImportExportFile": { + "DeliveryTime": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "originalName", - "path", - "expireDate" + "name", + "min", + "max", + "unit" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "originalName": { - "type": "string" - }, - "path": { + "name": { "type": "string" }, - "expireDate": { - "type": "string", - "format": "date-time" + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" }, - "size": { + "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, - "accessToken": { + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42489,13 +62372,25 @@ "format": "date-time", "readOnly": true }, - "log": { - "$ref": "#/components/schemas/ImportExportLog" + "translated": { + "type": "object" + }, + "shippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ShippingMethod" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" }, - "ImportExportLogJsonApi": { + "DocumentJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -42504,52 +62399,56 @@ { "required": [ "id", - "activity", - "state", - "records", - "config" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "activity": { - "type": "string" - }, - "state": { - "type": "string" + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "records": { - "type": "integer", - "format": "int64" + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "profileId": { + "documentMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "fileId": { + "documentA11yMediaFileId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "invalidRecordsLogId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "username": { - "type": "string" + "config": { + "type": "object" }, - "profileName": { + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { "type": "string" }, - "config": { - "type": "object" + "documentNumber": { + "type": "string" }, - "result": { + "customFields": { "type": "object" }, "createdAt": { @@ -42564,7 +62463,7 @@ }, "relationships": { "properties": { - "user": { + "documentType": { "properties": { "links": { "type": "object", @@ -42572,7 +62471,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentType" } } }, @@ -42581,19 +62480,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "document_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "profile": { + "order": { "properties": { "links": { "type": "object", @@ -42601,7 +62500,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/order" } } }, @@ -42610,19 +62509,19 @@ "properties": { "type": { "type": "string", - "example": "import_export_profile" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7d97481b1fe66f4b51db90da7e794d9f" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "file": { + "referencedDocument": { "properties": { "links": { "type": "object", @@ -42630,7 +62529,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/file" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/referencedDocument" } } }, @@ -42639,19 +62538,19 @@ "properties": { "type": { "type": "string", - "example": "import_export_file" + "example": "document" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8c7dd922ad47494fc02c388e12c00eac" + "example": "75c3c346b0ef4f319e71925ce164a9ae" } } } }, "type": "object" }, - "invalidRecordsLog": { + "dependentDocuments": { "properties": { "links": { "type": "object", @@ -42659,28 +62558,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/invalidRecordsLog" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/dependentDocuments" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "46eeeb74b58b97a6a05494fa0024c998" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "e74b269b7d5f269051463569677da2a0" + } } } } }, "type": "object" }, - "failedImportLog": { + "documentMediaFile": { "properties": { "links": { "type": "object", @@ -42688,7 +62589,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/failedImportLog" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentMediaFile" } } }, @@ -42697,178 +62598,19 @@ "properties": { "type": { "type": "string", - "example": "import_export_log" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1d6996fa1560fc40e5faad086b07ad18" + "example": "ac7db1e6be481d6422fc63700e08279d" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "ImportExportLog": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "activity", - "state", - "records", - "config" - ], - "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" - ], - "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": { + }, + "documentA11yMediaFile": { "properties": { "links": { "type": "object", @@ -42876,23 +62618,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "import_export_log" - }, - "id": { - "type": "string", - "example": "e4ca733e3c1da4bff4cd4b6078f2237a" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" } } } @@ -42907,57 +62647,62 @@ } ] }, - "ImportExportProfile": { + "Document": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "label", - "sourceEntity", - "fileType", - "delimiter", - "enclosure" + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], "properties": { "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "label": { - "type": "string" - }, - "type": { - "type": "string" - }, - "systemDefault": { - "type": "boolean" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "sourceEntity": { - "type": "string" + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "fileType": { - "type": "string" + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "delimiter": { - "type": "string" + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "enclosure": { - "type": "string" + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "mapping": { - "type": "object" + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "updateBy": { - "type": "object" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "config": { "type": "object" }, - "technicalName": { + "sent": { + "type": "boolean" + }, + "static": { + "type": "boolean" + }, + "deepLinkCode": { "type": "string" }, - "name": { + "documentNumber": { "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -42968,19 +62713,31 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "importExportLogs": { + "order": { + "$ref": "#/components/schemas/Order" + }, + "referencedDocument": { + "$ref": "#/components/schemas/Document" + }, + "dependentDocuments": { "type": "array", "items": { - "$ref": "#/components/schemas/ImportExportLog" + "$ref": "#/components/schemas/Document" } + }, + "documentMediaFile": { + "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "IntegrationJsonApi": { + "DocumentBaseConfigJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -42989,51 +62746,63 @@ { "required": [ "id", - "label", - "accessKey", - "secretAccessKey" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "label": { - "type": "string" + "documentTypeId": { + "description": "Unique identity of the document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accessKey": { + "logoId": { + "description": "Unique identity of the company logo.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the document.", "type": "string" }, - "secretAccessKey": { + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, - "lastUsageAt": { - "type": "string", - "format": "date-time" + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" }, - "admin": { + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, - "customFields": { - "type": "object" + "documentNumber": { + "description": "Unique number associated with every document.", + "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" + "config": { + "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, "updatedAt": { "type": "string", "format": "date-time", "readOnly": true }, - "extensions": { + "relationships": { "properties": { - "createdNotifications": { + "documentType": { "properties": { "links": { "type": "object", @@ -43041,35 +62810,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/createdNotifications" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/documentType" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "notification" - }, - "id": { - "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "app": { + }, + "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -43077,7 +62840,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/logo" } } }, @@ -43086,19 +62849,19 @@ "properties": { "type": { "type": "string", - "example": "app" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d2a57dc1d883fd21fb9951699df71cc7" + "example": "96d6f2e7e1f705ab5e59c84a6dc009b2" } } } }, "type": "object" }, - "aclRoles": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -43106,7 +62869,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" + "example": "/document-base-config/4f8577ec262a1e35dfd795dc6bbde573/salesChannels" } } }, @@ -43117,11 +62880,11 @@ "properties": { "type": { "type": "string", - "example": "acl_role" + "example": "document_base_config_sales_channel" }, "id": { "type": "string", - "example": "e050a8081a3eb1d193c23cf0ef761183" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -43137,130 +62900,82 @@ } ] }, - "Integration": { + "DocumentBaseConfig": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "label", - "accessKey", - "secretAccessKey" + "documentTypeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "label": { - "type": "string" + "documentTypeId": { + "description": "Unique identity of the document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accessKey": { + "logoId": { + "description": "Unique identity of the company logo.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the document.", "type": "string" }, - "secretAccessKey": { + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, - "lastUsageAt": { - "type": "string", - "format": "date-time" + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" }, - "admin": { + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, - "customFields": { - "type": "object" + "documentNumber": { + "description": "Unique number associated with every document.", + "type": "string" }, - "deletedAt": { - "type": "string", - "format": "date-time" + "config": { + "type": "object" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, "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" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "app": { - "$ref": "#/components/schemas/App" + "logo": { + "$ref": "#/components/schemas/Media", + "description": "Logo in the document at the top-right corner." }, - "aclRoles": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/AclRole" + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } }, "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", + "DocumentBaseConfigSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -43268,47 +62983,25 @@ { "required": [ "id", - "name", - "url" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "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": { + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43322,12 +63015,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "tags": { + "documentType": { "properties": { "links": { "type": "object", @@ -43335,30 +63025,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentType" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "tag" - }, - "id": { - "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_type" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2e45fec65781ec559e2aea39372a55cd" } } } }, "type": "object" }, - "cmsPage": { + "documentBaseConfig": { "properties": { "links": { "type": "object", @@ -43366,7 +63054,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/documentBaseConfig" } } }, @@ -43375,19 +63063,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "document_base_config" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "56e59df02965ebf8eadea49fa0aadd47" } } } }, "type": "object" }, - "salesChannels": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -43395,54 +63083,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" } } }, "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": { "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" - } + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -43457,51 +63112,29 @@ } ] }, - "LandingPage": { - "description": "Added since version: 6.4.0.0", + "DocumentBaseConfigSalesChannel": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "name", - "url" + "documentBaseConfigId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "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": { + "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43515,98 +63148,19 @@ "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" + "documentType": { + "$ref": "#/components/schemas/DocumentType" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "documentBaseConfig": { + "$ref": "#/components/schemas/DocumentBaseConfig" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "LanguageJsonApi": { + "DocumentTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -43615,7 +63169,7 @@ { "required": [ "id", - "localeId", + "technicalName", "name" ], "properties": { @@ -43623,23 +63177,12 @@ "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" + "technicalName": { + "description": "Technical name of document type.", + "type": "string" }, "createdAt": { "type": "string", @@ -43651,9 +63194,15 @@ "format": "date-time", "readOnly": true }, + "customFields": { + "type": "object" + }, + "translated": { + "type": "object" + }, "extensions": { "properties": { - "subscriptions": { + "quoteDocuments": { "properties": { "links": { "type": "object", @@ -43661,7 +63210,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } } }, @@ -43672,19 +63221,24 @@ "properties": { "type": { "type": "string", - "example": "subscription" + "example": "quote_document" }, "id": { "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" } } } } }, "type": "object" - }, - "mediaAiTagTranslation": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "documents": { "properties": { "links": { "type": "object", @@ -43692,7 +63246,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documents" } } }, @@ -43703,11 +63257,11 @@ "properties": { "type": { "type": "string", - "example": "media_ai_tag_translation" + "example": "document" }, "id": { "type": "string", - "example": "e78da60cc3106508ef465909fa4cb138" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -43715,7 +63269,7 @@ }, "type": "object" }, - "quotes": { + "documentBaseConfigs": { "properties": { "links": { "type": "object", @@ -43723,7 +63277,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" } } }, @@ -43734,24 +63288,19 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "document_base_config" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } } }, "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "parent": { + }, + "documentBaseConfigSalesChannels": { "properties": { "links": { "type": "object", @@ -43759,57 +63308,193 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "9c990fde5b38ff70fc1a07bf84c12a17" + } } } } }, "type": "object" - }, - "locale": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "DocumentType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "description": "Technical name of document type.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "quoteDocuments": { + "properties": { + "links": { + "type": "object", "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" - } - } + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/quoteDocuments" } - }, - "type": "object" + } }, - "translationCode": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + } + }, + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the flow.", + "type": "string" + }, + "eventName": { + "description": "Name of the event.", + "type": "string" + }, + "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", + "type": "integer", + "format": "int64" + }, + "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", + "type": "boolean", + "readOnly": true + }, + "active": { + "description": "When boolean value is `true`, the flow is available for selection.", + "type": "boolean" + }, + "description": { + "description": "A short description of the defined flow.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "appFlowEventId": { + "description": "Unique identity of app flow event.", + "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": { + "delayActions": { "properties": { "links": { "type": "object", @@ -43817,28 +63502,35 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "locale" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "6ef2035242b8fcb7b61c3a41850e60b3" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } } } } }, "type": "object" - }, - "children": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "sequences": { "properties": { "links": { "type": "object", @@ -43846,7 +63538,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/sequences" } } }, @@ -43857,11 +63549,11 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "eb6710ddc89dae357ae94ca3974b1e38" } } } @@ -43869,7 +63561,7 @@ }, "type": "object" }, - "salesChannels": { + "appFlowEvent": { "properties": { "links": { "type": "object", @@ -43877,30 +63569,209 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/appFlowEvent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the flow.", + "type": "string" + }, + "eventName": { + "description": "Name of the event.", + "type": "string" + }, + "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", + "type": "integer", + "format": "int64" + }, + "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", + "type": "boolean", + "readOnly": true + }, + "active": { + "description": "When boolean value is `true`, the flow is available for selection.", + "type": "boolean" + }, + "description": { + "description": "A short description of the defined flow.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "appFlowEventId": { + "description": "Unique identity of app flow event.", + "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": { + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/flow/f1a76f66cca677c6e628d9ca58a6c8fc/delayActions" + } + } }, - "salesChannelDefaultAssignments": { + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "flowId": { + "description": "Unique identity of flow.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "actionName": { + "description": "Unique name of the action in the flow sequence.", + "type": "string" + }, + "config": { + "type": "object" + }, + "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "description": "The group to which the flow sequence is visible.", + "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 + }, + "extensions": { + "properties": { + "delayActions": { "properties": { "links": { "type": "object", @@ -43908,7 +63779,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" } } }, @@ -43919,11 +63790,11 @@ "properties": { "type": { "type": "string", - "example": "sales_channel" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "b23663b2abc0909be9a8027a3fbff74b" + "example": "edfed55799054673006c4b5a643489ac" } } } @@ -43931,7 +63802,7 @@ }, "type": "object" }, - "salesChannelDomains": { + "webhookEventLogs": { "properties": { "links": { "type": "object", @@ -43939,7 +63810,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" } } }, @@ -43950,19 +63821,24 @@ "properties": { "type": { "type": "string", - "example": "sales_channel_domain" + "example": "webhook_event_log" }, "id": { "type": "string", - "example": "b60ab8d110194bfe34ef9928ba48ab6d" + "example": "82557f6f51ca956bee524cede1375331" } } } } }, "type": "object" - }, - "customers": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "flow": { "properties": { "links": { "type": "object", @@ -43970,61 +63846,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/flow" } } }, "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": { "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" - } + "example": "flow" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "cff5497121104c2b8e0cb41ed2083a9b" } } } }, "type": "object" }, - "orders": { + "rule": { "properties": { "links": { "type": "object", @@ -44032,61 +63875,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/rule" } } }, "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": { "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" - } + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" } } } }, "type": "object" }, - "productKeywordDictionaries": { + "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -44094,30 +63905,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/parent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_keyword_dictionary" - }, - "id": { - "type": "string", - "example": "660e189a383ca4eb148e25eb0df85988" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "flow_sequence" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "productReviews": { + "children": { "properties": { "links": { "type": "object", @@ -44125,7 +63934,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/children" } } }, @@ -44136,11 +63945,11 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "268184c12df027f536154d099d497b31" } } } @@ -44148,7 +63957,7 @@ }, "type": "object" }, - "productSearchConfig": { + "appFlowAction": { "properties": { "links": { "type": "object", @@ -44156,7 +63965,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/appFlowAction" } } }, @@ -44165,12 +63974,12 @@ "properties": { "type": { "type": "string", - "example": "product_search_config" + "example": "app_flow_action" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8d4fbbaa71409309d308e57678de7d7a" + "example": "8ba9ae8a60ecf9be421e333b95703a68" } } } @@ -44185,36 +63994,58 @@ } ] }, - "Language": { - "description": "Added since version: 6.0.0.0", + "FlowSequence": { + "description": "Added since version: 6.4.6.0", "required": [ "id", - "localeId", - "name" + "flowId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "localeId": { + "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "translationCodeId": { + "actionName": { + "description": "Unique name of the action in the flow sequence.", + "type": "string" + }, + "config": { + "type": "object" + }, + "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", + "type": "integer", + "format": "int64" + }, + "displayGroup": { + "description": "The group to which the flow sequence is visible.", + "type": "integer", + "format": "int64" + }, + "trueCase": { + "type": "boolean" + }, + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { - "type": "string" - }, "customFields": { "type": "object" }, + "appFlowActionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdAt": { "type": "string", "format": "date-time", @@ -44227,38 +64058,7 @@ }, "extensions": { "properties": { - "subscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } - } - }, - "type": "object" - }, - "mediaAiTagTranslation": { + "delayActions": { "properties": { "links": { "type": "object", @@ -44266,7 +64066,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/delayActions" } } }, @@ -44277,11 +64077,11 @@ "properties": { "type": { "type": "string", - "example": "media_ai_tag_translation" + "example": "swag_delay_action" }, "id": { "type": "string", - "example": "e78da60cc3106508ef465909fa4cb138" + "example": "edfed55799054673006c4b5a643489ac" } } } @@ -44289,7 +64089,7 @@ }, "type": "object" }, - "quotes": { + "webhookEventLogs": { "properties": { "links": { "type": "object", @@ -44297,7 +64097,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" + "example": "/flow-sequence/983754f96cad338b500181a31b737d47/webhookEventLogs" } } }, @@ -44308,11 +64108,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "webhook_event_log" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "82557f6f51ca956bee524cede1375331" } } } @@ -44323,83 +64123,30 @@ }, "type": "object" }, - "parent": { - "$ref": "#/components/schemas/Language" + "flow": { + "$ref": "#/components/schemas/Flow" }, - "locale": { - "$ref": "#/components/schemas/Locale" + "rule": { + "$ref": "#/components/schemas/Rule" }, - "translationCode": { - "$ref": "#/components/schemas/Locale" + "parent": { + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "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" + "$ref": "#/components/schemas/FlowSequence" } }, - "productSearchConfig": { - "$ref": "#/components/schemas/ProductSearchConfig" + "appFlowAction": { + "$ref": "#/components/schemas/AppFlowAction" } }, "type": "object" }, - "LocaleJsonApi": { - "description": "Added since version: 6.0.0.0", + "FlowTemplateJsonApi": { + "description": "Added since version: 6.4.18.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -44407,25 +64154,18 @@ { "required": [ "id", - "code", - "name", - "territory" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "code": { - "type": "string" - }, "name": { + "description": "Name of the flow template.", "type": "string" }, - "territory": { - "type": "string" - }, - "customFields": { + "config": { "type": "object" }, "createdAt": { @@ -44437,205 +64177,28 @@ "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", + "FlowTemplate": { + "description": "Added since version: 6.4.18.0", "required": [ "id", - "code", - "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" - ], - "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" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "message": { - "type": "string" - }, - "level": { - "type": "integer", - "format": "int64" - }, - "channel": { + "name": { + "description": "Name of the flow template.", "type": "string" }, - "context": { - "type": "object" - }, - "extra": { + "config": { "type": "object" }, "createdAt": { @@ -44651,7 +64214,7 @@ }, "type": "object" }, - "MailHeaderFooterJsonApi": { + "ImportExportFileJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -44660,32 +64223,35 @@ { "required": [ "id", - "name" + "originalName", + "path", + "expireDate" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "description": { + "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, - "headerHtml": { + "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, - "headerPlain": { - "type": "string" + "expireDate": { + "description": "Date and time of import-export file expiry.", + "type": "string", + "format": "date-time" }, - "footerHtml": { - "type": "string" + "size": { + "description": "Size of the import-export file.", + "type": "integer", + "format": "int64" }, - "footerPlain": { + "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -44698,12 +64264,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "salesChannels": { + "log": { "properties": { "links": { "type": "object", @@ -44711,23 +64274,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" + "example": "/import-export-file/1e0a4283354a721dbed68499ce2db333/log" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "example": "986f6f891e90ab91c091ff4a1a460777" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "import_export_log" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "dc1d71bbb5c4d2a5e936db79ef10c19f" } } } @@ -44742,36 +64303,39 @@ } ] }, - "MailHeaderFooter": { + "ImportExportFile": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "name" + "originalName", + "path", + "expireDate" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "description": { + "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, - "headerHtml": { + "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, - "headerPlain": { - "type": "string" + "expireDate": { + "description": "Date and time of import-export file expiry.", + "type": "string", + "format": "date-time" }, - "footerHtml": { - "type": "string" + "size": { + "description": "Size of the import-export file.", + "type": "integer", + "format": "int64" }, - "footerPlain": { + "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -44784,19 +64348,13 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "log": { + "$ref": "#/components/schemas/ImportExportLog" } }, "type": "object" }, - "MailTemplateJsonApi": { + "ImportExportLogJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -44805,39 +64363,52 @@ { "required": [ "id", - "mailTemplateTypeId", - "subject", - "contentHtml", - "contentPlain" + "activity", + "state", + "records", + "config" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateTypeId": { + "activity": { + "type": "string" + }, + "state": { + "type": "string" + }, + "records": { + "type": "integer", + "format": "int64" + }, + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "senderName": { - "type": "string" + "fileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "invalidRecordsLogId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "subject": { + "username": { "type": "string" }, - "contentHtml": { + "profileName": { "type": "string" }, - "contentPlain": { - "type": "string" + "config": { + "type": "object" }, - "customFields": { + "result": { "type": "object" }, "createdAt": { @@ -44850,12 +64421,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "relationships": { "properties": { - "mailTemplateType": { + "user": { "properties": { "links": { "type": "object", @@ -44863,7 +64431,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/user" } } }, @@ -44872,19 +64440,19 @@ "properties": { "type": { "type": "string", - "example": "mail_template_type" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f4e3707ad46065609def210a855620cd" + "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, - "media": { + "profile": { "properties": { "links": { "type": "object", @@ -44892,23 +64460,108 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" + "example": "/import-export-log/4996be2318bb0b26fe9a5c57459062fa/profile" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "mail_template_media" - }, - "id": { - "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" - } + "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" } } } @@ -44923,43 +64576,56 @@ } ] }, - "MailTemplate": { + "ImportExportLog": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "mailTemplateTypeId", - "subject", - "contentHtml", - "contentPlain" + "activity", + "state", + "records", + "config" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mailTemplateTypeId": { + "activity": { + "type": "string" + }, + "state": { + "type": "string" + }, + "records": { + "type": "integer", + "format": "int64" + }, + "userId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "systemDefault": { - "type": "boolean" + "profileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "senderName": { - "type": "string" + "fileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "invalidRecordsLogId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "subject": { + "username": { "type": "string" }, - "contentHtml": { + "profileName": { "type": "string" }, - "contentPlain": { - "type": "string" + "config": { + "type": "object" }, - "customFields": { + "result": { "type": "object" }, "createdAt": { @@ -44972,60 +64638,25 @@ "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}$" + "user": { + "$ref": "#/components/schemas/User" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "profile": { + "$ref": "#/components/schemas/ImportExportProfile" }, - "position": { - "type": "integer", - "format": "int64" + "file": { + "$ref": "#/components/schemas/ImportExportFile" }, - "mailTemplate": { - "$ref": "#/components/schemas/MailTemplate" + "invalidRecordsLog": { + "$ref": "#/components/schemas/ImportExportLog" }, - "media": { - "$ref": "#/components/schemas/Media" + "failedImportLog": { + "$ref": "#/components/schemas/ImportExportLog" } }, "type": "object" }, - "MailTemplateTypeJsonApi": { + "ImportExportProfileJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -45035,26 +64666,53 @@ "required": [ "id", "technicalName", - "name" + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "technicalName": { "type": "string" }, - "technicalName": { + "label": { "type": "string" }, - "availableEntities": { + "type": { + "description": "Import-export type can be orders, customers, categories.", + "type": "string" + }, + "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", + "type": "boolean" + }, + "sourceEntity": { + "type": "string" + }, + "fileType": { + "description": "Type of file like PDF.", + "type": "string" + }, + "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", + "type": "string" + }, + "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", + "type": "string" + }, + "mapping": { "type": "object" }, - "customFields": { + "updateBy": { "type": "object" }, - "templateData": { + "config": { "type": "object" }, "createdAt": { @@ -45072,7 +64730,7 @@ }, "relationships": { "properties": { - "mailTemplates": { + "importExportLogs": { "properties": { "links": { "type": "object", @@ -45080,7 +64738,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" + "example": "/import-export-profile/59e9b5cef4e569ce1af9aaa1d37135fc/importExportLogs" } } }, @@ -45091,11 +64749,11 @@ "properties": { "type": { "type": "string", - "example": "mail_template" + "example": "import_export_log" }, "id": { "type": "string", - "example": "e6f502f7d88de75db45325d22998cf6d" + "example": "e4ca733e3c1da4bff4cd4b6078f2237a" } } } @@ -45111,31 +64769,58 @@ } ] }, - "MailTemplateType": { + "ImportExportProfile": { "description": "Added since version: 6.0.0.0", "required": [ "id", "technicalName", - "name" + "label", + "sourceEntity", + "fileType", + "delimiter", + "enclosure" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "technicalName": { "type": "string" }, - "technicalName": { + "label": { "type": "string" }, - "availableEntities": { + "type": { + "description": "Import-export type can be orders, customers, categories.", + "type": "string" + }, + "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", + "type": "boolean" + }, + "sourceEntity": { + "type": "string" + }, + "fileType": { + "description": "Type of file like PDF.", + "type": "string" + }, + "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", + "type": "string" + }, + "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", + "type": "string" + }, + "mapping": { "type": "object" }, - "customFields": { + "updateBy": { "type": "object" }, - "templateData": { + "config": { "type": "object" }, "createdAt": { @@ -45151,17 +64836,17 @@ "translated": { "type": "object" }, - "mailTemplates": { + "importExportLogs": { "type": "array", "items": { - "$ref": "#/components/schemas/MailTemplate" + "$ref": "#/components/schemas/ImportExportLog" } } }, "type": "object" }, - "MainCategoryJsonApi": { - "description": "Added since version: 6.1.0.0", + "IntegrationJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -45169,34 +64854,43 @@ { "required": [ "id", - "productId", - "categoryId", - "salesChannelId" + "label", + "accessKey", + "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "description": "Label given to Integration.", + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "accessKey": { + "description": "Access key to store api.", + "type": "string" }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "secretAccessKey": { + "description": "Secret key required for secure communication.", + "type": "string" }, - "categoryVersionId": { + "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "salesChannelId": { + "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, "createdAt": { "type": "string", @@ -45208,9 +64902,45 @@ "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": { - "product": { + "app": { "properties": { "links": { "type": "object", @@ -45218,7 +64948,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/product" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/app" } } }, @@ -45227,19 +64957,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } }, "type": "object" }, - "category": { + "stateMachineHistoryEntries": { "properties": { "links": { "type": "object", @@ -45247,28 +64977,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/category" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "category" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c4ef352f74e502ef5e7bc98e6f4e493d" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "c78c7ea361b7def0876b75bd1bd37879" + } } } } }, "type": "object" }, - "salesChannel": { + "aclRoles": { "properties": { "links": { "type": "object", @@ -45276,21 +65008,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/main-category/ea5e6ad409757a2bf4b9f4c597fadc53/salesChannel" + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/aclRoles" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "acl_role" + }, + "id": { + "type": "string", + "example": "e050a8081a3eb1d193c23cf0ef761183" + } } } } @@ -45305,38 +65039,47 @@ } ] }, - "MainCategory": { - "description": "Added since version: 6.1.0.0", + "Integration": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "productId", - "categoryId", - "salesChannelId" + "label", + "accessKey", + "secretAccessKey" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "label": { + "description": "Label given to Integration.", + "type": "string" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "accessKey": { + "description": "Access key to store api.", + "type": "string" }, - "categoryId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "secretAccessKey": { + "description": "Secret key required for secure communication.", + "type": "string" }, - "categoryVersionId": { + "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "salesChannelId": { + "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, "createdAt": { "type": "string", @@ -45348,96 +65091,140 @@ "format": "date-time", "readOnly": true }, - "product": { - "$ref": "#/components/schemas/Product" + "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" }, - "category": { - "$ref": "#/components/schemas/Category" + "app": { + "$ref": "#/components/schemas/App" }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, + "aclRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AclRole" + } } }, "type": "object" }, - "MediaJsonApi": { - "description": "Added since version: 6.0.0.0", + "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" + "id", + "name", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "mediaFolderId": { + "versionId": { "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 + "active": { + "type": "boolean" }, - "metaData": { - "type": "object", - "readOnly": true + "name": { + "type": "string" }, - "mediaType": { - "type": "object", - "readOnly": true + "customFields": { + "type": "object" }, - "config": { + "slotConfig": { "type": "object" }, - "alt": { + "metaTitle": { "type": "string" }, - "title": { + "metaDescription": { "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "keywords": { "type": "string" }, - "path": { + "url": { "type": "string" }, - "hasFile": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "private": { - "type": "boolean" + "cmsPageId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -45452,40 +65239,9 @@ "translated": { "type": "object" }, - "extensions": { + "relationships": { "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": { + "tags": { "properties": { "links": { "type": "object", @@ -45493,7 +65249,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/tags" } } }, @@ -45504,11 +65260,11 @@ "properties": { "type": { "type": "string", - "example": "theme" + "example": "tag" }, "id": { "type": "string", - "example": "260be9ecb281c4ff04e7189bb18a35bd" + "example": "d57ac45256849d9b13e2422d91580fb9" } } } @@ -45516,7 +65272,8 @@ }, "type": "object" }, - "mediaAiTag": { + "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -45524,7 +65281,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/cmsPage" } } }, @@ -45533,50 +65290,19 @@ "properties": { "type": { "type": "string", - "example": "media_ai_tag" + "example": "cms_page" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "3c88197809d464216a8c40a8db191b38" - } - } - } - }, - "type": "object" - }, - "ssoProviders": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sso_provider" - }, - "id": { - "type": "string", - "example": "520b66891556bf9309da72937c4f1f98" - } + "example": "7b1460918b1abb93311108f3dc021c9b" } } } }, "type": "object" }, - "quoteDocuments": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -45584,7 +65310,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/salesChannels" } } }, @@ -45595,11 +65321,11 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "sales_channel" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -45607,7 +65333,8 @@ }, "type": "object" }, - "spatialObjects": { + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -45615,7 +65342,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + "example": "/landing-page/815c27537bec3b60c50a2ae4d2ce875d/seoUrls" } } }, @@ -45626,11 +65353,11 @@ "properties": { "type": { "type": "string", - "example": "spatial_scene_object" + "example": "seo_url" }, "id": { "type": "string", - "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + "example": "5321b5a71127b8b98cdd4b068ad56c4c" } } } @@ -45640,10 +65367,217 @@ } }, "type": "object" + } + }, + "type": "object" + } + ] + }, + "LandingPage": { + "description": "Added since version: 6.4.0.0", + "required": [ + "id", + "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", + "description": "CMS page layout for the landing page" + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "description": "Unique identity of locale.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "translationCodeId": { + "description": "Unique identity of translation code.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the language.", + "type": "string" + }, + "active": { + "type": "boolean" + }, + "customFields": { + "type": "object" }, - "relationships": { + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { "properties": { - "tags": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -45651,7 +65585,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/tags" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" } } }, @@ -45662,11 +65596,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "subscription" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -45674,7 +65608,7 @@ }, "type": "object" }, - "thumbnails": { + "mediaAiTagTranslation": { "properties": { "links": { "type": "object", @@ -45682,7 +65616,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/thumbnails" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" } } }, @@ -45693,11 +65627,11 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail" + "example": "media_ai_tag_translation" }, "id": { "type": "string", - "example": "3b8779ba05b8f0aed49650f3ff8beb4b" + "example": "e78da60cc3106508ef465909fa4cb138" } } } @@ -45705,36 +65639,7 @@ }, "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": { + "quotes": { "properties": { "links": { "type": "object", @@ -45742,7 +65647,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" } } }, @@ -45753,11 +65658,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "quote" }, "id": { "type": "string", - "example": "b0b5ccb4a195a07fd3eed14affb8695f" + "example": "2150fd65034a9bcdb357943b3900a918" } } } @@ -45765,7 +65670,7 @@ }, "type": "object" }, - "productManufacturers": { + "b2bEmployees": { "properties": { "links": { "type": "object", @@ -45773,7 +65678,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" } } }, @@ -45784,11 +65689,11 @@ "properties": { "type": { "type": "string", - "example": "product_manufacturer" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "30e3a0f8868364c06aa4be63426c1c79" + "example": "2193894cca6bb5864b8607f09be77ace" } } } @@ -45796,7 +65701,7 @@ }, "type": "object" }, - "productMedia": { + "advancedSearchSynonyms": { "properties": { "links": { "type": "object", @@ -45804,7 +65709,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" } } }, @@ -45815,11 +65720,11 @@ "properties": { "type": { "type": "string", - "example": "product_media" + "example": "advanced_search_synonym" }, "id": { "type": "string", - "example": "2b5e079404830806ea36b6c17438cffd" + "example": "a139d0125b356216337e8386fca65e22" } } } @@ -45827,7 +65732,7 @@ }, "type": "object" }, - "productDownloads": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -45835,7 +65740,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" } } }, @@ -45846,11 +65751,11 @@ "properties": { "type": { "type": "string", - "example": "product_download" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "86db490c1f4f52d155dbdb978b1f45d3" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } @@ -45858,7 +65763,7 @@ }, "type": "object" }, - "orderLineItemDownloads": { + "b2bAppScriptConditions": { "properties": { "links": { "type": "object", @@ -45866,7 +65771,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" } } }, @@ -45877,19 +65782,25 @@ "properties": { "type": { "type": "string", - "example": "order_line_item_download" + "example": "b2b_components_approval_rule_app_script_condition_translation" }, "id": { "type": "string", - "example": "8c0a5ecd281c97a912c27c0237b3848f" + "example": "880f55611c0f2ac1026271d799698c6e" } } } } }, "type": "object" - }, - "avatarUsers": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -45897,30 +65808,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/parent" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "example": "1fc09529f6c95370eb20b81318ff601f" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "language" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "mediaFolder": { + "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -45928,7 +65838,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/locale" } } }, @@ -45937,19 +65847,20 @@ "properties": { "type": { "type": "string", - "example": "media_folder" + "example": "locale" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70605921a592ee735964394f7948773b" + "example": "fb216d9e8791e63c8d12bdc420956839" } } } }, "type": "object" }, - "propertyGroupOptions": { + "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -45957,61 +65868,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/propertyGroupOptions" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/translationCode" } } }, "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": { "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" - } + "example": "locale" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "6ef2035242b8fcb7b61c3a41850e60b3" } } } }, "type": "object" }, - "documentBaseConfigs": { + "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -46019,7 +65898,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/children" } } }, @@ -46030,11 +65909,11 @@ "properties": { "type": { "type": "string", - "example": "document_base_config" + "example": "language" }, "id": { "type": "string", - "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + "example": "268184c12df027f536154d099d497b31" } } } @@ -46042,7 +65921,7 @@ }, "type": "object" }, - "shippingMethods": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -46050,7 +65929,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannels" } } }, @@ -46061,11 +65940,11 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "sales_channel" }, "id": { "type": "string", - "example": "8268b0a6c902fbde485094c2f627b854" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -46073,7 +65952,7 @@ }, "type": "object" }, - "paymentMethods": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -46081,7 +65960,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDefaultAssignments" } } }, @@ -46092,11 +65971,11 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "sales_channel" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -46104,7 +65983,7 @@ }, "type": "object" }, - "productConfiguratorSettings": { + "salesChannelDomains": { "properties": { "links": { "type": "object", @@ -46112,7 +65991,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/productConfiguratorSettings" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/salesChannelDomains" } } }, @@ -46123,11 +66002,11 @@ "properties": { "type": { "type": "string", - "example": "product_configurator_setting" + "example": "sales_channel_domain" }, "id": { "type": "string", - "example": "4d46eb45eaf392b26bd46f0ea8cb93e0" + "example": "b60ab8d110194bfe34ef9928ba48ab6d" } } } @@ -46135,7 +66014,7 @@ }, "type": "object" }, - "orderLineItems": { + "customers": { "properties": { "links": { "type": "object", @@ -46143,7 +66022,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItems" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/customers" } } }, @@ -46154,11 +66033,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "customer" }, "id": { "type": "string", - "example": "6bd56ce4562ca1be86bf5b8d92c3c1ee" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -46166,7 +66045,7 @@ }, "type": "object" }, - "cmsBlocks": { + "newsletterRecipients": { "properties": { "links": { "type": "object", @@ -46174,7 +66053,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsBlocks" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/newsletterRecipients" } } }, @@ -46185,11 +66064,11 @@ "properties": { "type": { "type": "string", - "example": "cms_block" + "example": "newsletter_recipient" }, "id": { "type": "string", - "example": "3636c4901eab836dfb837e1a9a37d3c0" + "example": "2217f01dc5cddfd5b60387c39867f58e" } } } @@ -46197,7 +66076,7 @@ }, "type": "object" }, - "cmsSections": { + "orders": { "properties": { "links": { "type": "object", @@ -46205,7 +66084,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/orders" } } }, @@ -46216,11 +66095,11 @@ "properties": { "type": { "type": "string", - "example": "cms_section" + "example": "order" }, "id": { "type": "string", - "example": "53be3cc1c4a8f41af67a90cf9fd09194" + "example": "12c500ed0b7879105fb46af0f246be87" } } } @@ -46228,7 +66107,7 @@ }, "type": "object" }, - "cmsPages": { + "productSearchKeywords": { "properties": { "links": { "type": "object", @@ -46236,7 +66115,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchKeywords" } } }, @@ -46247,11 +66126,11 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "product_search_keyword" }, "id": { "type": "string", - "example": "e676148cc6ffb82b89b3903ecaed2d16" + "example": "ea9cb6522f347c9212c9459d63c645f4" } } } @@ -46259,7 +66138,7 @@ }, "type": "object" }, - "documents": { + "productKeywordDictionaries": { "properties": { "links": { "type": "object", @@ -46267,7 +66146,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productKeywordDictionaries" } } }, @@ -46278,11 +66157,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "product_keyword_dictionary" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "660e189a383ca4eb148e25eb0df85988" } } } @@ -46290,7 +66169,7 @@ }, "type": "object" }, - "appPaymentMethods": { + "productReviews": { "properties": { "links": { "type": "object", @@ -46298,7 +66177,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productReviews" } } }, @@ -46309,11 +66188,11 @@ "properties": { "type": { "type": "string", - "example": "app_payment_method" + "example": "product_review" }, "id": { "type": "string", - "example": "e53c737d351047e64a02b7a2a4caffe3" + "example": "01e78541ea343ed72424a5222796a4cd" } } } @@ -46321,7 +66200,7 @@ }, "type": "object" }, - "appShippingMethods": { + "productSearchConfig": { "properties": { "links": { "type": "object", @@ -46329,23 +66208,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/productSearchConfig" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "app_shipping_method" - }, - "id": { - "type": "string", - "example": "1ad05ee47064647ee5b2dc8c12b1041c" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_search_config" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8d4fbbaa71409309d308e57678de7d7a" } } } @@ -46360,75 +66237,37 @@ } ] }, - "Media": { + "Language": { "description": "Added since version: 6.0.0.0", "required": [ - "id" + "id", + "localeId", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { + "parentId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaFolderId": { + "localeId": { + "description": "Unique identity of locale.", "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": { + "translationCodeId": { + "description": "Unique identity of translation code.", "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" + "pattern": "^[0-9a-f]{32}$" }, - "path": { + "name": { + "description": "Name of the language.", "type": "string" }, - "hasFile": { - "description": "Runtime field, cannot be used as part of the criteria.", - "type": "boolean" - }, - "private": { + "active": { "type": "boolean" }, "customFields": { @@ -46444,12 +66283,9 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, "extensions": { "properties": { - "themes": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -46457,7 +66293,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/subscriptions" } } }, @@ -46468,11 +66304,11 @@ "properties": { "type": { "type": "string", - "example": "theme" + "example": "subscription" }, "id": { "type": "string", - "example": "fe021943dcda87150f590b3475afaded" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -46480,7 +66316,7 @@ }, "type": "object" }, - "themeMedia": { + "mediaAiTagTranslation": { "properties": { "links": { "type": "object", @@ -46488,7 +66324,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/mediaAiTagTranslation" } } }, @@ -46499,11 +66335,11 @@ "properties": { "type": { "type": "string", - "example": "theme" + "example": "media_ai_tag_translation" }, "id": { "type": "string", - "example": "260be9ecb281c4ff04e7189bb18a35bd" + "example": "e78da60cc3106508ef465909fa4cb138" } } } @@ -46511,7 +66347,7 @@ }, "type": "object" }, - "mediaAiTag": { + "quotes": { "properties": { "links": { "type": "object", @@ -46519,28 +66355,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/quotes" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_ai_tag" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "3c88197809d464216a8c40a8db191b38" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } } } } }, "type": "object" }, - "ssoProviders": { + "b2bEmployees": { "properties": { "links": { "type": "object", @@ -46548,7 +66386,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bEmployees" } } }, @@ -46559,11 +66397,11 @@ "properties": { "type": { "type": "string", - "example": "sso_provider" + "example": "b2b_employee" }, "id": { "type": "string", - "example": "520b66891556bf9309da72937c4f1f98" + "example": "2193894cca6bb5864b8607f09be77ace" } } } @@ -46571,7 +66409,7 @@ }, "type": "object" }, - "quoteDocuments": { + "advancedSearchSynonyms": { "properties": { "links": { "type": "object", @@ -46579,7 +66417,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/advancedSearchSynonyms" } } }, @@ -46590,11 +66428,11 @@ "properties": { "type": { "type": "string", - "example": "quote_document" + "example": "advanced_search_synonym" }, "id": { "type": "string", - "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + "example": "a139d0125b356216337e8386fca65e22" } } } @@ -46602,7 +66440,7 @@ }, "type": "object" }, - "spatialObjects": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -46610,7 +66448,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bPendingOrders" } } }, @@ -46621,157 +66459,133 @@ "properties": { "type": { "type": "string", - "example": "spatial_scene_object" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "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" - } + }, + "b2bAppScriptConditions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/language/4994a8ffeba4ac3140beb89e8d41f174/b2bAppScriptConditions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_approval_rule_app_script_condition_translation" + }, + "id": { + "type": "string", + "example": "880f55611c0f2ac1026271d799698c6e" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" }, - "mediaFolder": { - "$ref": "#/components/schemas/MediaFolder" + "parent": { + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, - "propertyGroupOptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "locale": { + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, - "mailTemplateMedia": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateMedia" - } + "translationCode": { + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" }, - "documentBaseConfigs": { + "children": { + "description": "Child languages inheriting from this parent language", "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/Language" } }, - "shippingMethods": { + "salesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/SalesChannel" } }, - "paymentMethods": { + "salesChannelDefaultAssignments": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/SalesChannel" } }, - "productConfiguratorSettings": { + "salesChannelDomains": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" + "$ref": "#/components/schemas/SalesChannelDomain" } }, - "orderLineItems": { + "customers": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/Customer" } }, - "cmsBlocks": { + "newsletterRecipients": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/NewsletterRecipient" } }, - "cmsSections": { + "orders": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/Order" } }, - "cmsPages": { + "productSearchKeywords": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/ProductSearchKeyword" } }, - "documents": { + "productKeywordDictionaries": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/ProductKeywordDictionary" } }, - "appPaymentMethods": { + "productReviews": { "type": "array", "items": { - "$ref": "#/components/schemas/AppPaymentMethod" + "$ref": "#/components/schemas/ProductReview" } }, - "appShippingMethods": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "productSearchConfig": { + "$ref": "#/components/schemas/ProductSearchConfig" } }, "type": "object" }, - "MediaAiTagJsonApi": { + "LocaleJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -46779,27 +66593,27 @@ { "required": [ "id", - "mediaId" + "code", + "name", + "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "code": { + "description": "Code given to the locale. For example: en-CA.", + "type": "string" }, - "needsAnalysis": { - "type": "boolean", - "readOnly": true + "name": { + "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "territory": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -46816,7 +66630,7 @@ }, "relationships": { "properties": { - "media": { + "languages": { "properties": { "links": { "type": "object", @@ -46824,21 +66638,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/media" + "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": { - "type": { - "type": "string", - "example": "media" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "format": "uri-reference", + "example": "/locale/911f0f24bdce6808f4614d6a263b143b/users" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" + } } } } @@ -46853,30 +66700,31 @@ } ] }, - "MediaAiTag": { + "Locale": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "mediaId" + "code", + "name", + "territory" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "code": { + "description": "Code given to the locale. For example: en-CA.", + "type": "string" }, - "needsAnalysis": { - "type": "boolean", - "readOnly": true + "name": { + "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } + "territory": { + "type": "string" + }, + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -46891,13 +66739,22 @@ "translated": { "type": "object" }, - "media": { - "$ref": "#/components/schemas/Media" + "languages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Language" + } + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } } }, "type": "object" }, - "MediaDefaultFolderJsonApi": { + "LogEntryJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -46905,18 +66762,29 @@ }, { "required": [ - "id", - "entity" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { + "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, - "customFields": { + "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", + "type": "integer", + "format": "int64" + }, + "channel": { + "type": "string" + }, + "context": { + "type": "object" + }, + "extra": { "type": "object" }, "createdAt": { @@ -46928,61 +66796,38 @@ "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": { + "LogEntry": { "description": "Added since version: 6.0.0.0", "required": [ - "id", - "entity" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "entity": { + "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, - "customFields": { + "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", + "type": "integer", + "format": "int64" + }, + "channel": { + "type": "string" + }, + "context": { + "type": "object" + }, + "extra": { "type": "object" }, "createdAt": { @@ -46994,14 +66839,11 @@ "type": "string", "format": "date-time", "readOnly": true - }, - "folder": { - "$ref": "#/components/schemas/MediaFolder" } }, "type": "object" }, - "MediaFolderJsonApi": { + "MailHeaderFooterJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -47010,7 +66852,6 @@ { "required": [ "id", - "configurationId", "name" ], "properties": { @@ -47018,35 +66859,26 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "useParentConfiguration": { + "systemDefault": { "type": "boolean" }, - "configurationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "description": { + "type": "string" }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true + "headerHtml": { + "type": "string" }, - "path": { - "type": "string", - "readOnly": true + "headerPlain": { + "type": "string" }, - "name": { + "footerHtml": { "type": "string" }, - "customFields": { - "type": "object" + "footerPlain": { + "type": "string" }, "createdAt": { "type": "string", @@ -47058,69 +66890,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -47128,7 +66903,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" + "example": "/mail-header-footer/d4e12da612e348a322edb9e721a365ef/salesChannels" } } }, @@ -47139,19 +66914,140 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "sales_channel" }, "id": { "type": "string", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } } }, "type": "object" - }, - "defaultFolder": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MailHeaderFooter": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "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", + "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", @@ -47159,7 +67055,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/mailTemplateType" } } }, @@ -47168,19 +67064,19 @@ "properties": { "type": { "type": "string", - "example": "media_default_folder" + "example": "mail_template_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "251dcc9b1621d34e6b01ee14c26b3027" + "example": "f4e3707ad46065609def210a855620cd" } } } }, "type": "object" }, - "configuration": { + "media": { "properties": { "links": { "type": "object", @@ -47188,21 +67084,23 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" + "example": "/mail-template/901aa1bf1715ad482f037eaa8b9cdc3a/media" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media_folder_configuration" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ccd1066343c95877b75b79d47c36bebe" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template_media" + }, + "id": { + "type": "string", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } } } } @@ -47217,43 +67115,40 @@ } ] }, - "MediaFolder": { + "MailTemplate": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "configurationId", - "name" + "mailTemplateTypeId", + "subject", + "contentHtml", + "contentPlain" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "useParentConfiguration": { - "type": "boolean" - }, - "configurationId": { + "mailTemplateTypeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultFolderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "systemDefault": { + "type": "boolean" }, - "parentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "senderName": { + "type": "string" }, - "childCount": { - "type": "integer", - "format": "int64", - "readOnly": true + "description": { + "type": "string" }, - "path": { - "type": "string", - "readOnly": true + "subject": { + "type": "string" }, - "name": { + "contentHtml": { + "type": "string" + }, + "contentPlain": { "type": "string" }, "customFields": { @@ -47269,31 +67164,60 @@ "format": "date-time", "readOnly": true }, - "parent": { - "$ref": "#/components/schemas/MediaFolder" + "translated": { + "type": "object" }, - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } + "mailTemplateType": { + "$ref": "#/components/schemas/MailTemplateType" }, "media": { "type": "array", "items": { - "$ref": "#/components/schemas/Media" + "$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}$" }, - "defaultFolder": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "mailTemplateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "configuration": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "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" }, - "MediaFolderConfigurationJsonApi": { + "MailTemplateTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -47301,32 +67225,31 @@ }, { "required": [ - "id" + "id", + "technicalName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createThumbnails": { - "type": "boolean" - }, - "keepAspectRatio": { - "type": "boolean" - }, - "thumbnailQuality": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, - "private": { - "type": "boolean" + "technicalName": { + "description": "Technical name of mail template.", + "type": "string" }, - "noAssociation": { - "type": "boolean" + "availableEntities": { + "type": "object" }, "customFields": { "type": "object" }, + "templateData": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -47337,40 +67260,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "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": { + "mailTemplates": { "properties": { "links": { "type": "object", @@ -47378,7 +67273,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" + "example": "/mail-template-type/e0107df21530abfba881ccec2728ac79/mailTemplates" } } }, @@ -47389,11 +67284,11 @@ "properties": { "type": { "type": "string", - "example": "media_thumbnail_size" + "example": "mail_template" }, "id": { "type": "string", - "example": "44dee48a0006e8db2fcec2a5e1456449" + "example": "e6f502f7d88de75db45325d22998cf6d" } } } @@ -47409,35 +67304,34 @@ } ] }, - "MediaFolderConfiguration": { + "MailTemplateType": { "description": "Added since version: 6.0.0.0", "required": [ - "id" + "id", + "technicalName", + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "createThumbnails": { - "type": "boolean" - }, - "keepAspectRatio": { - "type": "boolean" - }, - "thumbnailQuality": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, - "private": { - "type": "boolean" + "technicalName": { + "description": "Technical name of mail template.", + "type": "string" }, - "noAssociation": { - "type": "boolean" + "availableEntities": { + "type": "object" }, "customFields": { "type": "object" }, + "templateData": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -47448,79 +67342,226 @@ "format": "date-time", "readOnly": true }, - "mediaFolders": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" - } + "translated": { + "type": "object" }, - "mediaThumbnailSizes": { + "mailTemplates": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "$ref": "#/components/schemas/MailTemplate" } } }, "type": "object" }, - "MediaFolderConfigurationMediaThumbnailSize": { - "description": "Added since version: 6.0.0.0", + "MainCategoryJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "categoryId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryId": { + "description": "Unique identity of the category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "categoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "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": [ - "mediaFolderConfigurationId", - "mediaThumbnailSizeId" + "id", + "productId", + "categoryId", + "salesChannelId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaFolderConfigurationId": { + "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaThumbnailSizeId": { + "productVersionId": { "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": { + "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "categoryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "tagId": { + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "media": { - "$ref": "#/components/schemas/Media" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tag": { - "$ref": "#/components/schemas/Tag" + "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" }, - "MediaThumbnailJsonApi": { - "description": "Added since version: 6.0.0.0", + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -47528,34 +67569,40 @@ { "required": [ "id", - "mediaId", - "width", - "height" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "type": "integer", - "format": "int64", - "readOnly": true + "default": { + "type": "boolean" }, - "height": { - "type": "integer", - "format": "int64", - "readOnly": true + "type": { + "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "shortName": { "type": "string" }, - "path": { + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "name": { "type": "string" }, "customFields": { @@ -47571,9 +67618,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "media": { + "measurementSystem": { "properties": { "links": { "type": "object", @@ -47581,7 +67631,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" } } }, @@ -47590,12 +67640,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "measurement_system" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "c0484ac171c930ce54e78cd2e0d80e5a" } } } @@ -47610,38 +67660,44 @@ } ] }, - "MediaThumbnail": { - "description": "Added since version: 6.0.0.0", + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "mediaId", - "width", - "height" + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "measurementSystemId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "type": "integer", - "format": "int64", - "readOnly": true + "default": { + "type": "boolean" }, - "height": { - "type": "integer", - "format": "int64", - "readOnly": true + "type": { + "type": "string" }, - "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "shortName": { "type": "string" }, - "path": { + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "name": { "type": "string" }, "customFields": { @@ -47657,14 +67713,17 @@ "format": "date-time", "readOnly": true }, - "media": { - "$ref": "#/components/schemas/Media" + "translated": { + "type": "object" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" } }, "type": "object" }, - "MediaThumbnailSizeJsonApi": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -47672,21 +67731,18 @@ { "required": [ "id", - "width", - "height" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "type": "integer", - "format": "int64" + "technicalName": { + "type": "string" }, - "height": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, "customFields": { "type": "object" @@ -47701,9 +67757,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "mediaFolderConfigurations": { + "units": { "properties": { "links": { "type": "object", @@ -47711,7 +67770,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaFolderConfigurations" + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" } } }, @@ -47722,11 +67781,11 @@ "properties": { "type": { "type": "string", - "example": "media_folder_configuration" + "example": "measurement_display_unit" }, "id": { "type": "string", - "example": "056df7a700173d83ebb685b1a890f09b" + "example": "b98b3dfbd27e710e6c3ceeae58770b52" } } } @@ -47742,25 +67801,22 @@ } ] }, - "MediaThumbnailSize": { - "description": "Added since version: 6.0.0.0", + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", "required": [ "id", - "width", - "height" + "technicalName" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "width": { - "type": "integer", - "format": "int64" + "technicalName": { + "type": "string" }, - "height": { - "type": "integer", - "format": "int64" + "name": { + "type": "string" }, "customFields": { "type": "object" @@ -47775,16 +67831,19 @@ "format": "date-time", "readOnly": true }, - "mediaFolderConfigurations": { + "translated": { + "type": "object" + }, + "units": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "$ref": "#/components/schemas/MeasurementDisplayUnit" } } }, "type": "object" }, - "NewsletterRecipientJsonApi": { + "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -47792,63 +67851,84 @@ }, { "required": [ - "id", - "email", - "status", - "hash", - "languageId", - "salesChannelId" + "id" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "email": { - "type": "string" + "userId": { + "description": "Unique identity of the user", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "title": { - "type": "string" + "mediaFolderId": { + "description": "Unique identity of the media folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "firstName": { + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, - "lastName": { + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", "type": "string" }, - "zipCode": { - "type": "string" + "uploadedAt": { + "description": "Date and time at which media was added.", + "type": "string", + "format": "date-time", + "readOnly": true }, - "city": { + "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, - "street": { + "fileSize": { + "description": "Size of the file media file uploaded.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "metaData": { + "type": "object", + "readOnly": true + }, + "mediaType": { + "type": "object", + "readOnly": true + }, + "config": { + "type": "object" + }, + "alt": { "type": "string" }, - "status": { + "title": { "type": "string" }, - "hash": { + "url": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "customFields": { - "type": "object" + "path": { + "type": "string" }, - "confirmedAt": { - "type": "string", - "format": "date-time" + "hasFile": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "private": { + "description": "When `true`, the media display is kept private.", + "type": "boolean" }, - "languageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "fileHash": { + "type": "string" }, "createdAt": { "type": "string", @@ -47860,9 +67940,12 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "translated": { + "type": "object" + }, + "extensions": { "properties": { - "tags": { + "themes": { "properties": { "links": { "type": "object", @@ -47870,7 +67953,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" + "example": "/media/3b563524fdb17b4a86590470d40bef74/themes" } } }, @@ -47881,11 +67964,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "theme" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "fe021943dcda87150f590b3475afaded" } } } @@ -47893,7 +67976,7 @@ }, "type": "object" }, - "salutation": { + "themeMedia": { "properties": { "links": { "type": "object", @@ -47901,7 +67984,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" + "example": "/media/3b563524fdb17b4a86590470d40bef74/themeMedia" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "theme" + }, + "id": { + "type": "string", + "example": "260be9ecb281c4ff04e7189bb18a35bd" + } + } + } + } + }, + "type": "object" + }, + "mediaAiTag": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" } } }, @@ -47910,19 +68024,19 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "media_ai_tag" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "3c88197809d464216a8c40a8db191b38" } } } }, "type": "object" }, - "language": { + "ssoProviders": { "properties": { "links": { "type": "object", @@ -47930,28 +68044,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "example": "520b66891556bf9309da72937c4f1f98" + } + } + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } } } } }, "type": "object" }, - "salesChannel": { + "quoteLineItems": { "properties": { "links": { "type": "object", @@ -47959,21 +68106,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } + } + } + } + }, + "type": "object" + }, + "spatialObjects": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + } } } } @@ -47982,183 +68162,73 @@ } }, "type": "object" - } - }, - "type": "object" - } - ] - }, - "NewsletterRecipient": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "email", - "status", - "hash", - "languageId", - "salesChannelId" - ], - "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" - ], - "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": { + "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": { + "description": "Generated thumbnail images in various sizes", + "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", @@ -48166,7 +68236,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByIntegration" + "example": "/media/3b563524fdb17b4a86590470d40bef74/user" } } }, @@ -48175,19 +68245,19 @@ "properties": { "type": { "type": "string", - "example": "integration" + "example": "user" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "4698501400b26be8a41def09646e1b59" + "example": "ee11cbb19052e40b07aac0ca060c23ee" } } } }, "type": "object" }, - "createdByUser": { + "categories": { "properties": { "links": { "type": "object", @@ -48195,149 +68265,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/notification/96d008db67fc0b5551a926842bbb6a71/createdByUser" + "example": "/media/3b563524fdb17b4a86590470d40bef74/categories" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8a66af2fd5b68899934d19e078c9c111" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "category" + }, + "id": { + "type": "string", + "example": "b0b5ccb4a195a07fd3eed14affb8695f" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Notification": { - "description": "Added since version: 6.4.7.0", - "required": [ - "id", - "status", - "message" - ], - "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", - "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": { + }, + "productManufacturers": { "properties": { "links": { "type": "object", @@ -48345,28 +68296,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productManufacturers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_type" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "599dcce2998a6b40b1e38e8c6006cb0a" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_manufacturer" + }, + "id": { + "type": "string", + "example": "30e3a0f8868364c06aa4be63426c1c79" + } } } } }, "type": "object" }, - "numberRangeSalesChannels": { + "productMedia": { "properties": { "links": { "type": "object", @@ -48374,7 +68327,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productMedia" } } }, @@ -48385,11 +68338,11 @@ "properties": { "type": { "type": "string", - "example": "number_range_sales_channel" + "example": "product_media" }, "id": { "type": "string", - "example": "62db021f1d56ae4688775365be68a04f" + "example": "2b5e079404830806ea36b6c17438cffd" } } } @@ -48397,7 +68350,7 @@ }, "type": "object" }, - "state": { + "productDownloads": { "properties": { "links": { "type": "object", @@ -48405,143 +68358,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" + "example": "/media/3b563524fdb17b4a86590470d40bef74/productDownloads" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_download" + }, + "id": { + "type": "string", + "example": "86db490c1f4f52d155dbdb978b1f45d3" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "NumberRange": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "typeId", - "global", - "pattern", - "start", - "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" - ], - "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": { + }, + "orderLineItemDownloads": { "properties": { "links": { "type": "object", @@ -48549,28 +68389,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" + "example": "/media/3b563524fdb17b4a86590470d40bef74/orderLineItemDownloads" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_line_item_download" + }, + "id": { + "type": "string", + "example": "8c0a5ecd281c97a912c27c0237b3848f" + } } } } }, "type": "object" }, - "salesChannel": { + "avatarUsers": { "properties": { "links": { "type": "object", @@ -48578,28 +68420,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" + "example": "/media/3b563524fdb17b4a86590470d40bef74/avatarUsers" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "example": "1fc09529f6c95370eb20b81318ff601f" + } } } } }, "type": "object" }, - "numberRangeType": { + "mediaFolder": { "properties": { "links": { "type": "object", @@ -48607,7 +68451,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaFolder" } } }, @@ -48616,110 +68460,50 @@ "properties": { "type": { "type": "string", - "example": "number_range_type" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "3d771a402fc5aa3349c2c15637058e8c" + "example": "70605921a592ee735964394f7948773b" } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "NumberRangeSalesChannel": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "numberRangeId", - "salesChannelId" - ], - "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" - ], - "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": { + }, + "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", @@ -48727,116 +68511,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" + "example": "/media/3b563524fdb17b4a86590470d40bef74/mailTemplateMedia" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "number_range" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "0345281f3553d43436c3f0cb4796f3c9" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "mail_template_media" + }, + "id": { + "type": "string", + "example": "9970132c8439a2e630b655812b031459" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "NumberRangeState": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "numberRangeId", - "lastValue" - ], - "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", - "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": { + }, + "documentBaseConfigs": { "properties": { "links": { "type": "object", @@ -48844,7 +68542,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRanges" + "example": "/media/3b563524fdb17b4a86590470d40bef74/documentBaseConfigs" } } }, @@ -48855,11 +68553,11 @@ "properties": { "type": { "type": "string", - "example": "number_range" + "example": "document_base_config" }, "id": { "type": "string", - "example": "d28d88efea70a67487116019cff39002" + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" } } } @@ -48867,7 +68565,7 @@ }, "type": "object" }, - "numberRangeSalesChannels": { + "shippingMethods": { "properties": { "links": { "type": "object", @@ -48875,7 +68573,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" + "example": "/media/3b563524fdb17b4a86590470d40bef74/shippingMethods" } } }, @@ -48886,355 +68584,81 @@ "properties": { "type": { "type": "string", - "example": "number_range_sales_channel" + "example": "shipping_method" }, "id": { "type": "string", - "example": "62db021f1d56ae4688775365be68a04f" + "example": "8268b0a6c902fbde485094c2f627b854" } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "NumberRangeType": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "global", - "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" - ], - "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": { + "paymentMethods": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/paymentMethods" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "example": "b631b1ab565525e892f9cdc1242cca14" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "productConfiguratorSettings": { "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 - }, - "extensions": { - "properties": { - "subscription": { + "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", @@ -49242,28 +68666,61 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" + "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": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + "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" }, - "delayActions": { + "cmsSections": { "properties": { "links": { "type": "object", @@ -49271,7 +68728,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsSections" } } }, @@ -49282,11 +68739,11 @@ "properties": { "type": { "type": "string", - "example": "swag_delay_action" + "example": "cms_section" }, "id": { "type": "string", - "example": "edfed55799054673006c4b5a643489ac" + "example": "53be3cc1c4a8f41af67a90cf9fd09194" } } } @@ -49294,7 +68751,7 @@ }, "type": "object" }, - "warehouseGroups": { + "cmsPages": { "properties": { "links": { "type": "object", @@ -49302,7 +68759,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" + "example": "/media/3b563524fdb17b4a86590470d40bef74/cmsPages" } } }, @@ -49313,11 +68770,11 @@ "properties": { "type": { "type": "string", - "example": "order_warehouse_group" + "example": "cms_page" }, "id": { "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + "example": "e676148cc6ffb82b89b3903ecaed2d16" } } } @@ -49325,7 +68782,7 @@ }, "type": "object" }, - "warehouseProducts": { + "documents": { "properties": { "links": { "type": "object", @@ -49333,7 +68790,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" + "example": "/media/3b563524fdb17b4a86590470d40bef74/documents" } } }, @@ -49344,11 +68801,11 @@ "properties": { "type": { "type": "string", - "example": "order_product_warehouse" + "example": "document" }, "id": { "type": "string", - "example": "702258c6879958a41dfc328ad5c00325" + "example": "21f64da1e5792c8295b964d159a14491" } } } @@ -49356,7 +68813,7 @@ }, "type": "object" }, - "returns": { + "a11yDocuments": { "properties": { "links": { "type": "object", @@ -49364,7 +68821,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" } } }, @@ -49375,11 +68832,11 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "document" }, "id": { "type": "string", - "example": "7fff84525c6516919851a9005373f87e" + "example": "f6c460e0d75110fa1ec7529fe364dbb5" } } } @@ -49387,7 +68844,7 @@ }, "type": "object" }, - "orderEmployee": { + "appPaymentMethods": { "properties": { "links": { "type": "object", @@ -49395,7 +68852,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + "example": "/media/3b563524fdb17b4a86590470d40bef74/appPaymentMethods" } } }, @@ -49406,11 +68863,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_order_employee" + "example": "app_payment_method" }, "id": { "type": "string", - "example": "5ea451c08a87db806089c4031601c29a" + "example": "e53c737d351047e64a02b7a2a4caffe3" } } } @@ -49418,7 +68875,7 @@ }, "type": "object" }, - "b2bPendingOrder": { + "appShippingMethods": { "properties": { "links": { "type": "object", @@ -49426,7 +68883,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + "example": "/media/3b563524fdb17b4a86590470d40bef74/appShippingMethods" } } }, @@ -49437,11 +68894,11 @@ "properties": { "type": { "type": "string", - "example": "b2b_components_pending_order" + "example": "app_shipping_method" }, "id": { "type": "string", - "example": "c7e0572188e2dec59215e8872024567e" + "example": "1ad05ee47064647ee5b2dc8c12b1041c" } } } @@ -49451,39 +68908,519 @@ } }, "type": "object" + } + }, + "type": "object" + } + ] + }, + "Media": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "description": "Unique identity of the user", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaFolderId": { + "description": "Unique identity of the media folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", + "type": "string" + }, + "fileExtension": { + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" + }, + "uploadedAt": { + "description": "Date and time at which media was added.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "fileName": { + "description": "Name of the media file uploaded.", + "type": "string" + }, + "fileSize": { + "description": "Size of the file media file uploaded.", + "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": { + "description": "When `true`, the media display is kept private.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "fileHash": { + "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": "/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" + }, + "mediaAiTag": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/mediaAiTag" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_ai_tag" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "3c88197809d464216a8c40a8db191b38" + } + } + } + }, + "type": "object" + }, + "ssoProviders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/ssoProviders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sso_provider" + }, + "id": { + "type": "string", + "example": "520b66891556bf9309da72937c4f1f98" + } + } + } + } + }, + "type": "object" + }, + "quoteDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_document" + }, + "id": { + "type": "string", + "example": "5f9aa016c99bbfdc16be8c44d885e7e4" + } + } + } + } + }, + "type": "object" + }, + "quoteLineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/quoteLineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_line_item" + }, + "id": { + "type": "string", + "example": "6b1c17ad551ef636e491ab6848f68420" + } + } + } + } + }, + "type": "object" + }, + "spatialObjects": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/spatialObjects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "ad6bd8458100c1c7b8a7d1478a4ba188" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } + }, + "thumbnails": { + "description": "Generated thumbnail images in various sizes", + "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" + } + }, + "a11yDocuments": { + "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" + }, + "MediaAiTagJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "needsAnalysis": { + "type": "boolean", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int64" + }, + "tags": { + "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": { - "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": { + "media": { "properties": { "links": { "type": "object", @@ -49491,7 +69428,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" + "example": "/media-ai-tag/569e3d7be3a3ea0397be0e81cac3235d/media" } } }, @@ -49500,19 +69437,110 @@ "properties": { "type": { "type": "string", - "example": "order_customer" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e90c9c228c1510f5a25902f7a1e8426a" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" - }, - "currency": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaAiTag": { + "required": [ + "id", + "mediaId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "needsAnalysis": { + "type": "boolean", + "readOnly": true + }, + "errorCode": { + "type": "integer", + "format": "int64" + }, + "tags": { + "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" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, + "MediaDefaultFolderJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entity" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular 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", @@ -49520,7 +69548,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/currency" + "example": "/media-default-folder/8a4b9e9331eadf522da72638577cd527/folder" } } }, @@ -49529,19 +69557,126 @@ "properties": { "type": { "type": "string", - "example": "currency" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1af0389838508d7016a9841eb6273962" + "example": "851148b4fd8fd7ae74bd9100c5c0c898" } } } }, "type": "object" - }, - "language": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaDefaultFolder": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "entity" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular 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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", + "type": "boolean" + }, + "configurationId": { + "description": "Unique identity of configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultFolderId": { + "description": "Unique identity of default folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the media folder.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of media folder.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -49549,7 +69684,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/language" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/parent" } } }, @@ -49558,19 +69693,19 @@ "properties": { "type": { "type": "string", - "example": "language" + "example": "media_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" + "example": "d0e45878043844ffc41aac437e86b602" } } } }, "type": "object" }, - "salesChannel": { + "children": { "properties": { "links": { "type": "object", @@ -49578,28 +69713,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/salesChannel" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/children" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_folder" + }, + "id": { + "type": "string", + "example": "268184c12df027f536154d099d497b31" + } } } } }, "type": "object" }, - "addresses": { + "media": { "properties": { "links": { "type": "object", @@ -49607,7 +69744,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/media" } } }, @@ -49618,11 +69755,11 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "media" }, "id": { "type": "string", - "example": "963e3a2fe559e393bad631f3dc686f69" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -49630,7 +69767,7 @@ }, "type": "object" }, - "billingAddress": { + "defaultFolder": { "properties": { "links": { "type": "object", @@ -49638,7 +69775,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/billingAddress" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/defaultFolder" } } }, @@ -49647,19 +69784,19 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "media_default_folder" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7fee8ff88b768662dd8fc06e1b6997d2" + "example": "251dcc9b1621d34e6b01ee14c26b3027" } } } }, "type": "object" }, - "deliveries": { + "configuration": { "properties": { "links": { "type": "object", @@ -49667,92 +69804,168 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" + "example": "/media-folder/8e24b126f2d2bd4373ca2681b47a405d/configuration" } } }, "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": { "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": { + "example": "media_folder_configuration" + }, + "id": { "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" - } + "pattern": "^[0-9a-f]{32}$", + "example": "ccd1066343c95877b75b79d47c36bebe" } } } }, "type": "object" - }, - "documents": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaFolder": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "configurationId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", + "type": "boolean" + }, + "configurationId": { + "description": "Unique identity of configuration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultFolderId": { + "description": "Unique identity of default folder.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the media folder.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of media folder.", + "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", + "description": "Unique identity of media folder." + }, + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", + "type": "boolean" + }, + "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", + "type": "boolean" + }, + "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", + "type": "integer", + "format": "int64" + }, + "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", + "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", @@ -49760,7 +69973,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/documents" + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaFolders" } } }, @@ -49771,11 +69984,11 @@ "properties": { "type": { "type": "string", - "example": "document" + "example": "media_folder" }, "id": { "type": "string", - "example": "21f64da1e5792c8295b964d159a14491" + "example": "6e8238687513bde2e85821c839c597c6" } } } @@ -49783,7 +69996,7 @@ }, "type": "object" }, - "tags": { + "mediaThumbnailSizes": { "properties": { "links": { "type": "object", @@ -49791,7 +70004,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" + "example": "/media-folder-configuration/97dfbba6a3d961140a22cc5473030850/mediaThumbnailSizes" } } }, @@ -49802,19 +70015,202 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "media_thumbnail_size" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "44dee48a0006e8db2fcec2a5e1456449" } } } } }, "type": "object" - }, - "createdBy": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MediaFolderConfiguration": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", + "type": "boolean" + }, + "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", + "type": "boolean" + }, + "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", + "type": "integer", + "format": "int64" + }, + "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "url": { + "description": "Public url of media thumbnail. 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", @@ -49822,7 +70218,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/createdBy" + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/media" } } }, @@ -49831,19 +70227,19 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "media" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "updatedBy": { + "mediaThumbnailSize": { "properties": { "links": { "type": "object", @@ -49851,7 +70247,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/updatedBy" + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" } } }, @@ -49860,12 +70256,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "media_thumbnail_size" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "0d0b8659a3a47e9d7e1481961f127fd0" } } } @@ -49880,263 +70276,48 @@ } ] }, - "Order": { + "MediaThumbnail": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "billingAddressId", - "currencyId", - "languageId", - "salesChannelId", - "orderDateTime", - "currencyFactor", - "stateId", - "itemRounding", - "totalRounding" + "mediaId", + "width", + "height" ], "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": { + "mediaId": { + "description": "Unique identity of media.", "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" - } - }, + "mediaThumbnailSizeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "url": { + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "path": { + "type": "string" + }, + "customFields": { "type": "object" }, "createdAt": { @@ -50149,290 +70330,178 @@ "format": "date-time", "readOnly": true }, - "extensions": { + "media": { + "$ref": "#/components/schemas/Media" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" + } + }, + "type": "object" + }, + "MediaThumbnailSizeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "width", + "height" + ], "properties": { - "subscription": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "b48b13e73a6ac2a86dc54425dd24d9ff" - } - } - } - }, - "type": "object" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "delayActions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "swag_delay_action" - }, - "id": { - "type": "string", - "example": "edfed55799054673006c4b5a643489ac" - } - } - } - } - }, - "type": "object" + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" }, - "warehouseGroups": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_warehouse_group" - }, - "id": { - "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" - } - } - } - } - }, - "type": "object" + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64" }, - "warehouseProducts": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_product_warehouse" - }, - "id": { - "type": "string", - "example": "702258c6879958a41dfc328ad5c00325" - } - } - } - } - }, + "customFields": { "type": "object" }, - "returns": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return" - }, - "id": { - "type": "string", - "example": "7fff84525c6516919851a9005373f87e" - } - } - } - } - }, - "type": "object" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "orderEmployee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_order_employee" - }, - "id": { - "type": "string", - "example": "5ea451c08a87db806089c4031601c29a" - } - } - } - } - }, - "type": "object" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "b2bPendingOrder": { + "relationships": { "properties": { - "links": { - "type": "object", + "mediaFolderConfigurations": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + "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" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_pending_order" - }, - "id": { - "type": "string", - "example": "c7e0572188e2dec59215e8872024567e" + "mediaThumbnails": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } + } } } - } + }, + "type": "object" } }, "type": "object" } }, "type": "object" + } + ] + }, + "MediaThumbnailSize": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "width", + "height" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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" - } + "width": { + "description": "Width of the thumbnail.", + "type": "integer", + "format": "int64" }, - "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "height": { + "description": "Height of the thumbnail.", + "type": "integer", + "format": "int64" }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } + "customFields": { + "type": "object" }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "transactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "documents": { + "mediaFolderConfigurations": { "type": "array", "items": { - "$ref": "#/components/schemas/Document" + "$ref": "#/components/schemas/MediaFolderConfiguration" } }, - "tags": { + "mediaThumbnails": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/MediaThumbnail" } - }, - "createdBy": { - "$ref": "#/components/schemas/User" - }, - "updatedBy": { - "$ref": "#/components/schemas/User" } }, "type": "object" }, - "OrderAddressJsonApi": { + "NewsletterRecipientJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -50441,80 +70510,75 @@ { "required": [ "id", - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city" + "email", + "status", + "hash", + "languageId", + "salesChannelId" ], "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}$" + "email": { + "description": "Email of the recipient.", + "type": "string" }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": { + "description": "Title of the recipient's newsletter.", + "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, - "street": { - "type": "string" - }, - "zipcode": { + "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, - "company": { + "street": { + "description": "Street of the recipient.", "type": "string" }, - "department": { + "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, - "title": { + "hash": { + "description": "Password hash for account recovery.", "type": "string" }, - "vatId": { - "type": "string" + "customFields": { + "type": "object" }, - "phoneNumber": { - "type": "string" + "confirmedAt": { + "description": "Date and time when the Newsletter was received.", + "type": "string", + "format": "date-time" }, - "additionalAddressLine1": { - "type": "string" + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "additionalAddressLine2": { - "type": "string" + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -50528,7 +70592,7 @@ }, "relationships": { "properties": { - "country": { + "tags": { "properties": { "links": { "type": "object", @@ -50536,28 +70600,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/tags" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "country" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "e909c2d7067ea37437cf97fe11d91bd0" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } } } } }, "type": "object" }, - "countryState": { + "salutation": { "properties": { "links": { "type": "object", @@ -50565,7 +70631,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salutation" } } }, @@ -50574,19 +70640,19 @@ "properties": { "type": { "type": "string", - "example": "country_state" + "example": "salutation" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "cb6a9764567191fb74fe28d8d6a4819d" + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } }, "type": "object" }, - "order": { + "language": { "properties": { "links": { "type": "object", @@ -50594,7 +70660,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/order" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/language" } } }, @@ -50603,50 +70669,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "language" }, "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" - } + "example": "8512ae7d57b1396273f76fe6ed341a23" } } } }, "type": "object" }, - "salutation": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -50654,7 +70689,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/salutation" + "example": "/newsletter-recipient/65cb0ac7d520ba60552fa3304e8a28c7/salesChannel" } } }, @@ -50663,12 +70698,12 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } @@ -50683,84 +70718,79 @@ } ] }, - "OrderAddress": { + "NewsletterRecipient": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "countryId", - "orderId", - "firstName", - "lastName", - "street", - "city" + "email", + "status", + "hash", + "languageId", + "salesChannelId" ], "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}$" + "email": { + "description": "Email of the recipient.", + "type": "string" }, - "salutationId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "title": { + "description": "Title of the recipient's newsletter.", + "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, - "street": { - "type": "string" - }, - "zipcode": { + "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, - "company": { + "street": { + "description": "Street of the recipient.", "type": "string" }, - "department": { + "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, - "title": { + "hash": { + "description": "Password hash for account recovery.", "type": "string" }, - "vatId": { - "type": "string" + "customFields": { + "type": "object" }, - "phoneNumber": { - "type": "string" + "confirmedAt": { + "description": "Date and time when the Newsletter was received.", + "type": "string", + "format": "date-time" }, - "additionalAddressLine1": { - "type": "string" + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "additionalAddressLine2": { - "type": "string" + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -50772,29 +70802,54 @@ "format": "date-time", "readOnly": true }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "countryState": { - "$ref": "#/components/schemas/CountryState" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "orderDeliveries": { + "tags": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDelivery" + "$ref": "#/components/schemas/Tag" } }, "salutation": { "$ref": "#/components/schemas/Salutation" + }, + "language": { + "$ref": "#/components/schemas/Language" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" } }, "type": "object" }, - "OrderCustomerJsonApi": { + "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" @@ -50802,66 +70857,228 @@ { "required": [ "id", - "orderId", - "email", - "firstName", - "lastName" + "status", + "message" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "status": { + "description": "When status is set, the Notification is made visible.", + "type": "string" + }, + "message": { + "description": "Indicates text or content of a notification message.", + "type": "string" + }, + "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" + }, + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "customerId": { + "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "orderVersionId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "email": { - "type": "string" + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "status": { + "description": "When status is set, the Notification is made visible.", + "type": "string" + }, + "message": { + "description": "Indicates text or content of a notification message.", + "type": "string" + }, + "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", + "type": "boolean" + }, + "requiredPrivileges": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + } + }, + "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdByUserId": { + "description": "Unique identity of createdByUser.", + "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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "salutationId": { + "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", + "type": "boolean" }, - "lastName": { + "name": { "type": "string" }, - "company": { + "description": { "type": "string" }, - "title": { + "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customerNumber": { - "type": "string" + "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" }, - "remoteAddress": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -50872,9 +71089,12 @@ "format": "date-time", "readOnly": true }, + "translated": { + "type": "object" + }, "relationships": { "properties": { - "order": { + "type": { "properties": { "links": { "type": "object", @@ -50882,7 +71102,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/type" } } }, @@ -50891,19 +71111,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "599dcce2998a6b40b1e38e8c6006cb0a" } } } }, "type": "object" }, - "customer": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -50911,28 +71131,30 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/numberRangeSalesChannels" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "91ec1f9324753048c0096d036a694f86" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "number_range_sales_channel" + }, + "id": { + "type": "string", + "example": "62db021f1d56ae4688775365be68a04f" + } } } } }, "type": "object" }, - "salutation": { + "state": { "properties": { "links": { "type": "object", @@ -50940,7 +71162,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" + "example": "/number-range/5f5cfdaae1821fd1390bb63cf30cb1f2/state" } } }, @@ -50949,12 +71171,12 @@ "properties": { "type": { "type": "string", - "example": "salutation" + "example": "number_range_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } @@ -50969,70 +71191,48 @@ } ] }, - "OrderCustomer": { + "NumberRange": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "email", - "firstName", - "lastName" + "typeId", + "global", + "pattern", + "start", + "name" ], "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": { + "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "firstName": { - "type": "string" + "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", + "type": "boolean" }, - "lastName": { + "name": { "type": "string" }, - "company": { + "description": { "type": "string" }, - "title": { + "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, - "vatIds": { - "type": "array", - "items": { - "type": "string" - } - }, - "customerNumber": { - "type": "string" + "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", + "type": "integer", + "format": "int64" }, "customFields": { "type": "object" }, - "remoteAddress": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -51043,141 +71243,56 @@ "format": "date-time", "readOnly": true }, - "order": { - "$ref": "#/components/schemas/Order" + "translated": { + "type": "object" }, - "customer": { - "$ref": "#/components/schemas/Customer" + "type": { + "$ref": "#/components/schemas/NumberRangeType" }, - "salutation": { - "$ref": "#/components/schemas/Salutation" + "numberRangeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRangeSalesChannel" + } + }, + "state": { + "$ref": "#/components/schemas/NumberRangeState" } }, "type": "object" }, - "OrderDeliveryJsonApi": { + "NumberRangeSalesChannelJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" }, - { - "required": [ - "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", - "stateId", - "shippingDateEarliest", - "shippingDateLatest" + { + "required": [ + "id", + "numberRangeId", + "salesChannelId" ], "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": { + "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "shippingMethodId": { + "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "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", @@ -51190,7 +71305,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "numberRange": { "properties": { "links": { "type": "object", @@ -51198,7 +71313,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRange" } } }, @@ -51207,19 +71322,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "0345281f3553d43436c3f0cb4796f3c9" } } } }, "type": "object" }, - "order": { + "salesChannel": { "properties": { "links": { "type": "object", @@ -51227,7 +71342,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/salesChannel" } } }, @@ -51236,19 +71351,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "sales_channel" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "ec3712a84143b57e0db620eaac6e55b8" } } } }, "type": "object" }, - "shippingOrderAddress": { + "numberRangeType": { "properties": { "links": { "type": "object", @@ -51256,7 +71371,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" + "example": "/number-range-sales-channel/3ec3f602bd7f6198b92698a1ed8770ed/numberRangeType" } } }, @@ -51265,19 +71380,114 @@ "properties": { "type": { "type": "string", - "example": "order_address" + "example": "number_range_type" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "39a8592767b8b6a5d6b1dbc47e4058ca" + "example": "3d771a402fc5aa3349c2c15637058e8c" } } } }, "type": "object" - }, - "shippingMethod": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRangeSalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "numberRangeId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "description": "Unique identity of number rage.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of Sales channels.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeTypeId": { + "description": "Unique identity of number rage type.", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "description": "Unique identity of number range.", + "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", @@ -51285,7 +71495,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" + "example": "/number-range-state/152af4426362939471d98054e285f66d/numberRange" } } }, @@ -51294,19 +71504,141 @@ "properties": { "type": { "type": "string", - "example": "shipping_method" + "example": "number_range" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" + "example": "0345281f3553d43436c3f0cb4796f3c9" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "NumberRangeState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "numberRangeId", + "lastValue" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "numberRangeId": { + "description": "Unique identity of number range.", + "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", + "typeName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "description": "Name of the number range type.", + "type": "string" + }, + "typeName": { + "type": "string" + }, + "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "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" }, - "positions": { + "numberRangeSalesChannels": { "properties": { "links": { "type": "object", @@ -51314,7 +71646,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" + "example": "/number-range-type/1c05c24712e2a7f0a609a9f728a41a33/numberRangeSalesChannels" } } }, @@ -51325,11 +71657,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "number_range_sales_channel" }, "id": { "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" + "example": "62db021f1d56ae4688775365be68a04f" } } } @@ -51345,120 +71677,28 @@ } ] }, - "OrderDelivery": { + "NumberRangeType": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "shippingOrderAddressId", - "shippingMethodId", - "stateId", - "shippingDateEarliest", - "shippingDateLatest" + "global", + "typeName" ], "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" + "technicalName": { + "description": "Name of the number range type.", + "type": "string" }, - "shippingDateLatest": { - "type": "string", - "format": "date-time" + "typeName": { + "type": "string" }, - "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" + "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", + "type": "boolean" }, "customFields": { "type": "object" @@ -51473,28 +71713,25 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "order": { - "$ref": "#/components/schemas/Order" - }, - "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" + "translated": { + "type": "object" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "numberRanges": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NumberRange" + } }, - "positions": { + "numberRangeSalesChannels": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/NumberRangeSalesChannel" } } }, "type": "object" }, - "OrderDeliveryPositionJsonApi": { + "OrderJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -51503,35 +71740,145 @@ { "required": [ "id", - "orderDeliveryId", - "orderLineItemId" + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "versionId": { + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "description": "Unique number associated with every order.", + "type": "string" + }, + "billingAddressId": { + "description": "Unique identity of the billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryId": { + "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderDeliveryVersionId": { + "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "currencyId": { + "description": "Unique identity of the currency.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderDateTime": { + "description": "Timestamp when the order was placed.", + "type": "string", + "format": "date-time" + }, + "orderDate": { + "description": "Date when the order was placed.", + "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": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", + "readOnly": true + }, + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", + "readOnly": true + }, + "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", + "type": "number", + "format": "float", + "readOnly": true + }, + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "type": "string", + "readOnly": true + }, + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -51588,21 +71935,109 @@ }, "type": "object" }, - "unitPrice": { + "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", - "format": "float" + "format": "float", + "readOnly": true }, - "totalPrice": { + "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, - "quantity": { - "type": "integer", - "format": "int64" + "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { + "type": "string" + }, + "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { + "type": "string" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleIds": { + "type": "array", + "items": { + "type": "string" + } }, "customFields": { "type": "object" }, + "createdById": { + "description": "Unique identity of createdBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "description": "Unique identity of updatedBy.", + "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", @@ -51613,9 +72048,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "orderDelivery": { + "subscription": { "properties": { "links": { "type": "object", @@ -51623,7 +72058,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" } } }, @@ -51632,19 +72067,19 @@ "properties": { "type": { "type": "string", - "example": "order_delivery" + "example": "subscription" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "473c50bdac32ac0dc66364d121260dce" + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" } } } }, "type": "object" }, - "orderLineItem": { + "initialSubscriptions": { "properties": { "links": { "type": "object", @@ -51652,341 +72087,214 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } + } + } + } + }, + "type": "object" + }, + "delayActions": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } } } } }, "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderDeliveryPosition": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "orderDeliveryId", - "orderLineItemId" - ], - "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", - "states", - "price", - "children" - ], - "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": { + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } + } + }, "type": "object" }, - "taxRules": { + "warehouseProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "702258c6879958a41dfc328ad5c00325" + } + } + } + } + }, "type": "object" }, - "referencePrice": { + "returns": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" + } + } + } + } + }, "type": "object" }, - "listPrice": { + "orderEmployee": { "properties": { - "price": { - "type": "number", - "format": "float" - }, - "discount": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + } + } }, - "percentage": { - "type": "number", - "format": "float" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_order_employee" + }, + "id": { + "type": "string", + "example": "5ea451c08a87db806089c4031601c29a" + } + } + } } }, "type": "object" }, - "regulationPrice": { + "quote": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } } }, "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 - }, - "extensions": { - "properties": { - "returns": { + }, + "b2bPendingOrder": { "properties": { "links": { "type": "object", @@ -51994,7 +72302,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" } } }, @@ -52005,11 +72313,11 @@ "properties": { "type": { "type": "string", - "example": "order_return_line_item" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "7fff84525c6516919851a9005373f87e" + "example": "c7e0572188e2dec59215e8872024567e" } } } @@ -52017,7 +72325,7 @@ }, "type": "object" }, - "state": { + "organization": { "properties": { "links": { "type": "object", @@ -52025,7 +72333,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" } } }, @@ -52034,12 +72342,41 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "b2b_components_organization" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + }, + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" } } } @@ -52051,7 +72388,8 @@ }, "relationships": { "properties": { - "cover": { + "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -52059,7 +72397,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/cover" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/stateMachineState" } } }, @@ -52068,19 +72406,20 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "order": { + "primaryOrderDelivery": { + "description": "Primary delivery information for the order", "properties": { "links": { "type": "object", @@ -52088,7 +72427,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" } } }, @@ -52097,19 +72436,20 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" } } } }, "type": "object" }, - "product": { + "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", "properties": { "links": { "type": "object", @@ -52117,7 +72457,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" } } }, @@ -52126,19 +72466,20 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "bbaa9e50388c524d97853a4fc4476b0e" } } } }, "type": "object" }, - "promotion": { + "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -52146,7 +72487,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/promotion" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderCustomer" } } }, @@ -52155,19 +72496,20 @@ "properties": { "type": { "type": "string", - "example": "promotion" + "example": "order_customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f8dcad058c9c44fdb6ffcb22d2d4c31f" + "example": "e90c9c228c1510f5a25902f7a1e8426a" } } } }, "type": "object" }, - "orderDeliveryPositions": { + "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -52175,7 +72517,96 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" + "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": { + "description": "Language used when placing the order", + "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": { + "description": "All addresses associated with the order (billing and shipping)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/addresses" } } }, @@ -52186,11 +72617,11 @@ "properties": { "type": { "type": "string", - "example": "order_delivery_position" + "example": "order_address" }, "id": { "type": "string", - "example": "76d4619a36f864b08f57415baaa685ec" + "example": "963e3a2fe559e393bad631f3dc686f69" } } } @@ -52198,7 +72629,8 @@ }, "type": "object" }, - "orderTransactionCaptureRefundPositions": { + "billingAddress": { + "description": "Billing address for the order", "properties": { "links": { "type": "object", @@ -52206,7 +72638,37 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderTransactionCaptureRefundPositions" + "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": { + "description": "Delivery information including shipping address and tracking", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/deliveries" } } }, @@ -52217,11 +72679,11 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund_position" + "example": "order_delivery" }, "id": { "type": "string", - "example": "c330b64e5adc1e48e07a78aa79e5b27a" + "example": "6fc31b6b9cd717cc0dcb81152308f8af" } } } @@ -52229,7 +72691,8 @@ }, "type": "object" }, - "downloads": { + "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", @@ -52237,7 +72700,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/downloads" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/lineItems" } } }, @@ -52248,11 +72711,11 @@ "properties": { "type": { "type": "string", - "example": "order_line_item_download" + "example": "order_line_item" }, "id": { "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" + "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } @@ -52260,7 +72723,8 @@ }, "type": "object" }, - "parent": { + "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -52268,28 +72732,63 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/parent" + "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": { + "description": "Generated documents (invoices, delivery notes, credit notes)", + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "order_line_item" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "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" }, - "children": { + "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -52297,7 +72796,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/children" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/tags" } } }, @@ -52308,17 +72807,75 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "tag" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "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" @@ -52328,17 +72885,19 @@ } ] }, - "OrderLineItem": { + "Order": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderId", - "identifier", - "quantity", - "label", - "states", - "price", - "children" + "billingAddressId", + "currencyId", + "languageId", + "salesChannelId", + "orderDateTime", + "currencyFactor", + "stateId", + "itemRounding", + "totalRounding" ], "properties": { "id": { @@ -52349,74 +72908,126 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderNumber": { + "description": "Unique number associated with every order.", + "type": "string" + }, + "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "billingAddressVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "primaryOrderDeliveryId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { + "primaryOrderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "promotionId": { + "primaryOrderTransactionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentId": { + "primaryOrderTransactionVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "parentVersionId": { + "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "coverId": { + "languageId": { + "description": "Unique identity of the language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "identifier": { - "type": "string" - }, - "referencedId": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int64" + "orderDateTime": { + "description": "Timestamp when the order was placed.", + "type": "string", + "format": "date-time" }, - "label": { - "type": "string" + "orderDate": { + "description": "Date when the order was placed.", + "type": "string", + "readOnly": true }, - "payload": { + "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" }, - "good": { - "type": "boolean" - }, - "removable": { - "type": "boolean" + "amountTotal": { + "description": "Gross price of the order.", + "type": "number", + "format": "float", + "readOnly": true }, - "stackable": { - "type": "boolean" + "amountNet": { + "description": "Net price of the order.", + "type": "number", + "format": "float", + "readOnly": true }, - "position": { - "type": "integer", - "format": "int64" + "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", + "type": "number", + "format": "float", + "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - } + "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", + "type": "string", + "readOnly": true }, - "price": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -52473,26 +73084,109 @@ }, "type": "object" }, - "priceDefinition": { - "type": "object" - }, - "unitPrice": { + "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", - "format": "float" + "format": "float", + "readOnly": true }, - "totalPrice": { + "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, - "description": { + "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, - "type": { + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { + "type": "string" + }, + "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, + "taxCalculationType": { + "type": "string" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "ruleIds": { + "type": "array", + "items": { + "type": "string" + } + }, "customFields": { "type": "object" }, + "createdById": { + "description": "Unique identity of createdBy.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "description": "Unique identity of updatedBy.", + "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", @@ -52505,6 +73199,159 @@ }, "extensions": { "properties": { + "subscription": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/subscription" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b48b13e73a6ac2a86dc54425dd24d9ff" + } + } + } + }, + "type": "object" + }, + "initialSubscriptions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/initialSubscriptions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "subscription" + }, + "id": { + "type": "string", + "example": "3b40c275cdd1f84402bcef5be1651f64" + } + } + } + } + }, + "type": "object" + }, + "delayActions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/delayActions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "swag_delay_action" + }, + "id": { + "type": "string", + "example": "edfed55799054673006c4b5a643489ac" + } + } + } + } + }, + "type": "object" + }, + "warehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseGroups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_warehouse_group" + }, + "id": { + "type": "string", + "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + } + } + } + } + }, + "type": "object" + }, + "warehouseProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/warehouseProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "702258c6879958a41dfc328ad5c00325" + } + } + } + } + }, + "type": "object" + }, "returns": { "properties": { "links": { @@ -52513,7 +73360,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/returns" } } }, @@ -52524,7 +73371,7 @@ "properties": { "type": { "type": "string", - "example": "order_return_line_item" + "example": "order_return" }, "id": { "type": "string", @@ -52536,7 +73383,7 @@ }, "type": "object" }, - "state": { + "orderEmployee": { "properties": { "links": { "type": "object", @@ -52544,7 +73391,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/orderEmployee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_order_employee" + }, + "id": { + "type": "string", + "example": "5ea451c08a87db806089c4031601c29a" + } + } + } + } + }, + "type": "object" + }, + "quote": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/quote" } } }, @@ -52553,12 +73431,101 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "quote" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "example": "7a674c327bfa07f7c1204fb38ca6ef3b" + } + } + } + }, + "type": "object" + }, + "b2bPendingOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/b2bPendingOrder" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "c7e0572188e2dec59215e8872024567e" + } + } + } + } + }, + "type": "object" + }, + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + }, + "budget": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/budget" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_budget" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "2f212049ce79d2b949fd242043004288" } } } @@ -52568,50 +73535,90 @@ }, "type": "object" }, - "cover": { - "$ref": "#/components/schemas/Media" + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" }, - "order": { - "$ref": "#/components/schemas/Order" + "primaryOrderDelivery": { + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" }, - "product": { - "$ref": "#/components/schemas/Product" + "primaryOrderTransaction": { + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" }, - "promotion": { - "$ref": "#/components/schemas/Promotion" + "orderCustomer": { + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, - "orderDeliveryPositions": { + "currency": { + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" + }, + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "type": "array", "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "$ref": "#/components/schemas/OrderAddress" } }, - "orderTransactionCaptureRefundPositions": { + "billingAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" + }, + "deliveries": { + "description": "Delivery information including shipping address and tracking", "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "$ref": "#/components/schemas/OrderDelivery" } }, - "downloads": { + "lineItems": { + "description": "Order line items (products, discounts, fees)", "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" + "$ref": "#/components/schemas/OrderLineItem" } }, - "parent": { - "$ref": "#/components/schemas/OrderLineItem" + "transactions": { + "description": "Payment transactions for the order", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransaction" + } }, - "children": { + "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "type": "array", "items": { - "$ref": "#/components/schemas/OrderLineItem" + "$ref": "#/components/schemas/Document" + } + }, + "tags": { + "description": "Tags assigned to the order for organization and filtering", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" } + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "OrderLineItemDownloadJsonApi": { - "description": "Added since version: 6.4.19.0", + "OrderAddressJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -52619,10 +73626,12 @@ { "required": [ "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { @@ -52633,28 +73642,86 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accessGranted": { - "type": "boolean" + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "street": { + "description": "Street address", + "type": "string" + }, + "zipcode": { + "description": "Zip code of the country.", + "type": "string" + }, + "city": { + "description": "Name of the city.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "department": { + "description": "Name of the department.", + "type": "string" + }, + "title": { + "description": "Title name given to customer like DR. , Prof., etc.", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the customer.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -52667,7 +73734,7 @@ }, "relationships": { "properties": { - "orderLineItem": { + "country": { "properties": { "links": { "type": "object", @@ -52675,7 +73742,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/country" } } }, @@ -52684,19 +73751,19 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "country" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "example": "e909c2d7067ea37437cf97fe11d91bd0" } } } }, "type": "object" }, - "media": { + "countryState": { "properties": { "links": { "type": "object", @@ -52704,7 +73771,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" + "example": "/order-address/4751eee0d88e6475a9a766bb7a37ae43/countryState" } } }, @@ -52713,12 +73780,101 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "country_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "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" } } } @@ -52733,14 +73889,16 @@ } ] }, - "OrderLineItemDownload": { - "description": "Added since version: 6.4.19.0", + "OrderAddress": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderLineItemId", - "mediaId", - "position", - "accessGranted" + "countryId", + "orderId", + "firstName", + "lastName", + "street", + "city" ], "properties": { "id": { @@ -52751,28 +73909,86 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemId": { + "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "position": { - "type": "integer", - "format": "int64" + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "accessGranted": { - "type": "boolean" + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "street": { + "description": "Street address", + "type": "string" + }, + "zipcode": { + "description": "Zip code of the country.", + "type": "string" + }, + "city": { + "description": "Name of the city.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "department": { + "description": "Name of the department.", + "type": "string" + }, + "title": { + "description": "Title name given to customer like DR. , Prof., etc.", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of the customer.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional address input if necessary.", + "type": "string" + }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" }, "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -52783,16 +73999,29 @@ "format": "date-time", "readOnly": true }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" + "country": { + "$ref": "#/components/schemas/Country" }, - "media": { - "$ref": "#/components/schemas/Media" + "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" }, - "OrderProductWarehouseJsonApi": { + "OrderCustomerJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -52801,8 +74030,9 @@ "required": [ "id", "orderId", - "productId", - "warehouseId" + "email", + "firstName", + "lastName" ], "properties": { "id": { @@ -52813,29 +74043,61 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "email": { + "description": "Email address of the customer.", + "type": "string" }, - "warehouseId": { + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "integer", - "format": "int64" + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "title": { + "description": "Title name given to the customer like Dr, prof. etc.", + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, "createdAt": { "type": "string", @@ -52857,7 +74119,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/order" } } }, @@ -52878,7 +74140,7 @@ }, "type": "object" }, - "product": { + "customer": { "properties": { "links": { "type": "object", @@ -52886,7 +74148,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/customer" } } }, @@ -52895,19 +74157,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "customer" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "f5bf48aa40cad7891eb709fcf1fde128" + "example": "91ec1f9324753048c0096d036a694f86" } } } }, "type": "object" }, - "warehouses": { + "salutation": { "properties": { "links": { "type": "object", @@ -52915,23 +74177,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouses" + "example": "/order-customer/b7d3ba78e0695759b84a7f20a6f0c907/salutation" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } @@ -52946,12 +74206,14 @@ } ] }, - "OrderProductWarehouse": { + "OrderCustomer": { + "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", - "productId", - "warehouseId" + "email", + "firstName", + "lastName" ], "properties": { "id": { @@ -52962,29 +74224,61 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderId": { + "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderVersionId": { + "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "email": { + "description": "Email address of the customer.", + "type": "string" }, - "warehouseId": { + "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "quantity": { - "type": "integer", - "format": "int64" + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "company": { + "description": "Name of the company.", + "type": "string" + }, + "title": { + "description": "Title name given to the customer like Dr, prof. etc.", + "type": "string" + }, + "vatIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "customerNumber": { + "description": "Unique number assigned to the customer.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" }, "createdAt": { "type": "string", @@ -52999,19 +74293,17 @@ "order": { "$ref": "#/components/schemas/Order" }, - "product": { - "$ref": "#/components/schemas/Product" + "customer": { + "$ref": "#/components/schemas/Customer" }, - "warehouses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Warehouse" - } + "salutation": { + "$ref": "#/components/schemas/Salutation" } }, "type": "object" }, - "OrderReturnJsonApi": { + "OrderDeliveryJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -53020,9 +74312,11 @@ "required": [ "id", "orderId", + "shippingOrderAddressId", + "shippingMethodId", "stateId", - "returnNumber", - "requestedAt" + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -53034,6 +74328,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53041,42 +74336,40 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "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" + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", + "type": "string", + "format": "date-time" }, "shippingCosts": { "required": [ @@ -53122,48 +74415,21 @@ } }, "type": "object" - }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "returnNumber": { - "type": "string" - }, - "requestedAt": { - "type": "string", - "format": "date-time" - }, - "amountTotal": { - "type": "number", - "format": "float" - }, - "amountNet": { - "type": "number", - "format": "float" - }, - "internalComment": { - "type": "string" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -53177,7 +74443,8 @@ }, "relationships": { "properties": { - "order": { + "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -53185,7 +74452,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/stateMachineState" } } }, @@ -53194,19 +74461,19 @@ "properties": { "type": { "type": "string", - "example": "order" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "state": { + "order": { "properties": { "links": { "type": "object", @@ -53214,7 +74481,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/order" } } }, @@ -53223,19 +74490,20 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "createdBy": { + "shippingOrderAddress": { + "description": "Shipping address for this delivery", "properties": { "links": { "type": "object", @@ -53243,7 +74511,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/createdBy" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingOrderAddress" } } }, @@ -53252,19 +74520,20 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "order_address" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" + "example": "39a8592767b8b6a5d6b1dbc47e4058ca" } } } }, "type": "object" }, - "updatedBy": { + "shippingMethod": { + "description": "Shipping method used for this delivery", "properties": { "links": { "type": "object", @@ -53272,7 +74541,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/updatedBy" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/shippingMethod" } } }, @@ -53281,19 +74550,20 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "shipping_method" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7ced3d0067ad61702af7db8ae260aa76" + "example": "e97bfcdc0cae44bc9e4ab35762eaf0e1" } } } }, "type": "object" }, - "lineItems": { + "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -53301,7 +74571,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/lineItems" + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/positions" } } }, @@ -53312,17 +74582,46 @@ "properties": { "type": { "type": "string", - "example": "order_return_line_item" + "example": "order_delivery_position" }, "id": { "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" + "example": "365a4a972db646c76d115b3897f2d4de" } } } } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -53332,13 +74631,16 @@ } ] }, - "OrderReturn": { + "OrderDelivery": { + "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", + "shippingOrderAddressId", + "shippingMethodId", "stateId", - "returnNumber", - "requestedAt" + "shippingDateEarliest", + "shippingDateLatest" ], "properties": { "id": { @@ -53350,6 +74652,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53357,42 +74660,40 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "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" + "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingOrderAddressVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "description": "Unique identity of shipping method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "trackingCodes": { + "type": "array", + "items": { + "type": "string" + } + }, + "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", + "type": "string", + "format": "date-time" + }, + "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", + "type": "string", + "format": "date-time" }, "shippingCosts": { "required": [ @@ -53451,35 +74752,8 @@ }, "type": "object" }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "returnNumber": { - "type": "string" - }, - "requestedAt": { - "type": "string", - "format": "date-time" - }, - "amountTotal": { - "type": "number", - "format": "float" - }, - "amountNet": { - "type": "number", - "format": "float" - }, - "internalComment": { - "type": "string" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "customFields": { + "type": "object" }, "createdAt": { "type": "string", @@ -53491,28 +74765,36 @@ "format": "date-time", "readOnly": true }, + "stateMachineState": { + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" + }, "order": { "$ref": "#/components/schemas/Order" }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - }, - "createdBy": { - "$ref": "#/components/schemas/User" + "shippingOrderAddress": { + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, - "updatedBy": { - "$ref": "#/components/schemas/User" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, - "lineItems": { + "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderDeliveryPosition" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" }, - "OrderReturnLineItemJsonApi": { + "OrderDeliveryPositionJsonApi": { + "description": "Added since version: 6.0.0.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -53520,12 +74802,8 @@ { "required": [ "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "price", - "stateId" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { @@ -53536,15 +74814,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnId": { + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnVersionId": { + "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53552,14 +74832,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "price": { "required": [ "unitPrice", @@ -53617,24 +74889,24 @@ }, "type": "object" }, - "refundAmount": { + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, - "restockQuantity": { + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" + }, + "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, - "internalComment": { - "type": "string" - }, "customFields": { "type": "object" }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -53647,65 +74919,7 @@ }, "relationships": { "properties": { - "reason": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/reason" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item_reason" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "40bea8d637cdf2c1b07fcf0630482b73" - } - } - } - }, - "type": "object" - }, - "state": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/state" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "state_machine_state" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "9ed39e2ea931586b6a985a6942ef573e" - } - } - } - }, - "type": "object" - }, - "return": { + "orderDelivery": { "properties": { "links": { "type": "object", @@ -53713,7 +74927,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderDelivery" } } }, @@ -53722,19 +74936,19 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "order_delivery" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "e70c4df10ef0983b9c8c31bd06b2a2c3" + "example": "473c50bdac32ac0dc66364d121260dce" } } } }, "type": "object" }, - "lineItem": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -53742,7 +74956,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" + "example": "/order-delivery-position/e09b06c69231a14a01e186482e70f7b7/orderLineItem" } } }, @@ -53756,7 +74970,7 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "867cf1ff92974922abc5d5b045b4a2d8" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } @@ -53771,15 +74985,12 @@ } ] }, - "OrderReturnLineItem": { + "OrderDeliveryPosition": { + "description": "Added since version: 6.0.0.0", "required": [ "id", - "orderReturnId", - "orderLineItemId", - "reasonId", - "quantity", - "price", - "stateId" + "orderDeliveryId", + "orderLineItemId" ], "properties": { "id": { @@ -53790,15 +75001,17 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnId": { + "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderReturnVersionId": { + "orderDeliveryVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53806,14 +75019,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "reasonId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "quantity": { - "type": "integer", - "format": "int64" - }, "price": { "required": [ "unitPrice", @@ -53863,205 +75068,52 @@ "properties": { "price": { "type": "number", - "format": "float" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "refundAmount": { - "type": "number", - "format": "float" - }, - "restockQuantity": { - "type": "integer", - "format": "int64" - }, - "internalComment": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "reason": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" - }, - "state": { - "$ref": "#/components/schemas/StateMachineState" - }, - "return": { - "$ref": "#/components/schemas/OrderReturn" - }, - "lineItem": { - "$ref": "#/components/schemas/OrderLineItem" - } - }, - "type": "object" - }, - "OrderReturnLineItemReasonJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "reasonKey", - "content" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "reasonKey": { - "type": "string" - }, - "content": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "lineItems": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-return-line-item-reason/56b9c90342150f40164af1328340bbac/lineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_return_line_item" - }, - "id": { - "type": "string", - "example": "a042af1aa9f3853fe3cd7dabc065568f" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderReturnLineItemReason": { - "required": [ - "id", - "reasonKey", - "content" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "reasonKey": { - "type": "string" - }, - "content": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "lineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" - } - } - }, - "type": "object" - }, - "OrderTag": { - "description": "Added since version: 6.0.0.0", - "required": [ - "orderId", - "tagId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" }, - "orderVersionId": { + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" + }, + "quantity": { + "description": "Number of items of each product.", + "type": "integer", + "format": "int64" + }, + "customFields": { + "type": "object" + }, + "createdAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "tagId": { + "updatedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time", + "readOnly": true }, - "order": { - "$ref": "#/components/schemas/Order" + "orderDelivery": { + "$ref": "#/components/schemas/OrderDelivery" }, - "tag": { - "$ref": "#/components/schemas/Tag" + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, - "OrderTransactionJsonApi": { + "OrderLineItemJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ { @@ -54071,9 +75123,12 @@ "required": [ "id", "orderId", - "paymentMethodId", - "amount", - "stateId" + "identifier", + "quantity", + "label", + "price", + "children", + "states" ], "properties": { "id": { @@ -54085,6 +75140,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54092,11 +75148,71 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "amount": { + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of cover image.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", + "type": "string" + }, + "referencedId": { + "description": "Unique identity of type of entity.", + "type": "string" + }, + "quantity": { + "description": "Number of items of product.", + "type": "integer", + "format": "int64" + }, + "label": { + "description": "It is a typical product name given to the line item.", + "type": "string" + }, + "payload": { + "type": "object" + }, + "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", + "type": "boolean" + }, + "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", + "type": "boolean" + }, + "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", + "type": "boolean" + }, + "position": { + "description": "Position of line items placed in an order.", + "type": "integer", + "format": "int64" + }, + "price": { "required": [ "unitPrice", "totalPrice", @@ -54153,16 +75269,37 @@ }, "type": "object" }, - "validationData": { + "priceDefinition": { "type": "object" }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" + }, + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" + }, + "description": { + "description": "Description of line items in an order.", + "type": "string" + }, + "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -54173,9 +75310,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "stateMachineState": { + "returns": { "properties": { "links": { "type": "object", @@ -54183,7 +75320,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return_line_item" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" + } + } + } + } + }, + "type": "object" + }, + "state": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" } } }, @@ -54197,7 +75365,42 @@ "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "9ed39e2ea931586b6a985a6942ef573e" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "cover": { + "description": "Line item image or thumbnail", + "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" } } } @@ -54212,7 +75415,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/order" } } }, @@ -54233,7 +75436,8 @@ }, "type": "object" }, - "paymentMethod": { + "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -54241,7 +75445,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/product" } } }, @@ -54250,19 +75454,19 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "68ec1eeea9f1b7744e231b5bd0d97df0" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "captures": { + "promotion": { "properties": { "links": { "type": "object", @@ -54270,7 +75474,37 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" + "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": { + "description": "Delivery positions for this line item", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/orderDeliveryPositions" } } }, @@ -54281,11 +75515,134 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture" + "example": "order_delivery_position" }, "id": { "type": "string", - "example": "8856ffdd044d57cd4124a6be5dcea329" + "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": { + "description": "Digital downloads associated with this line item", + "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" } } } @@ -54301,14 +75658,17 @@ } ] }, - "OrderTransaction": { + "OrderLineItem": { "description": "Added since version: 6.0.0.0", "required": [ "id", "orderId", - "paymentMethodId", - "amount", - "stateId" + "identifier", + "quantity", + "label", + "price", + "children", + "states" ], "properties": { "id": { @@ -54320,6 +75680,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54327,11 +75688,71 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "paymentMethodId": { + "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "amount": { + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "promotionId": { + "description": "Unique identity of product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "coverId": { + "description": "Unique identity of cover image.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", + "type": "string" + }, + "referencedId": { + "description": "Unique identity of type of entity.", + "type": "string" + }, + "quantity": { + "description": "Number of items of product.", + "type": "integer", + "format": "int64" + }, + "label": { + "description": "It is a typical product name given to the line item.", + "type": "string" + }, + "payload": { + "type": "object" + }, + "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", + "type": "boolean" + }, + "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", + "type": "boolean" + }, + "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", + "type": "boolean" + }, + "position": { + "description": "Position of line items placed in an order.", + "type": "integer", + "format": "int64" + }, + "price": { "required": [ "unitPrice", "totalPrice", @@ -54376,11 +75797,117 @@ }, "type": "object" }, - "regulationPrice": { + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "priceDefinition": { + "type": "object" + }, + "unitPrice": { + "description": "Price of product per item (where, quantity=1).", + "type": "number", + "format": "float" + }, + "totalPrice": { + "description": "Cost of product based on quantity.", + "type": "number", + "format": "float" + }, + "description": { + "description": "Description of line items in an order.", + "type": "string" + }, + "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "returns": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/returns" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return_line_item" + }, + "id": { + "type": "string", + "example": "7fff84525c6516919851a9005373f87e" + } + } + } + } + }, + "type": "object" + }, + "state": { "properties": { - "price": { - "type": "number", - "format": "float" + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-line-item/40b401ac0b29ac5c5c8ffce649fdef62/state" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9ed39e2ea931586b6a985a6942ef573e" + } + } } }, "type": "object" @@ -54388,46 +75915,54 @@ }, "type": "object" }, - "validationData": { - "type": "object" + "cover": { + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, - "stateId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "order": { + "$ref": "#/components/schemas/Order" }, - "customFields": { - "type": "object" + "product": { + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "promotion": { + "$ref": "#/components/schemas/Promotion" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "orderDeliveryPositions": { + "description": "Delivery positions for this line item", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderDeliveryPosition" + } }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "orderTransactionCaptureRefundPositions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + } }, - "order": { - "$ref": "#/components/schemas/Order" + "downloads": { + "description": "Digital downloads associated with this line item", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderLineItemDownload" + } }, - "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "parent": { + "$ref": "#/components/schemas/OrderLineItem" }, - "captures": { + "children": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "$ref": "#/components/schemas/OrderLineItem" } } }, "type": "object" }, - "OrderTransactionCaptureJsonApi": { - "description": "Added since version: 6.4.12.0", + "OrderLineItemDownloadJsonApi": { + "description": "Added since version: 6.4.19.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -54435,9 +75970,10 @@ { "required": [ "id", - "orderTransactionId", - "stateId", - "amount" + "orderLineItemId", + "mediaId", + "position", + "accessGranted" ], "properties": { "id": { @@ -54448,77 +75984,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { + "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionVersionId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "type": "string" + "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", + "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" + "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", + "type": "boolean" }, "customFields": { "type": "object" @@ -54535,7 +76022,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "orderLineItem": { "properties": { "links": { "type": "object", @@ -54543,7 +76030,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/orderLineItem" } } }, @@ -54552,19 +76039,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, - "transaction": { + "media": { "properties": { "links": { "type": "object", @@ -54572,7 +76059,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" + "example": "/order-line-item-download/583247f605cf67a4124e4eb17a66094e/media" } } }, @@ -54581,43 +76068,12 @@ "properties": { "type": { "type": "string", - "example": "order_transaction" + "example": "media" }, "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" - } + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } @@ -54632,13 +76088,14 @@ } ] }, - "OrderTransactionCapture": { - "description": "Added since version: 6.4.12.0", + "OrderLineItemDownload": { + "description": "Added since version: 6.4.19.0", "required": [ "id", - "orderTransactionId", - "stateId", - "amount" + "orderLineItemId", + "mediaId", + "position", + "accessGranted" ], "properties": { "id": { @@ -54649,77 +76106,28 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionId": { + "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionVersionId": { + "orderLineItemVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "type": "string" + "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", + "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" + "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", + "type": "boolean" }, "customFields": { "type": "object" @@ -54734,23 +76142,16 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" - }, - "transaction": { - "$ref": "#/components/schemas/OrderTransaction" + "orderLineItem": { + "$ref": "#/components/schemas/OrderLineItem" }, - "refunds": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } + "media": { + "$ref": "#/components/schemas/Media" } }, "type": "object" }, - "OrderTransactionCaptureRefundJsonApi": { - "description": "Added since version: 6.4.12.0", + "OrderProductWarehouseJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -54758,9 +76159,9 @@ { "required": [ "id", - "captureId", - "stateId", - "amount" + "orderId", + "productId", + "warehouseId" ], "properties": { "id": { @@ -54771,83 +76172,29 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "type": "string" - }, - "reason": { - "type": "string" + "productVersionId": { + "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" + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -54861,7 +76208,7 @@ }, "relationships": { "properties": { - "stateMachineState": { + "order": { "properties": { "links": { "type": "object", @@ -54869,7 +76216,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/order" } } }, @@ -54878,19 +76225,19 @@ "properties": { "type": { "type": "string", - "example": "state_machine_state" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "1ab22d393154f21e3be76aca3ec3ee31" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "transactionCapture": { + "product": { "properties": { "links": { "type": "object", @@ -54898,7 +76245,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/product" } } }, @@ -54907,19 +76254,19 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture" + "example": "product" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "56b70ce76ce8e9bfbaf80ea040d456b5" + "example": "f5bf48aa40cad7891eb709fcf1fde128" } } } }, "type": "object" }, - "positions": { + "warehouse": { "properties": { "links": { "type": "object", @@ -54927,23 +76274,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" + "example": "/order-product-warehouse/ef794dc5239b6857296e8e4ee4605a36/warehouse" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_transaction_capture_refund_position" - }, - "id": { - "type": "string", - "example": "365a4a972db646c76d115b3897f2d4de" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "372d30dd2849813ef674855253900679" } } } @@ -54958,13 +76303,12 @@ } ] }, - "OrderTransactionCaptureRefund": { - "description": "Added since version: 6.4.12.0", + "OrderProductWarehouse": { "required": [ "id", - "captureId", - "stateId", - "amount" + "orderId", + "productId", + "warehouseId" ], "properties": { "id": { @@ -54975,83 +76319,29 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "captureVersionId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "stateId": { + "productId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "type": "string" - }, - "reason": { - "type": "string" + "productVersionId": { + "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" + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "customFields": { - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, "createdAt": { "type": "string", @@ -55063,23 +76353,19 @@ "format": "date-time", "readOnly": true }, - "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "order": { + "$ref": "#/components/schemas/Order" }, - "transactionCapture": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "product": { + "$ref": "#/components/schemas/Product" }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" - } + "warehouse": { + "$ref": "#/components/schemas/Warehouse" } }, "type": "object" }, - "OrderTransactionCaptureRefundPositionJsonApi": { - "description": "Added since version: 6.4.12.0", + "OrderReturnJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -55087,9 +76373,10 @@ { "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "orderId", + "stateId", + "returnNumber", + "requestedAt" ], "properties": { "id": { @@ -55100,33 +76387,52 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "refundVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "type": "string" - }, - "reason": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int64" + "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" }, - "amount": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -55183,8 +76489,35 @@ }, "type": "object" }, - "customFields": { - "type": "object" + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "returnNumber": { + "type": "string" + }, + "requestedAt": { + "type": "string", + "format": "date-time" + }, + "amountTotal": { + "type": "number", + "format": "float" + }, + "amountNet": { + "type": "number", + "format": "float" + }, + "internalComment": { + "type": "string" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -55198,7 +76531,7 @@ }, "relationships": { "properties": { - "orderLineItem": { + "order": { "properties": { "links": { "type": "object", @@ -55206,7 +76539,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/order" } } }, @@ -55215,19 +76548,19 @@ "properties": { "type": { "type": "string", - "example": "order_line_item" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "72c0cccf44b384eb8f91e0f7074252f8" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "orderTransactionCaptureRefund": { + "state": { "properties": { "links": { "type": "object", @@ -55235,7 +76568,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/state" } } }, @@ -55244,12 +76577,101 @@ "properties": { "type": { "type": "string", - "example": "order_transaction_capture_refund" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8e55f83da36c39263717541ec1f18de7" + "example": "9ed39e2ea931586b6a985a6942ef573e" + } + } + } + }, + "type": "object" + }, + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/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-return/f69f638340dfe19ae7ae215a7d5a8670/updatedBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7ced3d0067ad61702af7db8ae260aa76" + } + } + } + }, + "type": "object" + }, + "lineItems": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-return/f69f638340dfe19ae7ae215a7d5a8670/lineItems" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return_line_item" + }, + "id": { + "type": "string", + "example": "a042af1aa9f3853fe3cd7dabc065568f" + } } } } @@ -55264,13 +76686,13 @@ } ] }, - "OrderTransactionCaptureRefundPosition": { - "description": "Added since version: 6.4.12.0", + "OrderReturn": { "required": [ "id", - "refundId", - "orderLineItemId", - "amount" + "orderId", + "stateId", + "returnNumber", + "requestedAt" ], "properties": { "id": { @@ -55281,33 +76703,52 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "refundId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "refundVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderLineItemId": { + "orderId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "orderLineItemVersionId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "externalReference": { - "type": "string" - }, - "reason": { - "type": "string" - }, - "quantity": { - "type": "integer", - "format": "int64" + "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" }, - "amount": { + "shippingCosts": { "required": [ "unitPrice", "totalPrice", @@ -55364,162 +76805,33 @@ }, "type": "object" }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { + "stateId": { "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderLineItem": { - "$ref": "#/components/schemas/OrderLineItem" + "pattern": "^[0-9a-f]{32}$" }, - "orderTransactionCaptureRefund": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" - } - }, - "type": "object" - }, - "OrderWarehouseGroupJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "returnNumber": { + "type": "string" }, - { - "required": [ - "id", - "orderId", - "warehouseGroupId" - ], - "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}$" - }, - "warehouseGroupId": { - "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": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/order" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "70a17ffa722a3985b86d30b034ad06d7" - } - } - } - }, - "type": "object" - }, - "warehouseGroup": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/warehouseGroup" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1768e3071b62161d415e0c24332055ed" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "OrderWarehouseGroup": { - "required": [ - "id", - "orderId", - "warehouseGroupId" - ], - "properties": { - "id": { + "requestedAt": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "format": "date-time" }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "amountTotal": { + "type": "number", + "format": "float" }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "amountNet": { + "type": "number", + "format": "float" }, - "orderVersionId": { + "internalComment": { + "type": "string" + }, + "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "warehouseGroupId": { + "updatedById": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55536,14 +76848,25 @@ "order": { "$ref": "#/components/schemas/Order" }, - "warehouseGroup": { - "$ref": "#/components/schemas/WarehouseGroup" + "state": { + "$ref": "#/components/schemas/StateMachineState" + }, + "createdBy": { + "$ref": "#/components/schemas/User" + }, + "updatedBy": { + "$ref": "#/components/schemas/User" + }, + "lineItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderReturnLineItem" + } } }, "type": "object" }, - "PaymentMethodJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderReturnLineItemJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -55551,161 +76874,96 @@ { "required": [ "id", - "name" + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "price", + "stateId" ], "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": { + "versionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "orderReturnId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "formattedHandlerIdentifier": { - "description": "Runtime field, cannot be used as part of the criteria.", + "orderReturnVersionId": { "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" + "pattern": "^[0-9a-f]{32}$" }, - "technicalName": { - "type": "string" + "orderLineItemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderLineItemVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "reasonId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, - "extensions": { + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "subscriptions": { + "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": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "quoteTransactions": { + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_transaction" - }, - "id": { - "type": "string", - "example": "c960fb2e8b7ef26229da52c7f7775e13" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" @@ -55713,9 +76971,37 @@ }, "type": "object" }, + "refundAmount": { + "type": "number", + "format": "float" + }, + "restockQuantity": { + "type": "integer", + "format": "int64" + }, + "internalComment": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "stateId": { + "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": { - "media": { + "reason": { "properties": { "links": { "type": "object", @@ -55723,7 +77009,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/reason" } } }, @@ -55732,19 +77018,19 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "order_return_line_item_reason" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "40bea8d637cdf2c1b07fcf0630482b73" } } } }, "type": "object" }, - "availabilityRule": { + "state": { "properties": { "links": { "type": "object", @@ -55752,7 +77038,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/state" } } }, @@ -55761,50 +77047,19 @@ "properties": { "type": { "type": "string", - "example": "rule" + "example": "state_machine_state" }, "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" - } + "example": "9ed39e2ea931586b6a985a6942ef573e" } } } }, "type": "object" }, - "plugin": { + "return": { "properties": { "links": { "type": "object", @@ -55812,7 +77067,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/return" } } }, @@ -55821,112 +77076,19 @@ "properties": { "type": { "type": "string", - "example": "plugin" + "example": "order_return" }, "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" - } + "example": "e70c4df10ef0983b9c8c31bd06b2a2c3" } } } }, "type": "object" }, - "appPaymentMethod": { + "lineItem": { "properties": { "links": { "type": "object", @@ -55934,7 +77096,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" + "example": "/order-return-line-item/82c86fa96448e66da162746de632d95f/lineItem" } } }, @@ -55943,12 +77105,12 @@ "properties": { "type": { "type": "string", - "example": "app_payment_method" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" + "example": "867cf1ff92974922abc5d5b045b4a2d8" } } } @@ -55963,165 +77125,99 @@ } ] }, - "PaymentMethod": { - "description": "Added since version: 6.0.0.0", + "OrderReturnLineItem": { "required": [ "id", - "name" + "orderReturnId", + "orderLineItemId", + "reasonId", + "quantity", + "price", + "stateId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "pluginId": { + "versionId": { "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": { + "orderReturnId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "orderReturnVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "formattedHandlerIdentifier": { - "description": "Runtime field, cannot be used as part of the criteria.", + "orderLineItemId": { "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" + "pattern": "^[0-9a-f]{32}$" }, - "createdAt": { + "orderLineItemVersionId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "updatedAt": { + "reasonId": { "type": "string", - "format": "date-time", - "readOnly": true + "pattern": "^[0-9a-f]{32}$" }, - "translated": { - "type": "object" + "quantity": { + "type": "integer", + "format": "int64" }, - "extensions": { + "price": { + "required": [ + "unitPrice", + "totalPrice", + "quantity" + ], "properties": { - "subscriptions": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription" - }, - "id": { - "type": "string", - "example": "2d5d14f95af035cbd8437948de61f94c" - } - } - } - } - }, + "unitPrice": { + "type": "number", + "format": "float" + }, + "totalPrice": { + "type": "number", + "format": "float" + }, + "quantity": { + "type": "integer", + "format": "int64" + }, + "calculatedTaxes": { "type": "object" }, - "quoteTransactions": { + "taxRules": { + "type": "object" + }, + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_transaction" - }, - "id": { - "type": "string", - "example": "c960fb2e8b7ef26229da52c7f7775e13" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" } }, "type": "object" @@ -56129,47 +77225,50 @@ }, "type": "object" }, - "media": { - "$ref": "#/components/schemas/Media" + "refundAmount": { + "type": "number", + "format": "float" }, - "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "restockQuantity": { + "type": "integer", + "format": "int64" }, - "salesChannelDefaultAssignments": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "internalComment": { + "type": "string" }, - "plugin": { - "$ref": "#/components/schemas/Plugin" + "customFields": { + "type": "object" }, - "customers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } + "stateId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderTransactions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "salesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "appPaymentMethod": { - "$ref": "#/components/schemas/AppPaymentMethod" + "reason": { + "$ref": "#/components/schemas/OrderReturnLineItemReason" + }, + "state": { + "$ref": "#/components/schemas/StateMachineState" + }, + "return": { + "$ref": "#/components/schemas/OrderReturn" + }, + "lineItem": { + "$ref": "#/components/schemas/OrderLineItem" } }, "type": "object" }, - "PluginJsonApi": { - "description": "Added since version: 6.0.0.0", + "OrderReturnLineItemReasonJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -56177,81 +77276,19 @@ { "required": [ "id", - "baseClass", - "name", - "autoload", - "version", - "label" + "reasonKey" ], "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": { + "reasonKey": { "type": "string" }, - "supportLink": { + "content": { "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -56267,7 +77304,7 @@ }, "relationships": { "properties": { - "paymentMethods": { + "lineItems": { "properties": { "links": { "type": "object", @@ -56275,7 +77312,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/plugin/409c1892b68cb394799262ac57f6d4f1/paymentMethods" + "example": "/order-return-line-item-reason/56b9c90342150f40164af1328340bbac/lineItems" } } }, @@ -56286,11 +77323,11 @@ "properties": { "type": { "type": "string", - "example": "payment_method" + "example": "order_return_line_item" }, "id": { "type": "string", - "example": "b631b1ab565525e892f9cdc1242cca14" + "example": "a042af1aa9f3853fe3cd7dabc065568f" } } } @@ -56306,85 +77343,22 @@ } ] }, - "Plugin": { - "description": "Added since version: 6.0.0.0", + "OrderReturnLineItemReason": { "required": [ "id", - "baseClass", - "name", - "autoload", - "version", - "label" + "reasonKey" ], "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": { + "reasonKey": { "type": "string" }, - "supportLink": { + "content": { "type": "string" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -56398,16 +77372,48 @@ "translated": { "type": "object" }, - "paymentMethods": { + "lineItems": { "type": "array", "items": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/OrderReturnLineItem" } } }, "type": "object" }, - "ProductJsonApi": { + "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": [ { @@ -56416,11 +77422,10 @@ { "required": [ "id", - "taxId", - "price", - "productNumber", - "stock", - "name" + "orderId", + "paymentMethodId", + "amount", + "stateId" ], "properties": { "id": { @@ -56431,280 +77436,88 @@ "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": { + "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageId": { + "orderVersionId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "cmsPageVersionId": { + "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "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": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "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" + "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" + } }, - "readOnly": true - }, - "metaDescription": { - "type": "string" - }, - "name": { - "type": "string" - }, - "keywords": { - "type": "string" - }, - "description": { - "type": "string" - }, - "metaTitle": { - "type": "string" + "type": "object" }, - "packUnit": { - "type": "string" + "validationData": { + "type": "object" }, - "packUnitPlural": { - "type": "string" + "stateId": { + "description": "Unique identity of state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "customFields": { "type": "object" }, - "slotConfig": { - "type": "object" - }, - "customSearchKeywords": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -56715,12 +77528,10 @@ "format": "date-time", "readOnly": true }, - "translated": { - "type": "object" - }, - "extensions": { + "relationships": { "properties": { - "customPrice": { + "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -56728,61 +77539,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/stateMachineState" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_price" - }, - "id": { - "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" - } - } - } - } - }, - "type": "object" - }, - "subscriptionPlans": { - "properties": { - "links": { "type": "object", "properties": { - "related": { + "type": { "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "subscription_plan" - }, - "id": { - "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" - } + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "warehouseGroups": { + "order": { "properties": { "links": { "type": "object", @@ -56790,30 +77568,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/order" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "warehouses": { + "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -56821,30 +77598,29 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/paymentMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "68ec1eeea9f1b7744e231b5bd0d97df0" } } } }, "type": "object" }, - "orderWarehouses": { + "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -56852,7 +77628,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/captures" } } }, @@ -56863,11 +77639,11 @@ "properties": { "type": { "type": "string", - "example": "order_product_warehouse" + "example": "order_transaction_capture" }, "id": { "type": "string", - "example": "5331369e2f71d048521bd35d80975314" + "example": "8856ffdd044d57cd4124a6be5dcea329" } } } @@ -56875,7 +77651,7 @@ }, "type": "object" }, - "reviewSummaries": { + "primaryOrder": { "properties": { "links": { "type": "object", @@ -56883,90 +77659,259 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransaction": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "orderId", + "paymentMethodId", + "amount", + "stateId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "description": "Unique identity of an order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "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": { + "description": "Unique identity of state.", + "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", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" + }, + "order": { + "$ref": "#/components/schemas/Order" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" + }, + "captures": { + "description": "Payment captures for this transaction", + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderTransactionCapture" + } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" + } + }, + "type": "object" + }, + "OrderTransactionCaptureJsonApi": { + "description": "Added since version: 6.4.12.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionId": { + "description": "Unique identity of order transaction.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "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" }, - "search": { + "taxRules": { "type": "object" }, - "quoteLineItems": { + "referencePrice": { + "type": "object" + }, + "listPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" - } - } + "price": { + "type": "number", + "format": "float" }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" - } - } - } + "discount": { + "type": "number", + "format": "float" + }, + "percentage": { + "type": "number", + "format": "float" } }, "type": "object" }, - "shoppingListLineItems": { + "regulationPrice": { "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list_line_item" - }, - "id": { - "type": "string", - "example": "ce593c6d1db236f22dc387a2ee20dfd6" - } - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" @@ -56974,9 +77919,22 @@ }, "type": "object" }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, "relationships": { "properties": { - "downloads": { + "stateMachineState": { "properties": { "links": { "type": "object", @@ -56984,30 +77942,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/downloads" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/stateMachineState" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_download" - }, - "id": { - "type": "string", - "example": "d07d50a751bc6ddf12bf3af0efee9b45" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_state" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "parent": { + "transaction": { "properties": { "links": { "type": "object", @@ -57015,7 +77971,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/parent" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/transaction" } } }, @@ -57024,19 +77980,19 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_transaction" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "d0e45878043844ffc41aac437e86b602" + "example": "f4d5b76a2418eba4baeabc1ed9142b54" } } } }, "type": "object" }, - "children": { + "refunds": { "properties": { "links": { "type": "object", @@ -57044,7 +78000,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/children" + "example": "/order-transaction-capture/c63c3187538f020dbe3d0c9bd41c5fea/refunds" } } }, @@ -57055,19 +78011,263 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "order_transaction_capture_refund" }, "id": { "type": "string", - "example": "268184c12df027f536154d099d497b31" + "example": "0084ff716402199f733f841f5937d3ae" } } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCapture": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "orderTransactionId", + "stateId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionId": { + "description": "Unique identity of order transaction.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "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" }, - "deliveryTime": { + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureId": { + "description": "Unique identity of order transaction capture.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "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", @@ -57075,7 +78275,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/deliveryTime" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/stateMachineState" } } }, @@ -57084,19 +78284,19 @@ "properties": { "type": { "type": "string", - "example": "delivery_time" + "example": "state_machine_state" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "8c888ae25a7bd42057370e31f7e01044" + "example": "1ab22d393154f21e3be76aca3ec3ee31" } } } }, "type": "object" }, - "tax": { + "transactionCapture": { "properties": { "links": { "type": "object", @@ -57104,7 +78304,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tax" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/transactionCapture" } } }, @@ -57113,19 +78313,19 @@ "properties": { "type": { "type": "string", - "example": "tax" + "example": "order_transaction_capture" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "06565e5611f23fdf8cc43e5077b92b54" + "example": "56b70ce76ce8e9bfbaf80ea040d456b5" } } } }, "type": "object" }, - "manufacturer": { + "positions": { "properties": { "links": { "type": "object", @@ -57133,57 +78333,287 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/manufacturer" + "example": "/order-transaction-capture-refund/3024adb21b1ba17454cf7cc0cfa881d4/positions" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_manufacturer" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "c2904bca62b22443d6cf5e9d89cab204" + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureId": { + "description": "Unique identity of order transaction capture.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "captureVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "stateId": { + "description": "Unique identity of order state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundId": { + "description": "Unique identity of order transaction capture refund.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "description": "Unique identity of order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "quantity": { + "description": "Quantity of line item to be refunded.", + "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" }, - "unit": { + "regulationPrice": { "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" - } - } + "price": { + "type": "number", + "format": "float" } }, "type": "object" - }, - "cover": { + } + }, + "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", @@ -57191,7 +78621,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cover" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderLineItem" } } }, @@ -57200,19 +78630,19 @@ "properties": { "type": { "type": "string", - "example": "product_media" + "example": "order_line_item" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "41d0e299ca1abeb2094852da042165c7" + "example": "72c0cccf44b384eb8f91e0f7074252f8" } } } }, "type": "object" }, - "featureSet": { + "orderTransactionCaptureRefund": { "properties": { "links": { "type": "object", @@ -57220,7 +78650,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/featureSet" + "example": "/order-transaction-capture-refund-position/dc9ea2968815c3064d57d506f542c4c1/orderTransactionCaptureRefund" } } }, @@ -57229,19 +78659,198 @@ "properties": { "type": { "type": "string", - "example": "product_feature_set" + "example": "order_transaction_capture_refund" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "9cef0cd6ce1c52f0d29b23b7e40dbb17" + "example": "8e55f83da36c39263717541ec1f18de7" } } } }, "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderTransactionCaptureRefundPosition": { + "description": "Added since version: 6.4.12.0", + "required": [ + "id", + "refundId", + "orderLineItemId", + "amount" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundId": { + "description": "Unique identity of order transaction capture refund.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "refundVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemId": { + "description": "Unique identity of order line item.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderLineItemVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "externalReference": { + "description": "External payment provider token.", + "type": "string" + }, + "reason": { + "description": "Reason for refunding the amount for an order.", + "type": "string" + }, + "quantity": { + "description": "Quantity of line item to be refunded.", + "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" }, - "cmsPage": { + "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" + }, + "OrderWarehouseGroupJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "orderId", + "warehouseGroupId" + ], + "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}$" + }, + "warehouseGroupId": { + "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", @@ -57249,7 +78858,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/cmsPage" + "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/order" } } }, @@ -57258,19 +78867,19 @@ "properties": { "type": { "type": "string", - "example": "cms_page" + "example": "order" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "7b1460918b1abb93311108f3dc021c9b" + "example": "70a17ffa722a3985b86d30b034ad06d7" } } } }, "type": "object" }, - "canonicalProduct": { + "warehouseGroup": { "properties": { "links": { "type": "object", @@ -57278,7 +78887,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/canonicalProduct" + "example": "/order-warehouse-group/76d096c61d28159fe3efcbceced45044/warehouseGroup" } } }, @@ -57287,143 +78896,162 @@ "properties": { "type": { "type": "string", - "example": "product" + "example": "warehouse_group" }, "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" - } + "example": "1768e3071b62161d415e0c24332055ed" } } } }, "type": "object" - }, - "configuratorSettings": { + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "OrderWarehouseGroup": { + "required": [ + "id", + "orderId", + "warehouseGroupId" + ], + "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}$" + }, + "warehouseGroupId": { + "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" + }, + "warehouseGroup": { + "$ref": "#/components/schemas/WarehouseGroup" + } + }, + "type": "object" + }, + "PaymentMethodJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", + "type": "string" + }, + "name": { + "type": "string" + }, + "distinguishableName": { + "type": "string", + "readOnly": true + }, + "description": { + "type": "string" + }, + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", + "type": "boolean" + }, + "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "availabilityRuleId": { + "description": "Unique identity of rule.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "technicalName": { + "type": "string" + }, + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -57431,7 +79059,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/configuratorSettings" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, @@ -57442,11 +79070,11 @@ "properties": { "type": { "type": "string", - "example": "product_configurator_setting" + "example": "subscription" }, "id": { "type": "string", - "example": "c0827fee13725d41f1fd7e292243f5aa" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -57454,7 +79082,7 @@ }, "type": "object" }, - "visibilities": { + "quoteTransactions": { "properties": { "links": { "type": "object", @@ -57462,7 +79090,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/visibilities" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, @@ -57473,11 +79101,11 @@ "properties": { "type": { "type": "string", - "example": "product_visibility" + "example": "quote_transaction" }, "id": { "type": "string", - "example": "63226fcdfe3316ec1237ef07a8fe6732" + "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } @@ -57485,7 +79113,7 @@ }, "type": "object" }, - "searchKeywords": { + "organizations": { "properties": { "links": { "type": "object", @@ -57493,7 +79121,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/searchKeywords" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, @@ -57504,11 +79132,11 @@ "properties": { "type": { "type": "string", - "example": "product_search_keyword" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "effbcffaacb8111b531f15e6f4c796d1" + "example": "d9811f03b461a380c0d6b4a497dbac37" } } } @@ -57516,7 +79144,7 @@ }, "type": "object" }, - "productReviews": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -57524,7 +79152,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/productReviews" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, @@ -57535,19 +79163,25 @@ "properties": { "type": { "type": "string", - "example": "product_review" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "01e78541ea343ed72424a5222796a4cd" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" - }, - "mainCategories": { + } + }, + "type": "object" + }, + "relationships": { + "properties": { + "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -57555,61 +79189,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/mainCategories" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/media" } } }, "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": { "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" - } + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" } } } }, "type": "object" }, - "orderLineItems": { + "availabilityRule": { "properties": { "links": { "type": "object", @@ -57617,61 +79218,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderLineItems" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/availabilityRule" } } }, "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": { "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" - } + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "9fbb7961d1cb158094924c679e1b302c" } } } }, "type": "object" }, - "options": { + "salesChannelDefaultAssignments": { "properties": { "links": { "type": "object", @@ -57679,7 +79247,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/options" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannelDefaultAssignments" } } }, @@ -57690,11 +79258,11 @@ "properties": { "type": { "type": "string", - "example": "property_group_option" + "example": "sales_channel" }, "id": { "type": "string", - "example": "93da65a9fd0004d9477aeac024e08e15" + "example": "b23663b2abc0909be9a8027a3fbff74b" } } } @@ -57702,7 +79270,7 @@ }, "type": "object" }, - "properties": { + "plugin": { "properties": { "links": { "type": "object", @@ -57710,61 +79278,28 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/properties" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/plugin" } } }, "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": { "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" - } + "example": "plugin" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a24bcf2198b1b13ad985304483f7f324" } } } }, "type": "object" }, - "streams": { + "customers": { "properties": { "links": { "type": "object", @@ -57772,7 +79307,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/streams" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/customers" } } }, @@ -57783,11 +79318,11 @@ "properties": { "type": { "type": "string", - "example": "product_stream" + "example": "customer" }, "id": { "type": "string", - "example": "2f6f4768f1c2d7c8f1f54823723f1a70" + "example": "4b6f7d34a58ba399f077685951d06738" } } } @@ -57795,7 +79330,7 @@ }, "type": "object" }, - "categoriesRo": { + "orderTransactions": { "properties": { "links": { "type": "object", @@ -57803,7 +79338,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/categoriesRo" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/orderTransactions" } } }, @@ -57814,11 +79349,11 @@ "properties": { "type": { "type": "string", - "example": "category" + "example": "order_transaction" }, "id": { "type": "string", - "example": "7f0702d3a90d965b8c9158c451f43fdb" + "example": "3bdb6a464fb3330bd1935325493c5f2c" } } } @@ -57826,7 +79361,7 @@ }, "type": "object" }, - "tags": { + "salesChannels": { "properties": { "links": { "type": "object", @@ -57834,7 +79369,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/tags" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/salesChannels" } } }, @@ -57845,11 +79380,11 @@ "properties": { "type": { "type": "string", - "example": "tag" + "example": "sales_channel" }, "id": { "type": "string", - "example": "d57ac45256849d9b13e2422d91580fb9" + "example": "986f6f891e90ab91c091ff4a1a460777" } } } @@ -57857,7 +79392,7 @@ }, "type": "object" }, - "customFieldSets": { + "appPaymentMethod": { "properties": { "links": { "type": "object", @@ -57865,23 +79400,21 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customFieldSets" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/appPaymentMethod" } } }, "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "custom_field_set" - }, - "id": { - "type": "string", - "example": "9b29ba872ce510f033b31364c8602760" - } + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_payment_method" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "30f64104cd0d0a7bb8a9e07fe4d12d88" } } } @@ -57896,14 +79429,11 @@ } ] }, - "Product": { + "PaymentMethod": { "description": "Added since version: 6.0.0.0", "required": [ "id", - "taxId", - "price", - "productNumber", - "stock", + "technicalName", "name" ], "properties": { @@ -57911,284 +79441,63 @@ "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": { + "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "productNumber": { + "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "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" - } + "name": { + "type": "string" }, - "displayGroup": { + "distinguishableName": { "type": "string", "readOnly": true }, - "variantListingConfig": { - "type": "object" - }, - "variantRestrictions": { - "type": "object" - }, - "manufacturerNumber": { - "type": "string" - }, - "ean": { + "description": { "type": "string" }, - "purchaseSteps": { - "type": "integer", - "format": "int64" - }, - "maxPurchase": { - "type": "integer", - "format": "int64" - }, - "minPurchase": { + "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, - "purchaseUnit": { - "type": "number", - "format": "float" - }, - "referenceUnit": { - "type": "number", - "format": "float" - }, - "shippingFree": { + "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, - "purchasePrices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Price" - } - }, - "markAsTopseller": { + "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, - "weight": { - "type": "number", - "format": "float" - }, - "width": { - "type": "number", - "format": "float" - }, - "height": { - "type": "number", - "format": "float" - }, - "length": { - "type": "number", - "format": "float" + "customFields": { + "type": "object" }, - "releaseDate": { + "availabilityRuleId": { + "description": "Unique identity of rule.", "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" + "pattern": "^[0-9a-f]{32}$" }, - "description": { - "type": "string" + "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "metaTitle": { - "type": "string" + "formattedHandlerIdentifier": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "packUnit": { + "technicalName": { "type": "string" }, - "packUnitPlural": { + "shortName": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "customFields": { - "type": "object" - }, - "slotConfig": { - "type": "object" - }, - "customSearchKeywords": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": false - } - }, "createdAt": { "type": "string", "format": "date-time", @@ -58204,7 +79513,7 @@ }, "extensions": { "properties": { - "customPrice": { + "subscriptions": { "properties": { "links": { "type": "object", @@ -58212,7 +79521,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/customPrice" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/subscriptions" } } }, @@ -58223,11 +79532,11 @@ "properties": { "type": { "type": "string", - "example": "custom_price" + "example": "subscription" }, "id": { "type": "string", - "example": "35ed8bfa9c73171a7b417f13ab07d57a" + "example": "2d5d14f95af035cbd8437948de61f94c" } } } @@ -58235,7 +79544,7 @@ }, "type": "object" }, - "subscriptionPlans": { + "quoteTransactions": { "properties": { "links": { "type": "object", @@ -58243,7 +79552,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/subscriptionPlans" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/quoteTransactions" } } }, @@ -58254,11 +79563,11 @@ "properties": { "type": { "type": "string", - "example": "subscription_plan" + "example": "quote_transaction" }, "id": { "type": "string", - "example": "ed94874505da2886dc66a3a3d3968972" + "example": "c960fb2e8b7ef26229da52c7f7775e13" } } } @@ -58266,7 +79575,7 @@ }, "type": "object" }, - "warehouseGroups": { + "organizations": { "properties": { "links": { "type": "object", @@ -58274,7 +79583,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouseGroups" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/organizations" } } }, @@ -58285,11 +79594,11 @@ "properties": { "type": { "type": "string", - "example": "warehouse_group" + "example": "b2b_components_organization" }, "id": { "type": "string", - "example": "21191f2f6f4c30cd4ccc4714fa74ffea" + "example": "d9811f03b461a380c0d6b4a497dbac37" } } } @@ -58297,7 +79606,7 @@ }, "type": "object" }, - "warehouses": { + "b2bPendingOrders": { "properties": { "links": { "type": "object", @@ -58305,7 +79614,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/warehouses" + "example": "/payment-method/da8da1569e6bef3249a7064261df833f/b2bPendingOrders" } } }, @@ -58316,299 +79625,321 @@ "properties": { "type": { "type": "string", - "example": "product_warehouse" + "example": "b2b_components_pending_order" }, "id": { "type": "string", - "example": "544959798565126142ca2820b4f56271" + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" } } } } }, "type": "object" + } + }, + "type": "object" + }, + "media": { + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" + }, + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "orderWarehouses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/orderWarehouses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "order_product_warehouse" - }, - "id": { - "type": "string", - "example": "5331369e2f71d048521bd35d80975314" - } - } - } - } - }, - "type": "object" + "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", + "type": "string" }, - "reviewSummaries": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/reviewSummaries" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_review_summary" - }, - "id": { - "type": "string", - "example": "c9c718522e64ffa5effb26cef94f4849" - } - } - } - } - }, + "name": { + "description": "Unique name of the plugin.", + "type": "string" + }, + "composerName": { + "description": "Name of the composer package name.", + "type": "string" + }, + "autoload": { "type": "object" }, - "search": { + "active": { + "description": "When boolean value is `true`, the plugin is available.", + "type": "boolean" + }, + "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", + "type": "boolean" + }, + "path": { + "description": "A relative URL to the plugin.", + "type": "string" + }, + "author": { + "description": "Creator of the plugin.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created plugin.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "upgradeVersion": { + "description": "Update version available for upgrading plugins.", + "type": "string" + }, + "installedAt": { + "description": "Date and time when the plugin was installed.", + "type": "string", + "format": "date-time" + }, + "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", + "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" }, - "quoteLineItems": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/quoteLineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "quote_line_item" - }, - "id": { - "type": "string", - "example": "6b1c17ad551ef636e491ab6848f68420" - } - } - } - } - }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { "type": "object" }, - "shoppingListLineItems": { + "relationships": { "properties": { - "links": { - "type": "object", + "paymentMethods": { "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/product/deb10517653c255364175796ace3553f/shoppingListLineItems" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "b2b_components_shopping_list_line_item" - }, - "id": { - "type": "string", - "example": "ce593c6d1db236f22dc387a2ee20dfd6" + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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" + "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", + "type": "string" }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" + "name": { + "description": "Unique name of the plugin.", + "type": "string" }, - "featureSet": { - "$ref": "#/components/schemas/ProductFeatureSet" + "composerName": { + "description": "Name of the composer package name.", + "type": "string" }, - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "autoload": { + "type": "object" }, - "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "active": { + "description": "When boolean value is `true`, the plugin is available.", + "type": "boolean" }, - "prices": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" - } + "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", + "type": "boolean" }, - "media": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } + "path": { + "description": "A relative URL to the plugin.", + "type": "string" }, - "crossSellings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } + "author": { + "description": "Creator of the plugin.", + "type": "string" }, - "crossSellingAssignedProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } + "copyright": { + "description": "Legal rights on the created plugin.", + "type": "string" }, - "configuratorSettings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" }, - "visibilities": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } + "version": { + "description": "Version of the plugin.", + "type": "string" }, - "searchKeywords": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } + "upgradeVersion": { + "description": "Update version available for upgrading plugins.", + "type": "string" }, - "productReviews": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } + "installedAt": { + "description": "Date and time when the plugin was installed.", + "type": "string", + "format": "date-time" }, - "mainCategories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" - } + "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", + "type": "string", + "format": "date-time" }, - "seoUrls": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" - } + "icon": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true }, - "orderLineItems": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } + "label": { + "type": "string" }, - "wishlists": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } + "description": { + "type": "string" }, - "options": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "manufacturerLink": { + "type": "string" }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } + "supportLink": { + "type": "string" }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "customFields": { + "type": "object" }, - "streams": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "categoriesRo": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "tags": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } + "translated": { + "type": "object" }, - "customFieldSets": { + "paymentMethods": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSet" + "$ref": "#/components/schemas/PaymentMethod" } } }, @@ -58708,6 +80039,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58716,10 +80048,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58727,6 +80061,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -58857,6 +80192,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58865,10 +80201,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58876,6 +80214,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -58925,26 +80264,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58953,6 +80299,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59084,26 +80431,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59112,6 +80466,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59161,10 +80516,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59173,6 +80530,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -59267,10 +80625,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59279,6 +80639,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -59355,6 +80716,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59363,10 +80725,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -59468,6 +80832,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -59476,10 +80841,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -59532,64 +80899,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -59779,64 +81164,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -60006,13 +81409,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { @@ -60067,13 +81473,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "language": { @@ -60103,6 +81512,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60225,6 +81635,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60295,6 +81706,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60303,10 +81715,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -60439,6 +81853,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60447,10 +81862,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -60538,6 +81955,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60546,6 +81964,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60556,10 +81975,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -60663,6 +82084,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60671,6 +82093,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60681,10 +82104,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -60763,6 +82188,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60771,37 +82197,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -60959,6 +82395,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -60967,37 +82404,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -61211,13 +82658,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -61319,13 +82769,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -61375,23 +82828,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -61486,23 +82945,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -61549,10 +83014,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61561,9 +83028,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -61664,10 +83133,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -61676,9 +83147,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -61829,6 +83302,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -61841,6 +83315,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -61854,6 +83332,102 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "individualPricingRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/individualPricingRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b20f572b5ee1c3d5e1b41c2de255a04" + } + } + } + }, + "type": "object" + }, + "advancedSearchBoostings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/advancedSearchBoostings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_boosting" + }, + "id": { + "type": "string", + "example": "8efe572a8c2f5ac25f8d2b1160493acb" + } + } + } + } + }, + "type": "object" + }, + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "filters": { @@ -62004,6 +83578,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -62016,6 +83591,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -62029,6 +83608,102 @@ "translated": { "type": "object" }, + "extensions": { + "properties": { + "individualPricingRule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/individualPricingRule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b20f572b5ee1c3d5e1b41c2de255a04" + } + } + } + }, + "type": "object" + }, + "advancedSearchBoostings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/advancedSearchBoostings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_boosting" + }, + "id": { + "type": "string", + "example": "8efe572a8c2f5ac25f8d2b1160493acb" + } + } + } + } + }, + "type": "object" + }, + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "filters": { "type": "array", "items": { @@ -62074,6 +83749,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -62082,21 +83758,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -62145,6 +83826,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -62225,6 +83907,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -62233,21 +83916,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -62268,7 +83956,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -62362,6 +84051,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -62370,10 +84060,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -62469,6 +84161,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -62477,10 +84170,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -62683,11 +84378,18 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "deliveryTimeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "product": { "$ref": "#/components/schemas/Product" }, "warehouseGroup": { "$ref": "#/components/schemas/WarehouseGroup" + }, + "deliveryTime": { + "$ref": "#/components/schemas/DeliveryTime" } }, "type": "object" @@ -62712,53 +84414,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -63130,53 +84847,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -63341,8 +85073,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -63350,36 +85081,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -63500,8 +85241,7 @@ "promotionId", "scope", "type", - "value", - "considerAdvancedRules" + "value" ], "properties": { "id": { @@ -63509,36 +85249,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -63588,14 +85338,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -63691,14 +85444,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -63767,10 +85523,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -63838,10 +85596,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -63966,14 +85726,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -64069,14 +85832,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -64119,16 +85885,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -64227,16 +85997,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -64313,15 +86087,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -64403,15 +86181,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -64461,6 +86243,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64472,12 +86255,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -64668,6 +86457,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -64679,12 +86469,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -64983,6 +86779,9 @@ "customFields": { "type": "object" }, + "cartPayload": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -64993,6 +86792,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "stateMachineState": { @@ -65700,6 +87533,9 @@ "customFields": { "type": "object" }, + "cartPayload": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -65710,6 +87546,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "organization": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote/c48e929b2b1eabba2ba036884433345e/organization" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "b4c1948c087fafc89a88450fcbb64c77" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "stateMachineState": { "$ref": "#/components/schemas/StateMachineState" }, @@ -65819,6 +87689,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -65922,6 +87796,35 @@ }, "type": "object" }, + "employee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-comment/b3ef9135f573201be0dd21b395c6ec07/employee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fa5473530e4d1a5a1e1eb53d2fedb10c" + } + } + } + }, + "type": "object" + }, "createdBy": { "properties": { "links": { @@ -65997,6 +87900,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "employeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "createdById": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -66020,6 +87927,9 @@ "customer": { "$ref": "#/components/schemas/Customer" }, + "employee": { + "$ref": "#/components/schemas/B2bEmployee" + }, "createdBy": { "$ref": "#/components/schemas/User" } @@ -66731,6 +88641,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -66832,6 +88746,35 @@ } }, "type": "object" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-document/08e3c4797f89c301ce82e4bcfab6d266/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -66896,6 +88839,10 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "documentA11yMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -66917,6 +88864,9 @@ }, "documentMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, "type": "object" @@ -67156,7 +89106,8 @@ "type": "array", "items": { "type": "string" - } + }, + "deprecated": true }, "label": { "type": "string" @@ -67476,6 +89427,37 @@ } }, "type": "object" + }, + "deliveryPositions": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/quote-line-item/c7917be23ddd01ec45871fc8c1e5e540/deliveryPositions" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_delivery_position" + }, + "id": { + "type": "string", + "example": "ef53ddda8fd07e19297084ad1219e97d" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -67543,7 +89525,8 @@ "type": "array", "items": { "type": "string" - } + }, + "deprecated": true }, "label": { "type": "string" @@ -67706,6 +89689,12 @@ }, "cover": { "$ref": "#/components/schemas/Media" + }, + "deliveryPositions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/QuoteDeliveryPosition" + } } }, "type": "object" @@ -68008,16 +89997,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -68139,6 +90132,37 @@ } }, "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -68600,16 +90624,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -68731,6 +90759,37 @@ } }, "type": "object" + }, + "bundleDiscounts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/rule/ab7a485ebe75b6dd7243ad719f23c7de/bundleDiscounts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "bundle_discount" + }, + "id": { + "type": "string", + "example": "a79712cce6d0182645b519f6add10f77" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -68840,13 +90899,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -68858,6 +90920,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -68935,6 +90998,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -69015,13 +91079,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69033,6 +91100,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -69056,7 +91124,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -69122,38 +91191,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69162,10 +91240,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69174,6 +91254,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69182,35 +91263,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -69232,6 +91324,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -69364,6 +91457,192 @@ } }, "type": "object" + }, + "productReviewSummaries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviewSummaries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "71dea071bf87f22aaa4a5b09a93568f0" + } + } + } + } + }, + "type": "object" + }, + "advancedSearchConfigs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedSearchConfigs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "example": "82323999923ad7cb77d84c92d1832e8c" + } + } + } + } + }, + "type": "object" + }, + "advancedSearchActionSearchTerms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedSearchActionSearchTerms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action_search_term" + }, + "id": { + "type": "string", + "example": "27dd218be73cea6876e97b6a7f5c8957" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "shoppingLists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shoppingLists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -69555,6 +91834,7 @@ "type": "object" }, "language": { + "description": "Default language for the sales channel", "properties": { "links": { "type": "object", @@ -69613,6 +91893,7 @@ "type": "object" }, "currency": { + "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", @@ -69642,6 +91923,7 @@ "type": "object" }, "paymentMethod": { + "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", @@ -69671,6 +91953,7 @@ "type": "object" }, "shippingMethod": { + "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", @@ -69700,6 +91983,7 @@ "type": "object" }, "country": { + "description": "Default country for the sales channel", "properties": { "links": { "type": "object", @@ -69820,6 +92104,7 @@ "type": "object" }, "domains": { + "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", @@ -69882,6 +92167,7 @@ "type": "object" }, "navigationCategory": { + "description": "Root category for navigation menu", "properties": { "links": { "type": "object", @@ -69911,6 +92197,7 @@ "type": "object" }, "footerCategory": { + "description": "Root category for footer navigation", "properties": { "links": { "type": "object", @@ -69940,6 +92227,7 @@ "type": "object" }, "serviceCategory": { + "description": "Root category for service pages", "properties": { "links": { "type": "object", @@ -70519,38 +92807,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70559,10 +92856,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70571,6 +92870,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70579,35 +92879,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -70629,6 +92940,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -70761,6 +93073,192 @@ } }, "type": "object" + }, + "productReviewSummaries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/productReviewSummaries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_review_summary" + }, + "id": { + "type": "string", + "example": "71dea071bf87f22aaa4a5b09a93568f0" + } + } + } + } + }, + "type": "object" + }, + "advancedSearchConfigs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedSearchConfigs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_config" + }, + "id": { + "type": "string", + "example": "82323999923ad7cb77d84c92d1832e8c" + } + } + } + } + }, + "type": "object" + }, + "advancedSearchActionSearchTerms": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedSearchActionSearchTerms" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "advanced_search_action_search_term" + }, + "id": { + "type": "string", + "example": "27dd218be73cea6876e97b6a7f5c8957" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" + }, + "shoppingLists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/shoppingLists" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_shopping_list" + }, + "id": { + "type": "string", + "example": "efa2c2d016771a1e072e6b05091fb584" + } + } + } + } + }, + "type": "object" + }, + "advancedProductCatalogs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/sales-channel/e497ee380a9e2a5e9812e9e0bf504045/advancedProductCatalogs" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_advanced_product_catalogs" + }, + "id": { + "type": "string", + "example": "fbec40add5492465d78b550a9a4ae26e" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -70799,22 +93297,27 @@ "$ref": "#/components/schemas/SalesChannelType" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" }, "country": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" }, "orders": { "type": "array", @@ -70832,6 +93335,7 @@ "$ref": "#/components/schemas/CmsPage" }, "domains": { + "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -70844,13 +93348,16 @@ } }, "navigationCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" }, "footerCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" }, "serviceCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" }, "productVisibilities": { "type": "array", @@ -70964,15 +93471,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Unique identity for tracking.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "createdAt": { @@ -71025,9 +93540,14 @@ ] }, "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "description": "Sales channel analytics configuration", "required": [ - "id" + "id", + "active", + "trackOrders", + "anonymizeIp", + "trackOffcanvasCart", + "createdAt" ], "properties": { "id": { @@ -71035,15 +93555,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Google Analytics tracking ID (e.g., UA-XXXXX-Y or G-XXXXXXXX)", "type": "string" }, "active": { + "description": "Whether Google Analytics tracking is enabled", "type": "boolean" }, "trackOrders": { + "description": "Track order completions in Google Analytics", "type": "boolean" }, "anonymizeIp": { + "description": "Anonymize visitor IP addresses for GDPR compliance", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, "createdAt": { @@ -71052,7 +93580,10 @@ "readOnly": true }, "updatedAt": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "readOnly": true }, @@ -71139,25 +93670,34 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -71375,25 +93915,34 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -71534,9 +94083,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -71626,9 +94177,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -71693,6 +94246,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -71780,6 +94334,37 @@ } }, "type": "object" + }, + "b2bPendingOrderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/b2bPendingOrderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "7c55a27217c16d4e6395eb18a7f3be2f" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -71963,6 +94548,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -72050,6 +94636,37 @@ } }, "type": "object" + }, + "b2bPendingOrderAddresses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/salutation/c69a98e13eae87bc0ca8735329bf3a5d/b2bPendingOrderAddresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order_address" + }, + "id": { + "type": "string", + "example": "7c55a27217c16d4e6395eb18a7f3be2f" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -72108,27 +94725,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -72163,27 +94787,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -72220,15 +94851,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -72299,15 +94934,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -72351,33 +94990,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -72485,33 +95133,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -72562,19 +95219,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -72642,19 +95304,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -72685,6 +95352,7 @@ { "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -72696,10 +95364,15 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -72707,21 +95380,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -72731,9 +95409,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -72810,6 +95485,68 @@ } }, "type": "object" + }, + "organizations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/organizations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "d9811f03b461a380c0d6b4a497dbac37" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -72817,6 +95554,7 @@ "relationships": { "properties": { "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -72846,6 +95584,7 @@ "type": "object" }, "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -72875,6 +95614,7 @@ "type": "object" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -72906,6 +95646,7 @@ "type": "object" }, "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -72935,6 +95676,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -73059,6 +95801,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -73128,6 +95871,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -73139,10 +95883,15 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -73150,21 +95899,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -73174,9 +95928,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -73253,26 +96004,93 @@ } }, "type": "object" + }, + "organizations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/organizations" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_organization" + }, + "id": { + "type": "string", + "example": "d9811f03b461a380c0d6b4a497dbac37" + } + } + } + } + }, + "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/shipping-method/d72e7a227a27328b28342b32fc66b6bf/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" } }, "type": "object" }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -73297,7 +96115,8 @@ } }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" @@ -73322,26 +96141,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -73473,26 +96298,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -73575,16 +96406,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -73654,16 +96489,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -73704,12 +96543,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -73811,12 +96652,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -73944,20 +96787,486 @@ "name": { "type": "string" }, - "description": { - "type": "string" - }, - "backgroundEnabled": { - "type": "boolean" - }, - "backgroundColor": { - "type": "string" + "description": { + "type": "string" + }, + "backgroundEnabled": { + "type": "boolean" + }, + "backgroundColor": { + "type": "string" + }, + "floorEnabled": { + "type": "boolean" + }, + "floorColor": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "objects": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/objects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "5891da2d64975cae48d175d1e001f5da" + } + } + } + } + }, + "type": "object" + }, + "cameras": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/cameras" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_camera" + }, + "id": { + "type": "string", + "example": "036651ad64ffb926ca7a2759af327a8a" + } + } + } + } + }, + "type": "object" + }, + "lights": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/lights" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_light" + }, + "id": { + "type": "string", + "example": "278e59671a1a559c4bc61d226cd217cd" + } + } + } + } + }, + "type": "object" + }, + "groups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/groups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_group" + }, + "id": { + "type": "string", + "example": "1471e4e05a4db95d353cc867fe317314" + } + } + } + } + }, + "type": "object" + }, + "primitives": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/primitives" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_primitive" + }, + "id": { + "type": "string", + "example": "9e1458cd0f9b5cb89abeeed7490f1446" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SpatialScene": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "backgroundEnabled": { + "type": "boolean" + }, + "backgroundColor": { + "type": "string" + }, + "floorEnabled": { + "type": "boolean" + }, + "floorColor": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } + }, + "cameras": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneCamera" + } + }, + "lights": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneLight" + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + }, + "primitives": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + } + }, + "type": "object" + }, + "SpatialSceneCameraJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "sceneId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "position": { + "type": "object" + }, + "target": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "relationships": { + "properties": { + "scene": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-camera/d7d65fbdb516f0fc0e32feb511de5c33/scene" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1e7f604b86415ade94e15fef8627609b" + } + } + } + }, + "type": "object" + }, + "parentGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-camera/d7d65fbdb516f0fc0e32feb511de5c33/parentGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70eeadaa8569846e35f40fff3603a7a7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SpatialSceneCamera": { + "required": [ + "id", + "name", + "sceneId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "type": "string" + }, + "position": { + "type": "object" + }, + "target": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "scene": { + "$ref": "#/components/schemas/SpatialScene" + }, + "parentGroup": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + }, + "type": "object" + }, + "SpatialSceneGroupJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "sceneId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "position": { + "type": "object" }, - "floorEnabled": { - "type": "boolean" + "rotation": { + "type": "object" }, - "floorColor": { - "type": "string" + "scale": { + "type": "object" }, "createdAt": { "type": "string", @@ -73969,6 +97278,28 @@ "format": "date-time", "readOnly": true }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, "relationships": { "properties": { "objects": { @@ -73979,7 +97310,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/objects" + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/objects" } } }, @@ -74010,7 +97341,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/cameras" + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/cameras" } } }, @@ -74041,7 +97372,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/spatial-scene/fbe2b606c76b0075eced631365324623/lights" + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/lights" } } }, @@ -74063,6 +97394,126 @@ } }, "type": "object" + }, + "groups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/groups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_group" + }, + "id": { + "type": "string", + "example": "1471e4e05a4db95d353cc867fe317314" + } + } + } + } + }, + "type": "object" + }, + "primitives": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/primitives" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_primitive" + }, + "id": { + "type": "string", + "example": "9e1458cd0f9b5cb89abeeed7490f1446" + } + } + } + } + }, + "type": "object" + }, + "scene": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/scene" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1e7f604b86415ade94e15fef8627609b" + } + } + } + }, + "type": "object" + }, + "parentGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-group/baf4562a435c11dc5d188d7762de65af/parentGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70eeadaa8569846e35f40fff3603a7a7" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -74072,10 +97523,11 @@ } ] }, - "SpatialScene": { + "SpatialSceneGroup": { "required": [ "id", - "name" + "name", + "sceneId" ], "properties": { "id": { @@ -74085,20 +97537,14 @@ "name": { "type": "string" }, - "description": { - "type": "string" - }, - "backgroundEnabled": { - "type": "boolean" - }, - "backgroundColor": { - "type": "string" + "position": { + "type": "object" }, - "floorEnabled": { - "type": "boolean" + "rotation": { + "type": "object" }, - "floorColor": { - "type": "string" + "scale": { + "type": "object" }, "createdAt": { "type": "string", @@ -74110,6 +97556,28 @@ "format": "date-time", "readOnly": true }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, "objects": { "type": "array", "items": { @@ -74127,11 +97595,29 @@ "items": { "$ref": "#/components/schemas/SpatialSceneLight" } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + }, + "primitives": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + }, + "scene": { + "$ref": "#/components/schemas/SpatialScene" + }, + "parentGroup": { + "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, - "SpatialSceneCameraJsonApi": { + "SpatialSceneLightJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -74139,29 +97625,35 @@ { "required": [ "id", - "sceneId", "type", - "name" + "name", + "sceneId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "sceneId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "type": { "type": "string" }, "name": { "type": "string" }, + "enabled": { + "type": "boolean" + }, + "intensity": { + "type": "number", + "format": "float" + }, + "color": { + "type": "string" + }, "position": { "type": "object" }, - "target": { + "rotation": { "type": "object" }, "createdAt": { @@ -74174,6 +97666,28 @@ "format": "date-time", "readOnly": true }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, "relationships": { "properties": { "scene": { @@ -74184,7 +97698,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/spatial-scene-camera/d7d65fbdb516f0fc0e32feb511de5c33/scene" + "example": "/spatial-scene-light/fb2a55d47b419c2709f04f235c4eb7fe/scene" } } }, @@ -74204,6 +97718,35 @@ } }, "type": "object" + }, + "parentGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-light/fb2a55d47b419c2709f04f235c4eb7fe/parentGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70eeadaa8569846e35f40fff3603a7a7" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -74213,32 +97756,38 @@ } ] }, - "SpatialSceneCamera": { + "SpatialSceneLight": { "required": [ "id", - "sceneId", "type", - "name" + "name", + "sceneId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "sceneId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "type": { "type": "string" }, "name": { "type": "string" }, + "enabled": { + "type": "boolean" + }, + "intensity": { + "type": "number", + "format": "float" + }, + "color": { + "type": "string" + }, "position": { "type": "object" }, - "target": { + "rotation": { "type": "object" }, "createdAt": { @@ -74251,13 +97800,38 @@ "format": "date-time", "readOnly": true }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, "scene": { "$ref": "#/components/schemas/SpatialScene" + }, + "parentGroup": { + "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" }, - "SpatialSceneLightJsonApi": { + "SpatialSceneMaterialJsonApi": { "allOf": [ { "$ref": "#/components/schemas/resource" @@ -74265,40 +97839,25 @@ { "required": [ "id", - "sceneId", - "type", - "name" + "color", + "metalness", + "roughness" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "sceneId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "name": { + "color": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "intensity": { + "metalness": { "type": "number", "format": "float" }, - "color": { - "type": "string" - }, - "position": { - "type": "object" - }, - "rotation": { - "type": "object" + "roughness": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -74312,7 +97871,7 @@ }, "relationships": { "properties": { - "scene": { + "primitives": { "properties": { "links": { "type": "object", @@ -74320,21 +97879,54 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/spatial-scene-light/fb2a55d47b419c2709f04f235c4eb7fe/scene" + "example": "/spatial-scene-material/902c4f06a9bae5968b45aefbb0a2b09f/primitives" } } }, "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_primitive" + }, + "id": { + "type": "string", + "example": "9e1458cd0f9b5cb89abeeed7490f1446" + } + } + } + } + }, + "type": "object" + }, + "objects": { + "properties": { + "links": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "spatial_scene" - }, - "id": { + "related": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1e7f604b86415ade94e15fef8627609b" + "format": "uri-reference", + "example": "/spatial-scene-material/902c4f06a9bae5968b45aefbb0a2b09f/objects" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_object" + }, + "id": { + "type": "string", + "example": "5891da2d64975cae48d175d1e001f5da" + } } } } @@ -74349,43 +97941,28 @@ } ] }, - "SpatialSceneLight": { + "SpatialSceneMaterial": { "required": [ "id", - "sceneId", - "type", - "name" + "color", + "metalness", + "roughness" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "sceneId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "name": { + "color": { "type": "string" }, - "enabled": { - "type": "boolean" - }, - "intensity": { + "metalness": { "type": "number", "format": "float" }, - "color": { - "type": "string" - }, - "position": { - "type": "object" - }, - "rotation": { - "type": "object" + "roughness": { + "type": "number", + "format": "float" }, "createdAt": { "type": "string", @@ -74397,8 +97974,17 @@ "format": "date-time", "readOnly": true }, - "scene": { - "$ref": "#/components/schemas/SpatialScene" + "primitives": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialScenePrimitive" + } + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneObject" + } } }, "type": "object" @@ -74411,19 +97997,15 @@ { "required": [ "id", - "sceneId", "mediaId", - "name" + "name", + "sceneId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "sceneId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "mediaId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -74431,9 +98013,6 @@ "name": { "type": "string" }, - "visible": { - "type": "boolean" - }, "position": { "type": "object" }, @@ -74453,8 +98032,90 @@ "format": "date-time", "readOnly": true }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, "relationships": { "properties": { + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/media" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + } + } + } + }, + "type": "object" + }, + "materials": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/materials" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_material" + }, + "id": { + "type": "string", + "example": "2d2ac038a83870def5a37f56545b8f2b" + } + } + } + } + }, + "type": "object" + }, "scene": { "properties": { "links": { @@ -74484,7 +98145,7 @@ }, "type": "object" }, - "media": { + "parentGroup": { "properties": { "links": { "type": "object", @@ -74492,7 +98153,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/media" + "example": "/spatial-scene-object/c632bfed18543c7114e7a93456a28d9c/parentGroup" } } }, @@ -74501,12 +98162,12 @@ "properties": { "type": { "type": "string", - "example": "media" + "example": "spatial_scene_group" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "62933a2951ef01f4eafd9bdf4d3cd2f0" + "example": "70eeadaa8569846e35f40fff3603a7a7" } } } @@ -74524,28 +98185,294 @@ "SpatialSceneObject": { "required": [ "id", - "sceneId", "mediaId", - "name" + "name", + "sceneId" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "position": { + "type": "object" + }, + "rotation": { + "type": "object" + }, + "scale": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, "sceneId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "mediaId": { + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "media": { + "$ref": "#/components/schemas/Media" + }, + "materials": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + }, + "scene": { + "$ref": "#/components/schemas/SpatialScene" + }, + "parentGroup": { + "$ref": "#/components/schemas/SpatialSceneGroup" + } + }, + "type": "object" + }, + "SpatialSceneObjectMaterial": { + "required": [ + "objectId", + "materialId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "objectId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "materialId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "object": { + "$ref": "#/components/schemas/SpatialSceneObject" + }, + "material": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + } + }, + "type": "object" + }, + "SpatialScenePrimitiveJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "geometry", + "sceneId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "materialId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "geometry": { + "type": "string" + }, + "position": { + "type": "object" + }, + "rotation": { + "type": "object" + }, + "scale": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "relationships": { + "properties": { + "material": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-primitive/b1d294174f631571ec4e1407ba03b2bf/material" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_material" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "eec34d804c9ce6c89cff596be555e6a4" + } + } + } + }, + "type": "object" + }, + "scene": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-primitive/b1d294174f631571ec4e1407ba03b2bf/scene" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1e7f604b86415ade94e15fef8627609b" + } + } + } + }, + "type": "object" + }, + "parentGroup": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/spatial-scene-primitive/b1d294174f631571ec4e1407ba03b2bf/parentGroup" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "spatial_scene_group" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "70eeadaa8569846e35f40fff3603a7a7" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "SpatialScenePrimitive": { + "required": [ + "id", + "name", + "geometry", + "sceneId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "materialId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { "type": "string" }, - "visible": { - "type": "boolean" + "geometry": { + "type": "string" }, "position": { "type": "object" @@ -74566,11 +98493,36 @@ "format": "date-time", "readOnly": true }, + "sceneId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "parentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visible": { + "type": "boolean" + }, + "locked": { + "type": "boolean" + }, + "afterId": { + "type": "string" + }, + "childCount": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "integer", + "format": "int64" + }, + "material": { + "$ref": "#/components/schemas/SpatialSceneMaterial" + }, "scene": { "$ref": "#/components/schemas/SpatialScene" }, - "media": { - "$ref": "#/components/schemas/Media" + "parentGroup": { + "$ref": "#/components/schemas/SpatialSceneGroup" } }, "type": "object" @@ -74906,6 +98858,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -75047,6 +99000,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -75115,35 +99069,50 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -75271,6 +99240,35 @@ } }, "type": "object" + }, + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -75297,35 +99295,50 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -75347,6 +99360,9 @@ }, "user": { "$ref": "#/components/schemas/User" + }, + "integration": { + "$ref": "#/components/schemas/Integration" } }, "type": "object" @@ -75370,12 +99386,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -75582,6 +99600,37 @@ } }, "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -75918,12 +99967,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -76130,6 +100181,37 @@ } }, "type": "object" + }, + "b2bPendingOrders": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-state/1e364983d1f17d332d360ae797efc181/b2bPendingOrders" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_pending_order" + }, + "id": { + "type": "string", + "example": "f8d3c42a34c29f39fe96a52e71b1a4c9" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -76214,17 +100296,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -76353,17 +100439,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -76403,6 +100493,7 @@ "convertedOrder", "subscriptionNumber", "nextSchedule", + "followingNextSchedule", "salesChannelId", "subscriptionPlanName", "subscriptionIntervalName", @@ -76438,6 +100529,11 @@ "type": "string", "format": "date-time" }, + "followingNextSchedule": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "format": "date-time" + }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -76498,6 +100594,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "initialOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "initialOrderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -76553,6 +100657,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "subscriptionEmployee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionEmployee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a4844d7989267e34103e44248b16cf6c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "relationships": { "properties": { "salesChannel": { @@ -76966,6 +101104,35 @@ } }, "type": "object" + }, + "initialOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/initialOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "5dd26f6705e75ee9dc0876dc5cdc739a" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -76981,6 +101148,7 @@ "convertedOrder", "subscriptionNumber", "nextSchedule", + "followingNextSchedule", "salesChannelId", "subscriptionPlanName", "subscriptionIntervalName", @@ -77016,6 +101184,11 @@ "type": "string", "format": "date-time" }, + "followingNextSchedule": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string", + "format": "date-time" + }, "salesChannelId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -77076,6 +101249,14 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "initialOrderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "initialOrderVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "customFields": { "type": "object" }, @@ -77131,6 +101312,40 @@ "format": "date-time", "readOnly": true }, + "extensions": { + "properties": { + "subscriptionEmployee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/subscription/787ad0b7a17de4ad6b1711bbf8d79fcb/subscriptionEmployee" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_subscription_employee" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "a4844d7989267e34103e44248b16cf6c" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, @@ -77181,6 +101396,9 @@ }, "language": { "$ref": "#/components/schemas/Language" + }, + "initialOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -77257,6 +101475,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -77521,6 +101743,10 @@ "additionalAddressLine2": { "type": "string" }, + "hash": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "string" + }, "customFields": { "type": "object" }, @@ -77809,7 +102035,8 @@ { "required": [ "id", - "name" + "name", + "delayed" ], "properties": { "id": { @@ -77828,6 +102055,10 @@ "cronInterval": { "type": "string" }, + "delayed": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -77949,7 +102180,8 @@ "SubscriptionInterval": { "required": [ "id", - "name" + "name", + "delayed" ], "properties": { "id": { @@ -77968,6 +102200,10 @@ "cronInterval": { "type": "string" }, + "delayed": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "availabilityRuleId": { "type": "string", "pattern": "^[0-9a-f]{32}$" @@ -78399,6 +102635,9 @@ "stored": { "type": "object" }, + "errorMessage": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -78580,6 +102819,9 @@ "stored": { "type": "object" }, + "errorMessage": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -78650,6 +102892,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -78661,6 +102904,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78726,6 +102970,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -78737,6 +102982,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -78817,6 +103063,37 @@ } }, "type": "object" + }, + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -79166,6 +103443,37 @@ } }, "type": "object" + }, + "individualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/tag/c101058e7ea21bbbf2a5ac893088e90b/individualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "5246e417af07e49dc4961c49d4ad6c75" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -79245,14 +103553,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -79385,14 +103695,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -79449,26 +103761,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -79570,26 +103888,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -79638,14 +103962,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -79671,10 +103998,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -79800,14 +104129,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -79833,10 +104165,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -79881,10 +104215,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -79959,10 +104295,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -80514,41 +104852,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -80564,6 +104913,192 @@ }, "extensions": { "properties": { + "orderReturnsCreated": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsCreated" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "727aaaa1b237ca288bd73419446975b4" + } + } + } + } + }, + "type": "object" + }, + "orderReturnsUpdated": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsUpdated" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "b236f1d18dddb0c2a359d93c25da5a20" + } + } + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "quotesUpdated": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesUpdated" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "58ff54114372ffbca7305b48fa25f8fc" + } + } + } + } + }, + "type": "object" + }, + "quotesAssignee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesAssignee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "1b848b0267abc056ed84fb16cb26f60a" + } + } + } + } + }, + "type": "object" + }, + "createdQuoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "860bc13329c5b039ddeccbd9cced778d" + } + } + } + } + }, + "type": "object" + }, "createdNotifications": { "properties": { "links": { @@ -80595,7 +105130,7 @@ }, "type": "object" }, - "orderReturnsCreated": { + "shoppingLists": { "properties": { "links": { "type": "object", @@ -80603,7 +105138,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsCreated" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingLists" } } }, @@ -80614,11 +105149,11 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "727aaaa1b237ca288bd73419446975b4" + "example": "efa2c2d016771a1e072e6b05091fb584" } } } @@ -80626,7 +105161,7 @@ }, "type": "object" }, - "orderReturnsUpdated": { + "shoppingListsUpdated": { "properties": { "links": { "type": "object", @@ -80634,7 +105169,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsUpdated" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingListsUpdated" } } }, @@ -80645,11 +105180,11 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "b236f1d18dddb0c2a359d93c25da5a20" + "example": "c47bfa46d7fba9695703a588a4aa19fb" } } } @@ -80657,7 +105192,7 @@ }, "type": "object" }, - "quotes": { + "createdAdvancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -80665,7 +105200,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotes" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAdvancedProductCatalogs" } } }, @@ -80676,11 +105211,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "e0d6784016e56c0ac2ed620abadda119" } } } @@ -80688,7 +105223,7 @@ }, "type": "object" }, - "quotesUpdated": { + "updatedAdvancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -80696,7 +105231,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesUpdated" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAdvancedProductCatalogs" } } }, @@ -80707,11 +105242,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", - "example": "58ff54114372ffbca7305b48fa25f8fc" + "example": "a26e117c9f4ed119b46afbc3e3cae7f0" } } } @@ -80719,7 +105254,7 @@ }, "type": "object" }, - "quotesAssignee": { + "createdBudgets": { "properties": { "links": { "type": "object", @@ -80727,7 +105262,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesAssignee" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdBudgets" } } }, @@ -80738,11 +105273,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_budget" }, "id": { "type": "string", - "example": "1b848b0267abc056ed84fb16cb26f60a" + "example": "62528618b0cda8a734a729c2dd9407a2" } } } @@ -80750,7 +105285,7 @@ }, "type": "object" }, - "createdQuoteComments": { + "createdIndividualPricings": { "properties": { "links": { "type": "object", @@ -80758,7 +105293,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdIndividualPricings" } } }, @@ -80769,11 +105304,42 @@ "properties": { "type": { "type": "string", - "example": "quote_comment" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", - "example": "860bc13329c5b039ddeccbd9cced778d" + "example": "e383c28adc8be26b4561702835291d05" + } + } + } + } + }, + "type": "object" + }, + "updatedIndividualPricings": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedIndividualPricings" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "b2b_components_individual_pricing" + }, + "id": { + "type": "string", + "example": "c04472254d6a0e3655d277ec6ee53c29" } } } @@ -81207,41 +105773,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -81257,6 +105834,192 @@ }, "extensions": { "properties": { + "orderReturnsCreated": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsCreated" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "727aaaa1b237ca288bd73419446975b4" + } + } + } + } + }, + "type": "object" + }, + "orderReturnsUpdated": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsUpdated" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_return" + }, + "id": { + "type": "string", + "example": "b236f1d18dddb0c2a359d93c25da5a20" + } + } + } + } + }, + "type": "object" + }, + "quotes": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotes" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "2150fd65034a9bcdb357943b3900a918" + } + } + } + } + }, + "type": "object" + }, + "quotesUpdated": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesUpdated" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "58ff54114372ffbca7305b48fa25f8fc" + } + } + } + } + }, + "type": "object" + }, + "quotesAssignee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesAssignee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote" + }, + "id": { + "type": "string", + "example": "1b848b0267abc056ed84fb16cb26f60a" + } + } + } + } + }, + "type": "object" + }, + "createdQuoteComments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "quote_comment" + }, + "id": { + "type": "string", + "example": "860bc13329c5b039ddeccbd9cced778d" + } + } + } + } + }, + "type": "object" + }, "createdNotifications": { "properties": { "links": { @@ -81265,7 +106028,38 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdNotifications" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "notification" + }, + "id": { + "type": "string", + "example": "04f88ea12127fe03b65beffbc2c96954" + } + } + } + } + }, + "type": "object" + }, + "shoppingLists": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingLists" } } }, @@ -81276,11 +106070,11 @@ "properties": { "type": { "type": "string", - "example": "notification" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "04f88ea12127fe03b65beffbc2c96954" + "example": "efa2c2d016771a1e072e6b05091fb584" } } } @@ -81288,7 +106082,7 @@ }, "type": "object" }, - "orderReturnsCreated": { + "shoppingListsUpdated": { "properties": { "links": { "type": "object", @@ -81296,7 +106090,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsCreated" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/shoppingListsUpdated" } } }, @@ -81307,11 +106101,11 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "b2b_components_shopping_list" }, "id": { "type": "string", - "example": "727aaaa1b237ca288bd73419446975b4" + "example": "c47bfa46d7fba9695703a588a4aa19fb" } } } @@ -81319,7 +106113,7 @@ }, "type": "object" }, - "orderReturnsUpdated": { + "createdAdvancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -81327,7 +106121,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/orderReturnsUpdated" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdAdvancedProductCatalogs" } } }, @@ -81338,11 +106132,11 @@ "properties": { "type": { "type": "string", - "example": "order_return" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", - "example": "b236f1d18dddb0c2a359d93c25da5a20" + "example": "e0d6784016e56c0ac2ed620abadda119" } } } @@ -81350,7 +106144,7 @@ }, "type": "object" }, - "quotes": { + "updatedAdvancedProductCatalogs": { "properties": { "links": { "type": "object", @@ -81358,7 +106152,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotes" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedAdvancedProductCatalogs" } } }, @@ -81369,11 +106163,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_advanced_product_catalogs" }, "id": { "type": "string", - "example": "2150fd65034a9bcdb357943b3900a918" + "example": "a26e117c9f4ed119b46afbc3e3cae7f0" } } } @@ -81381,7 +106175,7 @@ }, "type": "object" }, - "quotesUpdated": { + "createdBudgets": { "properties": { "links": { "type": "object", @@ -81389,7 +106183,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesUpdated" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdBudgets" } } }, @@ -81400,11 +106194,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_budget" }, "id": { "type": "string", - "example": "58ff54114372ffbca7305b48fa25f8fc" + "example": "62528618b0cda8a734a729c2dd9407a2" } } } @@ -81412,7 +106206,7 @@ }, "type": "object" }, - "quotesAssignee": { + "createdIndividualPricings": { "properties": { "links": { "type": "object", @@ -81420,7 +106214,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/quotesAssignee" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdIndividualPricings" } } }, @@ -81431,11 +106225,11 @@ "properties": { "type": { "type": "string", - "example": "quote" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", - "example": "1b848b0267abc056ed84fb16cb26f60a" + "example": "e383c28adc8be26b4561702835291d05" } } } @@ -81443,7 +106237,7 @@ }, "type": "object" }, - "createdQuoteComments": { + "updatedIndividualPricings": { "properties": { "links": { "type": "object", @@ -81451,7 +106245,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user/8f9bfe9d1345237cb3b2b205864da075/createdQuoteComments" + "example": "/user/8f9bfe9d1345237cb3b2b205864da075/updatedIndividualPricings" } } }, @@ -81462,11 +106256,11 @@ "properties": { "type": { "type": "string", - "example": "quote_comment" + "example": "b2b_components_individual_pricing" }, "id": { "type": "string", - "example": "860bc13329c5b039ddeccbd9cced778d" + "example": "c04472254d6a0e3655d277ec6ee53c29" } } } @@ -81568,16 +106362,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -81647,16 +106445,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -81697,10 +106499,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -81726,21 +106530,525 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user-config/4b55408b66d30e27bb1593401072cd70/user" + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "key": { + "description": "Unique key for every userconfig.", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "description": "Password hash for user recovery.", + "type": "string" + }, + "userId": { + "description": "Unique identity of user.", + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "description": "Password hash for user recovery.", + "type": "string" + }, + "userId": { + "description": "Unique identity of user.", + "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" + }, + "WarehouseJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "productWarehouses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/productWarehouses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product_warehouse" + }, + "id": { + "type": "string", + "example": "ff6147ec4fdd4e27441a0439366d0e4d" + } + } + } + } + }, + "type": "object" + }, + "groups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/groups" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse_group" + }, + "id": { + "type": "string", + "example": "1471e4e05a4db95d353cc867fe317314" + } + } + } + } + }, + "type": "object" + }, + "orderProducts": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/orderProducts" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_product_warehouse" + }, + "id": { + "type": "string", + "example": "5b044c586b7768148276b8d5c4ef61b6" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "Warehouse": { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productWarehouses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductWarehouse" + } + }, + "groups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/WarehouseGroup" + } + }, + "orderProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderProductWarehouse" + } + } + }, + "type": "object" + }, + "WarehouseGroupJsonApi": { + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "ruleId": { + "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": { + "rule": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/rule" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "rule" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "981c1e7b3795da18687613fbd66d4954" + } + } + } + }, + "type": "object" + }, + "warehouses": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/warehouses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "warehouse" + }, + "id": { + "type": "string", + "example": "544959798565126142ca2820b4f56271" + } + } + } + } + }, + "type": "object" + }, + "products": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" + }, + "orderWarehouseGroups": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/orderWarehouseGroups" } } }, "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_warehouse_group" + }, + "id": { + "type": "string", + "example": "a578b672a12a5598c96babdfd01f0de2" + } } } } @@ -81755,27 +107063,29 @@ } ] }, - "UserConfig": { - "description": "Added since version: 6.3.5.0", + "WarehouseGroup": { "required": [ "id", - "userId", - "key" + "name" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "userId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "name": { + "type": "string" }, - "key": { + "description": { "type": "string" }, - "value": { - "type": "object" + "priority": { + "type": "integer", + "format": "int64" + }, + "ruleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, "createdAt": { "type": "string", @@ -81787,14 +107097,63 @@ "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "rule": { + "$ref": "#/components/schemas/Rule" + }, + "warehouses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Warehouse" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } + }, + "orderWarehouseGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderWarehouseGroup" + } } }, "type": "object" }, - "UserRecoveryJsonApi": { - "description": "Added since version: 6.0.0.0", + "WarehouseGroupWarehouse": { + "required": [ + "warehouseId", + "warehouseGroupId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "warehouseId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "warehouseGroupId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "priority": { + "type": "integer", + "format": "int64" + }, + "warehouseGroup": { + "$ref": "#/components/schemas/WarehouseGroup" + }, + "warehouse": { + "$ref": "#/components/schemas/Warehouse" + } + }, + "type": "object" + }, + "WebhookJsonApi": { + "description": "Added since version: 6.3.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -81802,18 +107161,36 @@ { "required": [ "id", - "hash", - "userId" + "name", + "eventName", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { + "name": { "type": "string" }, - "userId": { + "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}$" }, @@ -81829,7 +107206,7 @@ }, "relationships": { "properties": { - "user": { + "app": { "properties": { "links": { "type": "object", @@ -81837,7 +107214,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/user-recovery/f451cbc27abefae127822d81c5dbb338/user" + "example": "/webhook/150c7abfca6c489fee5cb82fbb7a9bc4/app" } } }, @@ -81846,12 +107223,12 @@ "properties": { "type": { "type": "string", - "example": "user" + "example": "app" }, "id": { "type": "string", "pattern": "^[0-9a-f]{32}$", - "example": "ee11cbb19052e40b07aac0ca060c23ee" + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } @@ -81866,22 +107243,40 @@ } ] }, - "UserRecovery": { - "description": "Added since version: 6.0.0.0", + "Webhook": { + "description": "Added since version: 6.3.1.0", "required": [ "id", - "hash", - "userId" + "name", + "eventName", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "hash": { + "name": { "type": "string" }, - "userId": { + "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}$" }, @@ -81895,13 +107290,14 @@ "format": "date-time", "readOnly": true }, - "user": { - "$ref": "#/components/schemas/User" + "app": { + "$ref": "#/components/schemas/App" } }, "type": "object" }, - "WarehouseJsonApi": { + "WebhookEventLogJsonApi": { + "description": "Added since version: 6.4.1.0", "allOf": [ { "$ref": "#/components/schemas/resource" @@ -81909,19 +107305,71 @@ { "required": [ "id", - "name" + "webhookName", + "eventName", + "deliveryStatus", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { + "description": "Unique name of app.", "type": "string" }, - "description": { + "webhookName": { + "description": "Unique name of webhook.", + "type": "string" + }, + "eventName": { + "description": "Unique name of event.", + "type": "string" + }, + "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", + "type": "string" + }, + "timestamp": { + "description": "Time at which the event occurred.", + "type": "integer", + "format": "int64" + }, + "processingTime": { + "description": "Time the event took to process.", + "type": "integer", + "format": "int64" + }, + "appVersion": { + "description": "Version of teh app.", + "type": "string" + }, + "requestContent": { + "type": "object" + }, + "responseContent": { + "type": "object" + }, + "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", + "type": "integer", + "format": "int64" + }, + "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, + "url": { + "description": "A URL for the webhook event log.", + "type": "string" + }, + "onlyLiveVersion": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -81932,71 +107380,9 @@ "format": "date-time", "readOnly": true }, - "relationships": { + "extensions": { "properties": { - "productWarehouses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/productWarehouses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product_warehouse" - }, - "id": { - "type": "string", - "example": "ff6147ec4fdd4e27441a0439366d0e4d" - } - } - } - } - }, - "type": "object" - }, - "groups": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/groups" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse_group" - }, - "id": { - "type": "string", - "example": "1471e4e05a4db95d353cc867fe317314" - } - } - } - } - }, - "type": "object" - }, - "orderProducts": { + "flowSequences": { "properties": { "links": { "type": "object", @@ -82004,7 +107390,7 @@ "related": { "type": "string", "format": "uri-reference", - "example": "/warehouse/6416e8cb5fc0a208d94fa7f5a300dbc4/orderProducts" + "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/flowSequences" } } }, @@ -82015,11 +107401,11 @@ "properties": { "type": { "type": "string", - "example": "order_product_warehouse" + "example": "flow_sequence" }, "id": { "type": "string", - "example": "5b044c586b7768148276b8d5c4ef61b6" + "example": "3a0d70b6dd3624074e5e15cd07e7fa90" } } } @@ -82035,22 +107421,75 @@ } ] }, - "Warehouse": { + "WebhookEventLog": { + "description": "Added since version: 6.4.1.0", "required": [ "id", - "name" + "webhookName", + "eventName", + "deliveryStatus", + "url" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "name": { + "appName": { + "description": "Unique name of app.", "type": "string" }, - "description": { + "webhookName": { + "description": "Unique name of webhook.", + "type": "string" + }, + "eventName": { + "description": "Unique name of event.", "type": "string" }, + "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", + "type": "string" + }, + "timestamp": { + "description": "Time at which the event occurred.", + "type": "integer", + "format": "int64" + }, + "processingTime": { + "description": "Time the event took to process.", + "type": "integer", + "format": "int64" + }, + "appVersion": { + "description": "Version of teh app.", + "type": "string" + }, + "requestContent": { + "type": "object" + }, + "responseContent": { + "type": "object" + }, + "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", + "type": "integer", + "format": "int64" + }, + "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", + "type": "string" + }, + "url": { + "description": "A URL for the webhook event log.", + "type": "string" + }, + "onlyLiveVersion": { + "type": "boolean" + }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -82061,678 +107500,1186 @@ "format": "date-time", "readOnly": true }, - "productWarehouses": { + "extensions": { + "properties": { + "flowSequences": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/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" + }, + "infoConfigResponse": { + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Shopware version." + }, + "shopId": { + "type": "string", + "description": "Unique shop identifier." + }, + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." + }, + "adminWorker": { + "type": "object", + "description": "Admin worker feature flags and transport configuration.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." + }, + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", + "deprecated": true + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." + }, + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { + "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." + }, + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." + }, + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + } + }, + "additionalProperties": false + }, + "inAppPurchases": { "type": "array", + "description": "In-app purchase meta data (structure may vary).", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true } - }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" + } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" } + } + } + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "orderProducts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } } } + } + }, + "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" + } }, - "type": "object" + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } }, - "WarehouseGroupJsonApi": { + "OAuthClientCredentialsGrant": { "allOf": [ { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/OAuthGrant" }, { - "required": [ - "id", - "name" - ], + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { + "client_id": { + "description": "OAuth client id.", "type": "string" }, - "description": { + "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" + ] }, - "priority": { - "type": "integer", - "format": "int64" + "scope": { + "$ref": "#/components/schemas/OAuthScopes" }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" }, - "createdAt": { + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "administration" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "scope": { + "$ref": "#/components/schemas/OAuthScopes" }, - "relationships": { - "properties": { - "rule": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/rule" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "rule" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "981c1e7b3795da18687613fbd66d4954" - } - } - } - }, - "type": "object" - }, - "warehouses": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/warehouses" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "warehouse" - }, - "id": { - "type": "string", - "example": "544959798565126142ca2820b4f56271" - } - } - } - } - }, - "type": "object" - }, - "products": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/warehouse-group/de0cc3be51d97f8063ce4c0cb7ba2515/products" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "product" - }, - "id": { - "type": "string", - "example": "86024cad1e83101d97359d7351051156" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" } }, - "type": "object" + "required": [ + "client_id", + "scope", + "refresh_token" + ] } ] }, - "WarehouseGroup": { - "required": [ - "id", - "name" - ], + "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": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" + "page": { + "description": "Search result page", + "type": "integer" }, - "priority": { - "type": "integer", - "format": "int64" + "limit": { + "description": "Number of items per result page", + "type": "integer" }, - "ruleId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "sort": { + "type": "array", + "description": "Sorting in the search result.", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string" + }, + "order": { + "type": "string" + }, + "naturalSorting": { + "type": "boolean" + } + }, + "required": [ + "field" + ] + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "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": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } }, - "rule": { - "$ref": "#/components/schemas/Rule" + "associations": { + "$ref": "#/components/schemas/Associations" }, - "warehouses": { + "aggregations": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/Aggregation" } }, - "products": { + "grouping": { "type": "array", + "description": "Perform groupings over certain fields", "items": { - "$ref": "#/components/schemas/Product" + "type": "string", + "description": "Name of a field" } - } - }, - "type": "object" - }, - "WarehouseGroupWarehouse": { - "required": [ - "warehouseId", - "warehouseGroupId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" }, - "warehouseId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "fields": { + "type": "array", + "description": "Fields which should be returned in the search result.", + "items": { + "type": "string", + "description": "Name of a field" + } }, - "warehouseGroupId": { + "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", - "pattern": "^[0-9a-f]{32}$" + "default": "none", + "enum": [ + "none", + "exact", + "next-pages" + ] }, - "priority": { - "type": "integer", - "format": "int64" + "ids": { + "type": "array", + "description": "List of ids to search for", + "items": { + "type": "string" + } }, - "warehouseGroup": { - "$ref": "#/components/schemas/WarehouseGroup" + "includes": { + "$ref": "#/components/schemas/Includes" }, - "warehouse": { - "$ref": "#/components/schemas/Warehouse" + "excludes": { + "$ref": "#/components/schemas/Excludes" } - }, - "type": "object" + } }, - "WebhookJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ + "Includes": { + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Filters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + }, + "SimpleFilter": { + "anyOf": [ { - "$ref": "#/components/schemas/resource" + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "contains", + "equalsAny", + "prefix", + "suffix" + ] + }, + "field": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "required": [ + "type", + "field", + "value" + ] }, { - "required": [ - "id", - "name", - "eventName", - "url" - ], + "type": "object", "properties": { - "id": { + "type": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" + "enum": [ + "equalsAny", + "equalsAll" + ] }, - "eventName": { + "field": { "type": "string" }, - "url": { + "value": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "type", + "field", + "value" + ] + } + ] + }, + "EqualsFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "equals" + ] + }, + "field": { + "type": "string" + }, + "value": { + "oneOf": [ + { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, - "errorCount": { - "type": "integer", - "format": "int64", - "readOnly": true + { + "type": "number" }, - "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": "null" } - }, - "type": "object" + ] } + }, + "required": [ + "type", + "field", + "value" ] }, - "Webhook": { - "description": "Added since version: 6.3.1.0", - "required": [ - "id", - "name", - "eventName", - "url" - ], + "MultiNotFilter": { + "type": "object", "properties": { - "id": { + "type": { "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enum": [ + "multi", + "not" + ] }, - "name": { - "type": "string" + "operator": { + "type": "string", + "enum": [ + "and", + "or", + "nor", + "nand" + ] }, - "eventName": { - "type": "string" + "queries": { + "$ref": "#/components/schemas/Filters" + } + }, + "required": [ + "type", + "queries" + ] + }, + "RangeFilter": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "range" + ] }, - "url": { + "field": { "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, - "errorCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "active": { - "type": "boolean" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "parameters": { + "type": "object", + "properties": { + "gte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "gt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lte": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + }, + "lt": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "string" + } + ] + } + } + } + }, + "required": [ + "type", + "field", + "parameters" + ] + }, + "Sort": { + "type": "object", + "properties": { + "field": { + "type": "string" }, - "createdAt": { + "order": { "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "ASC", + "DESC" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "naturalSorting": { + "type": "boolean" }, - "app": { - "$ref": "#/components/schemas/App" + "type": { + "type": "string" } }, - "type": "object" + "required": [ + "field", + "order" + ] }, - "WebhookEventLogJsonApi": { - "description": "Added since version: 6.4.1.0", - "allOf": [ + "Associations": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/Criteria" + } + }, + "Aggregation": { + "anyOf": [ { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/AggregationMetrics" }, { - "required": [ - "id", - "webhookName", - "eventName", - "deliveryStatus", - "url" - ], - "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" + "title": "AggregationEntity", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationEntity" }, - "requestContent": { - "type": "object" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationFilter", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationFilter" }, - "responseContent": { - "type": "object" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationTerms", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationTerms" }, - "responseStatusCode": { - "type": "integer", - "format": "int64" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationHistogram", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "responseReasonPhrase": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + }, + { + "title": "AggregationRange", + "allOf": [ + { + "$ref": "#/components/schemas/AggregationRange" }, - "url": { - "type": "string" + { + "$ref": "#/components/schemas/SubAggregations" + } + ] + } + ] + }, + "SubAggregations": { + "type": "object", + "properties": { + "aggregation": { + "anyOf": [ + { + "$ref": "#/components/schemas/AggregationMetrics" }, - "onlyLiveVersion": { - "type": "boolean" + { + "$ref": "#/components/schemas/AggregationEntity" }, - "customFields": { - "type": "object" + { + "$ref": "#/components/schemas/AggregationFilter" }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "$ref": "#/components/schemas/AggregationTerms" }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + { + "$ref": "#/components/schemas/AggregationHistogram" }, - "extensions": { - "properties": { - "flowSequences": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/flowSequences" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + { + "$ref": "#/components/schemas/AggregationRange" } - }, - "type": "object" + ] } - ] + } }, - "WebhookEventLog": { - "description": "Added since version: 6.4.1.0", - "required": [ - "id", - "webhookName", - "eventName", - "deliveryStatus", - "url" - ], + "AggregationEntity": { + "title": "AggregationEntity", + "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "webhookName": { - "type": "string" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "entity" + ] }, - "eventName": { + "field": { + "description": "The field you want to aggregate over.", "type": "string" }, - "deliveryStatus": { + "definition": { + "description": "The entity definition e.g \"product_manufacturer\".", "type": "string" - }, - "timestamp": { - "type": "integer", - "format": "int64" - }, - "processingTime": { - "type": "integer", - "format": "int64" - }, - "appVersion": { + } + }, + "required": [ + "name", + "type", + "field", + "definition" + ] + }, + "AggregationFilter": { + "title": "AggregationFilter", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "requestContent": { - "type": "object" - }, - "responseContent": { - "type": "object" - }, - "responseStatusCode": { - "type": "integer", - "format": "int64" - }, - "responseReasonPhrase": { - "type": "string" + "type": { + "description": "The type of aggregation", + "type": "string", + "enum": [ + "filter" + ] }, - "url": { + "filter": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Filters" + } + } + }, + "required": [ + "name", + "type", + "filter" + ] + }, + "AggregationTerms": { + "title": "AggregationTerms", + "type": "object", + "properties": { + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", "type": "string" }, - "onlyLiveVersion": { - "type": "boolean" - }, - "customFields": { - "type": "object" - }, - "createdAt": { + "type": { + "description": "The type of aggregation", "type": "string", - "format": "date-time", - "readOnly": true + "enum": [ + "terms" + ] }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "extensions": { - "properties": { - "flowSequences": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/webhook-event-log/9a55f6ada630f9af57230d03e40bc8ee/flowSequences" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "flow_sequence" - }, - "id": { - "type": "string", - "example": "3a0d70b6dd3624074e5e15cd07e7fa90" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" + "limit": { + "description": "The number of terms to return", + "type": "number" + }, + "sort": { + "type": "array", + "description": "Sorting the aggregation result.", + "items": { + "$ref": "#/components/schemas/Sort" + } + } + }, + "required": [ + "name", + "type", + "field" + ] + }, + "AggregationHistogram": { + "title": "AggregationHistogram", + "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", + "enum": [ + "histogram" + ] + }, + "field": { + "description": "The field you want to aggregate over.", + "type": "string" + }, + "interval": { + "description": "The interval of the histogram", + "type": "number" + }, + "format": { + "description": "The format of the histogram", + "type": "string" + }, + "timeZone": { + "description": "The timezone of the histogram", + "type": "string" } }, - "type": "object" + "required": [ + "name", + "type", + "field" + ] }, - "infoConfigResponse": { + "AggregationRange": { + "title": "AggregationRange", + "description": "For more information, see [Aggregations Reference > Range Aggregation](https://developer.shopware.com/docs/resources/references/core-reference/dal-reference/aggregations-reference.html#range-aggregations)", "type": "object", "properties": { - "version": { - "type": "string", - "description": "The Shopware version." + "name": { + "description": "Give your aggregation an identifier, so you can find it easier", + "type": "string" }, - "versionRevision": { + "type": { + "description": "The type of aggregation", "type": "string", - "description": "The Shopware version revision." + "enum": [ + "range" + ] }, - "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" - } - } - } + "field": { + "description": "The field you want to aggregate over.", + "type": "string" }, - "bundles": { - "type": "object", - "description": "Asset files of active extensions", - "additionalProperties": { + "ranges": { + "description": "The ranges of the aggregation", + "type": "array", + "items": { "type": "object", - "properties": { - "css": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the css file." - } + "anyOf": [ + { + "type": "object", + "title": "From and to", + "properties": { + "from": { + "type": "number", + "description": "The lower bound of the range" + }, + "to": { + "type": "number", + "description": "The upper bound of the range" + } + }, + "required": [ + "from", + "to" + ] }, - "js": { - "type": "array", - "items": { - "type": "string", - "description": "Url to the js file." - } + { + "type": "object", + "title": "From only", + "properties": { + "from": { + "type": "string", + "description": "The lower bound of the range" + } + }, + "required": [ + "from" + ] + }, + { + "type": "object", + "title": "To only", + "properties": { + "to": { + "type": "string", + "description": "The upper bound of the range" + } + }, + "required": [ + "to" + ] } - } + ] } + } + }, + "required": [ + "name", + "type", + "field", + "ranges" + ] + }, + "AggregationMetrics": { + "type": "object", + "properties": { + "name": { + "type": "string" }, - "settings": { - "type": "object", - "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." - } - } + "type": { + "type": "string", + "enum": [ + "avg", + "count", + "max", + "min", + "stats", + "sum" + ] + }, + "field": { + "type": "string" } - } + }, + "required": [ + "name", + "type", + "field" + ] }, "Price": { "type": "object", @@ -82777,7 +108724,8 @@ }, "required": [ "gross", - "net" + "net", + "linked" ] }, "regulationPrice": { @@ -82803,415 +108751,64 @@ }, "required": [ "gross", - "net" + "net", + "linked" ] } }, "required": [ "currencyId", "gross", - "net" - ] - }, - "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" - } - } - } - }, - "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" - } - } - } - } - }, - "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" + "net", + "linked" ] }, - "OAuthGrant": { + "ConsentState": { "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" + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt" ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scopes": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scopes", - "refresh_token" - ] - } - ] - }, - "Criteria": { - "type": "object", - "description": "Search parameters. For more information, see our documentation on [Search Queries](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#structure)", "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" - ] - } + "name": { + "type": "string", + "description": "The name of the consent" }, - "grouping": { - "type": "array", - "description": "Perform groupings over certain fields", - "items": { - "type": "string", - "description": "Name of a field" - } + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" }, - "fields": { - "type": "array", - "description": "Fields which should be returned in the search result.", - "items": { - "type": "string", - "description": "Name of a field" - } + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" }, - "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)", + "status": { "type": "string", - "default": "none", "enum": [ - "none", - "exact", - "next-pages" - ] - } - } - }, - "CustomPricingPrice": { - "type": "object", - "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", - "required": [ - "quantityStart", - "price" - ], - "properties": { - "quantityStart": { - "type": "integer", - "format": "int64" + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" }, - "quantityEnd": { - "type": "integer", - "format": "int64", - "minimum": 1 + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" }, - "price": { - "type": "array", - "items": { - "type": "object", - "description": "This field should house all the normal facets of the `product_price`.`price` column", - "required": [ - "currencyId", - "gross", - "net", - "linked" - ], - "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - }, - "listPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - }, - "regulationPrice": { - "type": "object", - "properties": { - "gross": { - "type": "number", - "minimum": 0 - }, - "net": { - "type": "number", - "minimum": 0 - }, - "linked": { - "type": "boolean" - } - } - } - } - } + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" } } }, @@ -83324,6 +108921,87 @@ } } }, + "CustomPricingPrice": { + "type": "object", + "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", + "required": [ + "quantityStart", + "price" + ], + "properties": { + "quantityStart": { + "type": "integer", + "format": "int64" + }, + "quantityEnd": { + "type": "integer", + "format": "int64", + "minimum": 1 + }, + "price": { + "type": "array", + "items": { + "type": "object", + "description": "This field should house all the normal facets of the `product_price`.`price` column", + "required": [ + "currencyId", + "gross", + "net", + "linked" + ], + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + }, + "listPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + }, + "regulationPrice": { + "type": "object", + "properties": { + "gross": { + "type": "number", + "minimum": 0 + }, + "net": { + "type": "number", + "minimum": 0 + }, + "linked": { + "type": "boolean" + } + } + } + } + } + } + } + }, "CustomPricingResponse": { "type": "object", "required": [ @@ -83376,6 +109054,271 @@ } } } + }, + "Options": { + "type": "object", + "properties": { + "mood": { + "type": "string", + "enum": [ + "positive", + "neutral" + ], + "description": "Tone/mood to guide summary generation (optional)." + }, + "productId": { + "type": "string", + "description": "Product UUID (hex) identifying the product to generate summaries for. This field is required." + }, + "salesChannelId": { + "type": "string", + "description": "Sales channel UUID (hex) used to scope generation and locale/context resolution. This field is required." + }, + "languageIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of language UUIDs (hex). Provided language IDs will be mapped to locale codes server-side; supply this OR `locales`." + }, + "locales": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of locale codes (e.g. `de-DE`, `en-GB`). Supply this OR `languageIds`. At least one of `languageIds` or `locales` must be present." + }, + "length": { + "type": "integer", + "description": "Desired length of the generated summary in number of characters (optional, default: 300)." + }, + "reviews": { + "type": "array", + "items": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "content": { + "type": "string" + }, + "points": { + "type": "string" + } + }, + "required": [ + "title", + "content", + "points" + ], + "description": "Array of review objects containing title, content, and points (optional, if not provided, reviews will be fetched from product)." + } + } + }, + "required": [ + "productId", + "salesChannelId" + ], + "anyOf": [ + { + "required": [ + "languageIds" + ] + }, + { + "required": [ + "locales" + ] + } + ], + "additionalProperties": true, + "description": "Options object passed to Review Summary generation." + }, + "ReviewSummaryItem": { + "type": "object", + "properties": { + "languageId": { + "type": "string" + }, + "summary": { + "type": "string" + } + }, + "additionalProperties": true + }, + "ReviewSummaryByLanguage": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "Generated summary for the language id" + }, + "description": "Map of languageId to generated summary string." + }, + "BundleItemProduct": { + "type": "object", + "required": [ + "id", + "productNumber" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "productNumber": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "apiAlias": { + "type": "string", + "readOnly": true + } + } + }, + "BundleProductWrite": { + "type": "object", + "required": [ + "name", + "bundleItems" + ], + "properties": { + "productNumber": { + "type": "string", + "description": "Optional. Omit to let the server reserve a number." + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "coverId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "bundleItems": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleItem" + }, + "minItems": 2 + }, + "bundleDiscounts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BundleDiscount" + } + }, + "visibilities": { + "type": "array", + "items": { + "type": "object", + "required": [ + "salesChannelId" + ], + "properties": { + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "type": "integer", + "enum": [ + 1, + 2, + 3 + ] + } + } + } + }, + "customFields": { + "type": "object" + } + } + }, + "BundleProduct": { + "allOf": [ + { + "$ref": "#/components/schemas/BundleProductWrite" + }, + { + "type": "object", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "active": { + "type": "boolean" + }, + "available": { + "type": "boolean" + }, + "description": { + "type": "string" + }, + "price": { + "type": "array", + "items": { + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "net": { + "type": "number" + }, + "gross": { + "type": "number" + }, + "linked": { + "type": "boolean" + } + } + } + }, + "stock": { + "type": "integer" + }, + "sales": { + "type": "integer" + }, + "customSearchKeywords": { + "type": "array", + "items": { + "type": "string" + } + }, + "cover": { + "type": "object" + }, + "media": { + "type": "array", + "items": { + "type": "object" + } + }, + "apiAlias": { + "type": "string", + "readOnly": true + } + } + } + ] } }, "responses": { @@ -83707,12 +109650,13 @@ "securitySchemes": { "oAuth": { "type": "oauth2", - "description": "Authentication API", + "description": "Authentication using OAuth 2.0", "flows": { "password": { - "tokenUrl": "http://localhost:8000/api/oauth/token", + "tokenUrl": "/api/oauth/token", "scopes": { - "write": "Full write access" + "write": "Full write access", + "admin": "Admin scope for administrative operations" } }, "clientCredentials": { @@ -83738,7 +109682,7 @@ "description": "Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "externalDocs": { "description": "Find out more", - "url": "https://github.com/shopware/platform/blob/trunk/adr/2023-05-10-experimental-features.md" + "url": "https://github.com/shopware/shopware/blob/trunk/adr/2023-05-10-experimental-features.md" } }, { @@ -83817,6 +109761,10 @@ "name": "B2b Business Partner", "description": "The endpoint for operations on B2b Business Partner" }, + { + "name": "B2b Components Advanced Product Catalogs", + "description": "The endpoint for operations on B2b Components Advanced Product Catalogs" + }, { "name": "B2b Components Approval Rule", "description": "The endpoint for operations on B2b Components Approval Rule" @@ -83825,6 +109773,42 @@ "name": "B2b Components Approval Rule App Script Condition", "description": "The endpoint for operations on B2b Components Approval Rule App Script Condition" }, + { + "name": "B2b Components Budget", + "description": "The endpoint for operations on B2b Components Budget" + }, + { + "name": "B2b Components Employee Wishlist", + "description": "The endpoint for operations on B2b Components Employee Wishlist" + }, + { + "name": "B2b Components Employee Wishlist Product", + "description": "The endpoint for operations on B2b Components Employee Wishlist Product" + }, + { + "name": "B2b Components Individual Pricing", + "description": "The endpoint for operations on B2b Components Individual Pricing" + }, + { + "name": "B2b Components Individual Pricing Company Assignment", + "description": "The endpoint for operations on B2b Components Individual Pricing Company Assignment" + }, + { + "name": "B2b Components Individual Pricing Computed Cache", + "description": "The endpoint for operations on B2b Components Individual Pricing Computed Cache" + }, + { + "name": "B2b Components Individual Pricing Tier", + "description": "The endpoint for operations on B2b Components Individual Pricing Tier" + }, + { + "name": "B2b Components Organization", + "description": "The endpoint for operations on B2b Components Organization" + }, + { + "name": "B2b Components Organization Customer Address", + "description": "The endpoint for operations on B2b Components Organization Customer Address" + }, { "name": "B2b Components Pending Order", "description": "The endpoint for operations on B2b Components Pending Order" @@ -83845,6 +109829,10 @@ "name": "B2b Components Shopping List Line Item", "description": "The endpoint for operations on B2b Components Shopping List Line Item" }, + { + "name": "B2b Components Subscription Employee", + "description": "The endpoint for operations on B2b Components Subscription Employee" + }, { "name": "B2b Employee", "description": "The endpoint for operations on B2b Employee" @@ -83857,6 +109845,18 @@ "name": "B2b Permission", "description": "The endpoint for operations on B2b Permission" }, + { + "name": "Product", + "description": "The endpoint for operations on Product" + }, + { + "name": "Bundle Discount", + "description": "The endpoint for operations on Bundle Discount" + }, + { + "name": "Bundle Item", + "description": "The endpoint for operations on Bundle Item" + }, { "name": "Category", "description": "The endpoint for operations on Category" @@ -84021,6 +110021,14 @@ "name": "Main Category", "description": "The endpoint for operations on Main Category" }, + { + "name": "Measurement Display Unit", + "description": "The endpoint for operations on Measurement Display Unit" + }, + { + "name": "Measurement System", + "description": "The endpoint for operations on Measurement System" + }, { "name": "Media", "description": "The endpoint for operations on Media" @@ -84365,14 +110373,26 @@ "name": "Spatial Scene Camera", "description": "The endpoint for operations on Spatial Scene Camera" }, + { + "name": "Spatial Scene Group", + "description": "The endpoint for operations on Spatial Scene Group" + }, { "name": "Spatial Scene Light", "description": "The endpoint for operations on Spatial Scene Light" }, + { + "name": "Spatial Scene Material", + "description": "The endpoint for operations on Spatial Scene Material" + }, { "name": "Spatial Scene Object", "description": "The endpoint for operations on Spatial Scene Object" }, + { + "name": "Spatial Scene Primitive", + "description": "The endpoint for operations on Spatial Scene Primitive" + }, { "name": "Sso Provider", "description": "The endpoint for operations on Sso Provider" diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index d67a1bc..2d52c32 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -11,7 +11,6 @@ "/_action/share-config/upload/{entity}", "/_action/text-to-image/generate", "/_action/update-employee", - "/_action/validation/email", "/_proxy-quote/{salesChannelId}", "/advanced-search-action", "/advanced-search-action-search-term", @@ -59,6 +58,8 @@ "/aggregate/b2b-employee", "/aggregate/b2b-order-employee", "/aggregate/b2b-permission", + "/aggregate/bundle-discount", + "/aggregate/bundle-item", "/aggregate/custom-price", "/aggregate/customer-specific-features", "/aggregate/media-ai-tag", @@ -141,6 +142,10 @@ "/b2b-order-employee/{id}", "/b2b-permission", "/b2b-permission/{id}", + "/bundle-discount", + "/bundle-discount/{id}", + "/bundle-item", + "/bundle-item/{id}", "/custom-price", "/custom-price/{id}", "/customer-specific-features", @@ -157,6 +162,11 @@ "/order-return/{id}", "/order-warehouse-group", "/order-warehouse-group/{id}", + "/product-bundle", + "/product-bundle/search", + "/product-bundle/search-ids", + "/product-bundle/{id}", + "/product-bundle/{id}/clone", "/product-review-summary", "/product-review-summary/{id}", "/product-warehouse", @@ -207,6 +217,8 @@ "/search/b2b-employee", "/search/b2b-order-employee", "/search/b2b-permission", + "/search/bundle-discount", + "/search/bundle-item", "/search/custom-price", "/search/customer-specific-features", "/search/media-ai-tag", @@ -379,6 +391,15 @@ "B2bOrderEmployeeJsonApi", "B2bPermission", "B2bPermissionJsonApi", + "BundleDiscount", + "BundleDiscountJsonApi", + "BundleDiscountRule", + "BundleItem", + "BundleItemJsonApi", + "BundleItemProduct", + "BundleProduct", + "BundleProductWrite", + "BundleVisibility", "Category", "CategoryJsonApi", "CategoryTag", @@ -442,7 +463,6 @@ "DocumentTypeJsonApi", "EqualsFilter", "Excludes", - "ExternalThumbnail", "Filters", "Flow", "FlowJsonApi", @@ -494,7 +514,6 @@ "MediaFolderConfigurationJsonApi", "MediaFolderConfigurationMediaThumbnailSize", "MediaFolderJsonApi", - "MediaId", "MediaJsonApi", "MediaTag", "MediaThumbnail", From f4e072ff40c289e68a5acbd4171f86649252d0f2 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Mar 2026 12:00:29 +0200 Subject: [PATCH 55/63] [create-pull-request] automated change (#464) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 40439 +++++++----------- SwagDigitalSalesRooms-adminapi.summary.json | 144 +- 2 files changed, 16188 insertions(+), 24395 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index f723eb3..630decb 100644 --- a/SwagDigitalSalesRooms-adminapi.json +++ b/SwagDigitalSalesRooms-adminapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.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`.", @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.10.4" + "version": "6.7.8.2" }, "servers": [ { @@ -15,38 +15,43 @@ } ], "paths": { - "/aggregate/acl-role": { - "post": { + "/dsr-appointment": { + "get": { "tags": [ - "Acl Role" + "Dsr Appointment" ], - "summary": "Aggregate for the Acl Role resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAclRole", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Dsr Appointment resources.", + "description": "", + "operationId": "getDsrAppointmentList", + "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 AclRole", + "description": "List of Dsr Appointment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -58,10 +63,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AclRole" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointment" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment?limit=25" + }, + "last": { + "example": "/dsr-appointment?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment?limit=25&page=2" + } + } + } + ] } } } @@ -78,7 +114,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AclRole" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -86,47 +122,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/app": { + }, "post": { "tags": [ - "App" + "Dsr Appointment" + ], + "summary": "Create a new Dsr Appointment resources.", + "description": "", + "operationId": "createDsrAppointment", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the App resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateApp", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "List of App", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -138,10 +171,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/App" - } + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -151,15 +181,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/App" - } + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -175,38 +202,42 @@ } } }, - "/aggregate/app-action-button": { + "/search/dsr-appointment": { "post": { "tags": [ - "App Action Button" + "Dsr Appointment" + ], + "summary": "Search for the Dsr Appointment resources.", + "description": "", + "operationId": "searchDsrAppointment", + "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" + } + } ], - "summary": "Aggregate for the App Action Button resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppActionButton", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of AppActionButton", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -220,7 +251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppActionButton" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -238,7 +269,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppActionButton" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -255,38 +286,29 @@ } } }, - "/aggregate/app-administration-snippet": { - "post": { + "/dsr-appointment/{id}": { + "get": { "tags": [ - "App Administration Snippet" + "Dsr Appointment" ], - "summary": "Aggregate for the App Administration Snippet resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppAdministrationSnippet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Dsr Appointment resource.", + "description": "", + "operationId": "getDsrAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of AppAdministrationSnippet", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -298,10 +320,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -311,62 +330,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppAdministrationSnippet" - } + "$ref": "#/components/schemas/DsrAppointment" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/app-cms-block": { - "post": { + }, + "delete": { "tags": [ - "App Cms Block" + "Dsr Appointment" + ], + "summary": "Delete a Dsr Appointment resource.", + "description": "", + "operationId": "deleteDsrAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment" + ], + "summary": "Partially update information about a Dsr Appointment resource.", + "description": "", + "operationId": "updateDsrAppointment", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } ], - "summary": "Aggregate for the App Cms Block resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppCmsBlock", "requestBody": { - "required": true, + "description": "Partially update information about a Dsr Appointment resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointment" } } } }, "responses": { "200": { - "description": "List of AppCmsBlock", + "description": "Detail of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -378,10 +442,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -391,15 +452,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppCmsBlock" - } + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -409,20 +467,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/app-flow-action": { + "/aggregate/dsr-appointment": { "post": { "tags": [ - "App Flow Action" + "Dsr Appointment" ], - "summary": "Aggregate for the App Flow Action resources.", + "summary": "Aggregate for the Dsr Appointment resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppFlowAction", + "operationId": "aggregateDsrAppointment", "requestBody": { "required": true, "content": { @@ -446,7 +507,7 @@ }, "responses": { "200": { - "description": "List of AppFlowAction", + "description": "List of DsrAppointment", "content": { "application/vnd.api+json": { "schema": { @@ -460,7 +521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppFlowAction" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -478,7 +539,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppFlowAction" + "$ref": "#/components/schemas/DsrAppointment" } } } @@ -495,38 +556,43 @@ } } }, - "/aggregate/app-flow-event": { - "post": { + "/dsr-appointment-attendee": { + "get": { "tags": [ - "App Flow Event" + "Dsr Appointment Attendee" ], - "summary": "Aggregate for the App Flow Event resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppFlowEvent", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Dsr Appointment Attendee resources.", + "description": "", + "operationId": "getDsrAppointmentAttendeeList", + "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 AppFlowEvent", + "description": "List of Dsr Appointment Attendee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -538,10 +604,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppFlowEvent" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentAttendee" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-attendee?limit=25" + }, + "last": { + "example": "/dsr-appointment-attendee?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-attendee?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-attendee?limit=25&page=2" + } + } + } + ] } } } @@ -558,7 +655,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppFlowEvent" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -566,47 +663,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/app-payment-method": { + }, "post": { "tags": [ - "App Payment Method" + "Dsr Appointment Attendee" + ], + "summary": "Create a new Dsr Appointment Attendee resources.", + "description": "", + "operationId": "createDsrAppointmentAttendee", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the App Payment Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppPaymentMethod", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "List of AppPaymentMethod", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -618,10 +712,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -631,15 +722,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppPaymentMethod" - } + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -655,38 +743,42 @@ } } }, - "/aggregate/app-script-condition": { + "/search/dsr-appointment-attendee": { "post": { "tags": [ - "App Script Condition" + "Dsr Appointment Attendee" + ], + "summary": "Search for the Dsr Appointment Attendee resources.", + "description": "", + "operationId": "searchDsrAppointmentAttendee", + "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" + } + } ], - "summary": "Aggregate for the App Script Condition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppScriptCondition", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of AppScriptCondition", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -700,7 +792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppScriptCondition" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -718,7 +810,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/AppScriptCondition" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -735,38 +827,29 @@ } } }, - "/aggregate/app-shipping-method": { - "post": { + "/dsr-appointment-attendee/{id}": { + "get": { "tags": [ - "App Shipping Method" + "Dsr Appointment Attendee" ], - "summary": "Aggregate for the App Shipping Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppShippingMethod", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "getDsrAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of AppShippingMethod", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -778,10 +861,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -791,62 +871,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppShippingMethod" - } + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/app-template": { - "post": { + }, + "delete": { "tags": [ - "App Template" + "Dsr Appointment Attendee" + ], + "summary": "Delete a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "deleteDsrAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment Attendee" + ], + "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "", + "operationId": "updateDsrAppointmentAttendee", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_attendee", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } ], - "summary": "Aggregate for the App Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateAppTemplate", "requestBody": { - "required": true, + "description": "Partially update information about a Dsr Appointment Attendee resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } }, "responses": { "200": { - "description": "List of AppTemplate", + "description": "Detail of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -858,10 +983,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -871,15 +993,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AppTemplate" - } + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -889,20 +1008,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/category": { + "/aggregate/dsr-appointment-attendee": { "post": { "tags": [ - "Category" + "Dsr Appointment Attendee" ], - "summary": "Aggregate for the Category resources.", + "summary": "Aggregate for the Dsr Appointment Attendee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateCategory", + "operationId": "aggregateDsrAppointmentAttendee", "requestBody": { "required": true, "content": { @@ -926,7 +1048,7 @@ }, "responses": { "200": { - "description": "List of Category", + "description": "List of DsrAppointmentAttendee", "content": { "application/vnd.api+json": { "schema": { @@ -940,7 +1062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -958,7 +1080,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/DsrAppointmentAttendee" } } } @@ -975,38 +1097,43 @@ } } }, - "/aggregate/cms-block": { - "post": { + "/dsr-appointment-request": { + "get": { "tags": [ - "Cms Block" + "Dsr Appointment Request" ], - "summary": "Aggregate for the Cms Block resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsBlock", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Dsr Appointment Request resources.", + "description": "", + "operationId": "getDsrAppointmentRequestList", + "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 CmsBlock", + "description": "List of Dsr Appointment Request resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1018,10 +1145,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentRequest" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-request?limit=25" + }, + "last": { + "example": "/dsr-appointment-request?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-request?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-request?limit=25&page=2" + } + } + } + ] } } } @@ -1038,7 +1196,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsBlock" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1046,47 +1204,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/cms-page": { + }, "post": { "tags": [ - "Cms Page" + "Dsr Appointment Request" + ], + "summary": "Create a new Dsr Appointment Request resources.", + "description": "", + "operationId": "createDsrAppointmentRequest", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the Cms Page resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsPage", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "List of CmsPage", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1098,10 +1253,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsPage" - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1111,15 +1263,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsPage" - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1135,38 +1284,42 @@ } } }, - "/aggregate/cms-section": { + "/search/dsr-appointment-request": { "post": { "tags": [ - "Cms Section" + "Dsr Appointment Request" + ], + "summary": "Search for the Dsr Appointment Request resources.", + "description": "", + "operationId": "searchDsrAppointmentRequest", + "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" + } + } ], - "summary": "Aggregate for the Cms Section resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsSection", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of CmsSection", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1180,7 +1333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1198,7 +1351,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CmsSection" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1215,38 +1368,29 @@ } } }, - "/aggregate/cms-slot": { - "post": { + "/dsr-appointment-request/{id}": { + "get": { "tags": [ - "Cms Slot" + "Dsr Appointment Request" ], - "summary": "Aggregate for the Cms Slot resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCmsSlot", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "getDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of CmsSlot", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1258,10 +1402,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1271,62 +1412,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSlot" - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/country": { - "post": { + }, + "delete": { "tags": [ - "Country" + "Dsr Appointment Request" + ], + "summary": "Delete a Dsr Appointment Request resource.", + "description": "", + "operationId": "deleteDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "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": [ + "Dsr Appointment Request" + ], + "summary": "Partially update information about a Dsr Appointment Request resource.", + "description": "", + "operationId": "updateDsrAppointmentRequest", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_request", + "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" + } + } ], - "summary": "Aggregate for the Country resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCountry", "requestBody": { - "required": true, + "description": "Partially update information about a Dsr Appointment Request resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } }, "responses": { "200": { - "description": "List of Country", + "description": "Detail of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1338,10 +1524,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1351,15 +1534,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Country" - } + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1369,20 +1549,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/country-state": { + "/aggregate/dsr-appointment-request": { "post": { "tags": [ - "Country State" + "Dsr Appointment Request" ], - "summary": "Aggregate for the Country State resources.", + "summary": "Aggregate for the Dsr Appointment Request resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateCountryState", + "operationId": "aggregateDsrAppointmentRequest", "requestBody": { "required": true, "content": { @@ -1406,7 +1589,7 @@ }, "responses": { "200": { - "description": "List of CountryState", + "description": "List of DsrAppointmentRequest", "content": { "application/vnd.api+json": { "schema": { @@ -1420,7 +1603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1438,7 +1621,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CountryState" + "$ref": "#/components/schemas/DsrAppointmentRequest" } } } @@ -1455,38 +1638,43 @@ } } }, - "/aggregate/currency": { - "post": { + "/dsr-appointment-video-chat": { + "get": { "tags": [ - "Currency" + "Dsr Appointment Video Chat" ], - "summary": "Aggregate for the Currency resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCurrency", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "getDsrAppointmentVideoChatList", + "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 Currency", + "description": "List of Dsr Appointment Video Chat resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1498,10 +1686,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Currency" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAppointmentVideoChat" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-appointment-video-chat?limit=25" + }, + "last": { + "example": "/dsr-appointment-video-chat?limit=25&page=11" + }, + "next": { + "example": "/dsr-appointment-video-chat?limit=25&page=4" + }, + "prev": { + "example": "/dsr-appointment-video-chat?limit=25&page=2" + } + } + } + ] } } } @@ -1518,7 +1737,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1526,47 +1745,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/currency-country-rounding": { + }, "post": { "tags": [ - "Currency Country Rounding" + "Dsr Appointment Video Chat" + ], + "summary": "Create a new Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "createDsrAppointmentVideoChat", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the Currency Country Rounding resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCurrencyCountryRounding", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "List of CurrencyCountryRounding", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1578,10 +1794,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1591,15 +1804,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CurrencyCountryRounding" - } + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1615,38 +1825,42 @@ } } }, - "/aggregate/custom-entity": { + "/search/dsr-appointment-video-chat": { "post": { "tags": [ - "Custom Entity" + "Dsr Appointment Video Chat" + ], + "summary": "Search for the Dsr Appointment Video Chat resources.", + "description": "", + "operationId": "searchDsrAppointmentVideoChat", + "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" + } + } ], - "summary": "Aggregate for the Custom Entity resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomEntity", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of CustomEntity", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1660,7 +1874,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1678,7 +1892,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomEntity" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1695,38 +1909,29 @@ } } }, - "/aggregate/custom-field": { - "post": { + "/dsr-appointment-video-chat/{id}": { + "get": { "tags": [ - "Custom Field" + "Dsr Appointment Video Chat" ], - "summary": "Aggregate for the Custom Field resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomField", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "getDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of CustomField", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1738,10 +1943,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1751,62 +1953,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomField" - } + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/custom-field-set": { - "post": { + }, + "delete": { "tags": [ - "Custom Field Set" + "Dsr Appointment Video Chat" + ], + "summary": "Delete a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "deleteDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Appointment Video Chat" + ], + "summary": "Partially update information about a Dsr Appointment Video Chat resource.", + "description": "", + "operationId": "updateDsrAppointmentVideoChat", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_appointment_video_chat", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } ], - "summary": "Aggregate for the Custom Field Set resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomFieldSet", "requestBody": { - "required": true, + "description": "Partially update information about a Dsr Appointment Video Chat resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } }, "responses": { "200": { - "description": "List of CustomFieldSet", + "description": "Detail of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1818,10 +2065,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1831,15 +2075,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomFieldSet" - } + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1849,20 +2090,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/custom-field-set-relation": { + "/aggregate/dsr-appointment-video-chat": { "post": { "tags": [ - "Custom Field Set Relation" + "Dsr Appointment Video Chat" ], - "summary": "Aggregate for the Custom Field Set Relation resources.", + "summary": "Aggregate for the Dsr Appointment Video Chat resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomFieldSetRelation", + "operationId": "aggregateDsrAppointmentVideoChat", "requestBody": { "required": true, "content": { @@ -1886,7 +2130,7 @@ }, "responses": { "200": { - "description": "List of CustomFieldSetRelation", + "description": "List of DsrAppointmentVideoChat", "content": { "application/vnd.api+json": { "schema": { @@ -1900,7 +2144,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1918,7 +2162,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomFieldSetRelation" + "$ref": "#/components/schemas/DsrAppointmentVideoChat" } } } @@ -1935,38 +2179,43 @@ } } }, - "/aggregate/customer": { - "post": { + "/dsr-attendee-product-collection": { + "get": { "tags": [ - "Customer" + "Dsr Attendee Product Collection" ], - "summary": "Aggregate for the Customer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "getDsrAttendeeProductCollectionList", + "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 Customer", + "description": "List of Dsr Attendee Product Collection resources.", "content": { "application/vnd.api+json": { "schema": { @@ -1978,10 +2227,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Customer" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrAttendeeProductCollection" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-attendee-product-collection?limit=25" + }, + "last": { + "example": "/dsr-attendee-product-collection?limit=25&page=11" + }, + "next": { + "example": "/dsr-attendee-product-collection?limit=25&page=4" + }, + "prev": { + "example": "/dsr-attendee-product-collection?limit=25&page=2" + } + } + } + ] } } } @@ -1998,7 +2278,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Customer" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2006,47 +2286,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/customer-address": { + }, "post": { "tags": [ - "Customer Address" + "Dsr Attendee Product Collection" + ], + "summary": "Create a new Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "createDsrAttendeeProductCollection", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the Customer Address resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerAddress", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "List of CustomerAddress", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2058,10 +2335,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2071,15 +2345,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerAddress" - } + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2095,38 +2366,42 @@ } } }, - "/aggregate/customer-group": { + "/search/dsr-attendee-product-collection": { "post": { "tags": [ - "Customer Group" + "Dsr Attendee Product Collection" + ], + "summary": "Search for the Dsr Attendee Product Collection resources.", + "description": "", + "operationId": "searchDsrAttendeeProductCollection", + "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" + } + } ], - "summary": "Aggregate for the Customer Group resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerGroup", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of CustomerGroup", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2140,7 +2415,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2158,7 +2433,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2175,38 +2450,29 @@ } } }, - "/aggregate/customer-recovery": { - "post": { + "/dsr-attendee-product-collection/{id}": { + "get": { "tags": [ - "Customer Recovery" + "Dsr Attendee Product Collection" ], - "summary": "Aggregate for the Customer Recovery resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerRecovery", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "getDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of CustomerRecovery", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2218,10 +2484,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2231,62 +2494,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerRecovery" - } + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/customer-wishlist": { - "post": { + }, + "delete": { "tags": [ - "Customer Wishlist" + "Dsr Attendee Product Collection" + ], + "summary": "Delete a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "deleteDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + }, + "patch": { + "tags": [ + "Dsr Attendee Product Collection" + ], + "summary": "Partially update information about a Dsr Attendee Product Collection resource.", + "description": "", + "operationId": "updateDsrAttendeeProductCollection", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_attendee_product_collection", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "allowEmptyValue": true, + "schema": { + "type": "string" + } + } ], - "summary": "Aggregate for the Customer Wishlist resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerWishlist", "requestBody": { - "required": true, + "description": "Partially update information about a Dsr Attendee Product Collection resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } }, "responses": { "200": { - "description": "List of CustomerWishlist", + "description": "Detail of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2298,10 +2606,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2311,15 +2616,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlist" - } + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2329,20 +2631,23 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/aggregate/customer-wishlist-product": { + "/aggregate/dsr-attendee-product-collection": { "post": { "tags": [ - "Customer Wishlist Product" + "Dsr Attendee Product Collection" ], - "summary": "Aggregate for the Customer Wishlist Product resources.", + "summary": "Aggregate for the Dsr Attendee Product Collection resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateCustomerWishlistProduct", + "operationId": "aggregateDsrAttendeeProductCollection", "requestBody": { "required": true, "content": { @@ -2366,7 +2671,7 @@ }, "responses": { "200": { - "description": "List of CustomerWishlistProduct", + "description": "List of DsrAttendeeProductCollection", "content": { "application/vnd.api+json": { "schema": { @@ -2380,7 +2685,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2398,7 +2703,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" + "$ref": "#/components/schemas/DsrAttendeeProductCollection" } } } @@ -2415,38 +2720,43 @@ } } }, - "/aggregate/delivery-time": { - "post": { + "/dsr-cms-slide": { + "get": { "tags": [ - "Delivery Time" + "Dsr Cms Slide" ], - "summary": "Aggregate for the Delivery Time resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDeliveryTime", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "List with basic information of Dsr Cms Slide resources.", + "description": "", + "operationId": "getDsrCmsSlideList", + "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 DeliveryTime", + "description": "List of Dsr Cms Slide resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2458,10 +2768,41 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DeliveryTime" - } + "allOf": [ + { + "$ref": "#/components/schemas/data" + }, + { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + ] + }, + "links": { + "allOf": [ + { + "$ref": "#/components/schemas/pagination" + }, + { + "type": "object", + "properties": { + "first": { + "example": "/dsr-cms-slide?limit=25" + }, + "last": { + "example": "/dsr-cms-slide?limit=25&page=11" + }, + "next": { + "example": "/dsr-cms-slide?limit=25&page=4" + }, + "prev": { + "example": "/dsr-cms-slide?limit=25&page=2" + } + } + } + ] } } } @@ -2478,7 +2819,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2486,47 +2827,44 @@ } } }, - "400": { - "$ref": "#/components/responses/400" - }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/document": { + }, "post": { "tags": [ - "Document" + "Dsr Cms Slide" + ], + "summary": "Create a new Dsr Cms Slide resources.", + "description": "", + "operationId": "createDsrCmsSlide", + "parameters": [ + { + "name": "_response", + "in": "query", + "description": "Data format for response. Empty if none is provided.", + "schema": { + "type": "string", + "enum": [ + "basic", + "detail" + ] + } + } ], - "summary": "Aggregate for the Document resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocument", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "List of Document", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2538,10 +2876,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2551,15 +2886,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Document" - } + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2575,38 +2907,42 @@ } } }, - "/aggregate/document-base-config": { + "/search/dsr-cms-slide": { "post": { "tags": [ - "Document Base Config" + "Dsr Cms Slide" + ], + "summary": "Search for the Dsr Cms Slide resources.", + "description": "", + "operationId": "searchDsrCmsSlide", + "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" + } + } ], - "summary": "Aggregate for the Document Base Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocumentBaseConfig", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/Criteria" } } } }, "responses": { "200": { - "description": "List of DocumentBaseConfig", + "description": "List of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2620,7 +2956,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2638,7 +2974,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentBaseConfig" + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2655,38 +2991,29 @@ } } }, - "/aggregate/document-base-config-sales-channel": { - "post": { + "/dsr-cms-slide/{id}": { + "get": { "tags": [ - "Document Base Config Sales Channel" + "Dsr Cms Slide" ], - "summary": "Aggregate for the Document Base Config Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocumentBaseConfigSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Detailed information about a Dsr Cms Slide resource.", + "description": "", + "operationId": "getDsrCmsSlide", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_cms_slide", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DocumentBaseConfigSalesChannel", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2698,10 +3025,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2711,62 +3035,107 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" - } + "$ref": "#/components/schemas/DsrCmsSlide" } } } } } }, - "400": { - "$ref": "#/components/responses/400" + "404": { + "$ref": "#/components/responses/404" }, "401": { "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/document-type": { - "post": { + }, + "delete": { "tags": [ - "Document Type" + "Dsr Cms Slide" + ], + "summary": "Delete a Dsr Cms Slide resource.", + "description": "", + "operationId": "deleteDsrCmsSlide", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_cms_slide", + "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": [ + "Dsr Cms Slide" + ], + "summary": "Partially update information about a Dsr Cms Slide resource.", + "description": "", + "operationId": "updateDsrCmsSlide", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Identifier for the dsr_cms_slide", + "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" + } + } ], - "summary": "Aggregate for the Document Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDocumentType", "requestBody": { - "required": true, + "description": "Partially update information about a Dsr Cms Slide resource.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/DsrCmsSlide" } } } }, "responses": { "200": { - "description": "List of DocumentType", + "description": "Detail of DsrCmsSlide", "content": { "application/vnd.api+json": { "schema": { @@ -2778,10 +3147,7 @@ "type": "object", "properties": { "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2791,15 +3157,12 @@ "application/json": { "schema": { "type": "object", + "required": [ + "data" + ], "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentType" - } + "$ref": "#/components/schemas/DsrCmsSlide" } } } @@ -2809,20 +3172,103 @@ "400": { "$ref": "#/components/responses/400" }, + "404": { + "$ref": "#/components/responses/404" + }, "401": { "$ref": "#/components/responses/401" } } } }, - "/dsr-appointment": { + "/aggregate/dsr-cms-slide": { + "post": { + "tags": [ + "Dsr Cms Slide" + ], + "summary": "Aggregate for the Dsr Cms Slide resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateDsrCmsSlide", + "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 DsrCmsSlide", + "content": { + "application/vnd.api+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/success" + }, + { + "type": "object", + "properties": { + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + ] + } + }, + "application/json": { + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer" + }, + "data": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DsrCmsSlide" + } + } + } + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + } + } + } + }, + "/dsr-interaction": { "get": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "List with basic information of Dsr Appointment resources.", + "summary": "List with basic information of Dsr Interaction resources.", "description": "", - "operationId": "getDsrAppointmentList", + "operationId": "getDsrInteractionList", "parameters": [ { "name": "limit", @@ -2851,7 +3297,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment resources.", + "description": "List of Dsr Interaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -2870,7 +3316,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } ] @@ -2884,16 +3330,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment?limit=25" + "example": "/dsr-interaction?limit=25" }, "last": { - "example": "/dsr-appointment?limit=25&page=11" + "example": "/dsr-interaction?limit=25&page=11" }, "next": { - "example": "/dsr-appointment?limit=25&page=4" + "example": "/dsr-interaction?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment?limit=25&page=2" + "example": "/dsr-interaction?limit=25&page=2" } } } @@ -2914,7 +3360,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -2929,11 +3375,11 @@ }, "post": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "Create a new Dsr Appointment resources.", + "summary": "Create a new Dsr Interaction resources.", "description": "", - "operationId": "createDsrAppointment", + "operationId": "createDsrInteraction", "parameters": [ { "name": "_response", @@ -2952,14 +3398,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -2971,7 +3417,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -2986,7 +3432,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3002,14 +3448,29 @@ } } }, - "/search/dsr-appointment": { + "/search/dsr-interaction": { "post": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "Search for the Dsr Appointment resources.", + "summary": "Search for the Dsr Interaction resources.", "description": "", - "operationId": "searchDsrAppointment", + "operationId": "searchDsrInteraction", + "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": { @@ -3022,7 +3483,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3036,7 +3497,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3054,7 +3515,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3071,19 +3532,19 @@ } } }, - "/dsr-appointment/{id}": { + "/dsr-interaction/{id}": { "get": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "Detailed information about a Dsr Appointment resource.", + "summary": "Detailed information about a Dsr Interaction resource.", "description": "", - "operationId": "getDsrAppointment", + "operationId": "getDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3093,7 +3554,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3105,7 +3566,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3120,7 +3581,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3137,16 +3598,16 @@ }, "delete": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "Delete a Dsr Appointment resource.", + "summary": "Delete a Dsr Interaction resource.", "description": "", - "operationId": "deleteDsrAppointment", + "operationId": "deleteDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3177,16 +3638,16 @@ }, "patch": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "Partially update information about a Dsr Appointment resource.", + "summary": "Partially update information about a Dsr Interaction resource.", "description": "", - "operationId": "updateDsrAppointment", + "operationId": "updateDsrInteraction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment", + "description": "Identifier for the dsr_interaction", "required": true, "schema": { "type": "string", @@ -3204,18 +3665,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment resource.", + "description": "Partially update information about a Dsr Interaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointment", + "description": "Detail of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3227,7 +3688,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3242,7 +3703,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3261,14 +3722,14 @@ } } }, - "/aggregate/dsr-appointment": { + "/aggregate/dsr-interaction": { "post": { "tags": [ - "Dsr Appointment" + "Dsr Interaction" ], - "summary": "Aggregate for the Dsr Appointment resources.", + "summary": "Aggregate for the Dsr Interaction resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointment", + "operationId": "aggregateDsrInteraction", "requestBody": { "required": true, "content": { @@ -3292,7 +3753,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointment", + "description": "List of DsrInteraction", "content": { "application/vnd.api+json": { "schema": { @@ -3306,7 +3767,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3324,7 +3785,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointment" + "$ref": "#/components/schemas/DsrInteraction" } } } @@ -3341,14 +3802,14 @@ } } }, - "/dsr-appointment-attendee": { + "/dsr-presentation": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "List with basic information of Dsr Appointment Attendee resources.", + "summary": "List with basic information of Dsr Presentation resources.", "description": "", - "operationId": "getDsrAppointmentAttendeeList", + "operationId": "getDsrPresentationList", "parameters": [ { "name": "limit", @@ -3377,7 +3838,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Attendee resources.", + "description": "List of Dsr Presentation resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3396,7 +3857,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } ] @@ -3410,16 +3871,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-attendee?limit=25" + "example": "/dsr-presentation?limit=25" }, "last": { - "example": "/dsr-appointment-attendee?limit=25&page=11" + "example": "/dsr-presentation?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-attendee?limit=25&page=4" + "example": "/dsr-presentation?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-attendee?limit=25&page=2" + "example": "/dsr-presentation?limit=25&page=2" } } } @@ -3440,7 +3901,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3455,11 +3916,11 @@ }, "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "Create a new Dsr Appointment Attendee resources.", + "summary": "Create a new Dsr Presentation resources.", "description": "", - "operationId": "createDsrAppointmentAttendee", + "operationId": "createDsrPresentation", "parameters": [ { "name": "_response", @@ -3478,14 +3939,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3497,7 +3958,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3512,7 +3973,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3528,14 +3989,29 @@ } } }, - "/search/dsr-appointment-attendee": { + "/search/dsr-presentation": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "Search for the Dsr Appointment Attendee resources.", + "summary": "Search for the Dsr Presentation resources.", "description": "", - "operationId": "searchDsrAppointmentAttendee", + "operationId": "searchDsrPresentation", + "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": { @@ -3548,7 +4024,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3562,7 +4038,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3580,7 +4056,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3597,19 +4073,19 @@ } } }, - "/dsr-appointment-attendee/{id}": { + "/dsr-presentation/{id}": { "get": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "Detailed information about a Dsr Appointment Attendee resource.", + "summary": "Detailed information about a Dsr Presentation resource.", "description": "", - "operationId": "getDsrAppointmentAttendee", + "operationId": "getDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -3619,7 +4095,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3631,7 +4107,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3646,7 +4122,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3663,16 +4139,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "Delete a Dsr Appointment Attendee resource.", + "summary": "Delete a Dsr Presentation resource.", "description": "", - "operationId": "deleteDsrAppointmentAttendee", + "operationId": "deleteDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -3703,16 +4179,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "Partially update information about a Dsr Appointment Attendee resource.", + "summary": "Partially update information about a Dsr Presentation resource.", "description": "", - "operationId": "updateDsrAppointmentAttendee", + "operationId": "updateDsrPresentation", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_attendee", + "description": "Identifier for the dsr_presentation", "required": true, "schema": { "type": "string", @@ -3730,18 +4206,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Attendee resource.", + "description": "Partially update information about a Dsr Presentation resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentAttendee", + "description": "Detail of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3753,7 +4229,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3768,7 +4244,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3787,14 +4263,14 @@ } } }, - "/aggregate/dsr-appointment-attendee": { + "/aggregate/dsr-presentation": { "post": { "tags": [ - "Dsr Appointment Attendee" + "Dsr Presentation" ], - "summary": "Aggregate for the Dsr Appointment Attendee resources.", + "summary": "Aggregate for the Dsr Presentation resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentAttendee", + "operationId": "aggregateDsrPresentation", "requestBody": { "required": true, "content": { @@ -3818,7 +4294,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentAttendee", + "description": "List of DsrPresentation", "content": { "application/vnd.api+json": { "schema": { @@ -3832,7 +4308,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3850,7 +4326,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentAttendee" + "$ref": "#/components/schemas/DsrPresentation" } } } @@ -3867,14 +4343,14 @@ } } }, - "/dsr-appointment-request": { + "/dsr-presentation-cms-page": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" ], - "summary": "List with basic information of Dsr Appointment Request resources.", - "description": "", - "operationId": "getDsrAppointmentRequestList", + "summary": "List with basic information of Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPageList", "parameters": [ { "name": "limit", @@ -3903,7 +4379,7 @@ ], "responses": { "200": { - "description": "List of Dsr Appointment Request resources.", + "description": "List of Dsr Presentation Cms Page resources.", "content": { "application/vnd.api+json": { "schema": { @@ -3922,7 +4398,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } ] @@ -3936,16 +4412,16 @@ "type": "object", "properties": { "first": { - "example": "/dsr-appointment-request?limit=25" + "example": "/dsr-presentation-cms-page?limit=25" }, "last": { - "example": "/dsr-appointment-request?limit=25&page=11" + "example": "/dsr-presentation-cms-page?limit=25&page=11" }, "next": { - "example": "/dsr-appointment-request?limit=25&page=4" + "example": "/dsr-presentation-cms-page?limit=25&page=4" }, "prev": { - "example": "/dsr-appointment-request?limit=25&page=2" + "example": "/dsr-presentation-cms-page?limit=25&page=2" } } } @@ -3966,7 +4442,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -3981,11 +4457,11 @@ }, "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" ], - "summary": "Create a new Dsr Appointment Request resources.", - "description": "", - "operationId": "createDsrAppointmentRequest", + "summary": "Create a new Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "createDsrPresentationCmsPage", "parameters": [ { "name": "_response", @@ -4004,14 +4480,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4023,7 +4499,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4038,7 +4514,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4054,14 +4530,29 @@ } } }, - "/search/dsr-appointment-request": { + "/search/dsr-presentation-cms-page": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" + ], + "summary": "Search for the Dsr Presentation Cms Page resources.", + "description": "Available since: 6.0.0.0", + "operationId": "searchDsrPresentationCmsPage", + "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" + } + } ], - "summary": "Search for the Dsr Appointment Request resources.", - "description": "", - "operationId": "searchDsrAppointmentRequest", "requestBody": { "required": true, "content": { @@ -4074,7 +4565,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4088,7 +4579,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4106,7 +4597,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4123,19 +4614,19 @@ } } }, - "/dsr-appointment-request/{id}": { + "/dsr-presentation-cms-page/{id}": { "get": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" ], - "summary": "Detailed information about a Dsr Appointment Request resource.", - "description": "", - "operationId": "getDsrAppointmentRequest", + "summary": "Detailed information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "getDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4145,7 +4636,7 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4157,7 +4648,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4172,7 +4663,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4189,16 +4680,16 @@ }, "delete": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" ], - "summary": "Delete a Dsr Appointment Request resource.", - "description": "", - "operationId": "deleteDsrAppointmentRequest", + "summary": "Delete a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "deleteDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4229,16 +4720,16 @@ }, "patch": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" ], - "summary": "Partially update information about a Dsr Appointment Request resource.", - "description": "", - "operationId": "updateDsrAppointmentRequest", + "summary": "Partially update information about a Dsr Presentation Cms Page resource.", + "description": "Available since: 6.0.0.0", + "operationId": "updateDsrPresentationCmsPage", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the dsr_appointment_request", + "description": "Identifier for the dsr_presentation_cms_page", "required": true, "schema": { "type": "string", @@ -4256,18 +4747,18 @@ } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Request resource.", + "description": "Partially update information about a Dsr Presentation Cms Page resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } }, "responses": { "200": { - "description": "Detail of DsrAppointmentRequest", + "description": "Detail of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4279,7 +4770,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4294,7 +4785,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4313,14 +4804,14 @@ } } }, - "/aggregate/dsr-appointment-request": { + "/aggregate/dsr-presentation-cms-page": { "post": { "tags": [ - "Dsr Appointment Request" + "Dsr Presentation Cms Page" ], - "summary": "Aggregate for the Dsr Appointment Request resources.", + "summary": "Aggregate for the Dsr Presentation Cms Page resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentRequest", + "operationId": "aggregateDsrPresentationCmsPage", "requestBody": { "required": true, "content": { @@ -4344,7 +4835,7 @@ }, "responses": { "200": { - "description": "List of DsrAppointmentRequest", + "description": "List of DsrPresentationCmsPage", "content": { "application/vnd.api+json": { "schema": { @@ -4358,7 +4849,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4376,7 +4867,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentRequest" + "$ref": "#/components/schemas/DsrPresentationCmsPage" } } } @@ -4393,275 +4884,107 @@ } } }, - "/dsr-appointment-video-chat": { - "get": { + "/_action/dsr/appointment/{appointmentId}/join-as-guide": { + "post": { "tags": [ - "Dsr Appointment Video Chat" + "Appointment" ], - "summary": "List with basic information of Dsr Appointment Video Chat resources.", - "description": "", - "operationId": "getDsrAppointmentVideoChatList", + "summary": "Join a meeting as a guide", + "description": "This route is used to join appointment as guide.", + "operationId": "joinAppointmentAsGuide", "parameters": [ { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Appointment Video Chat resources.", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-appointment-video-chat?limit=25" - }, - "last": { - "example": "/dsr-appointment-video-chat?limit=25&page=11" - }, - "next": { - "example": "/dsr-appointment-video-chat?limit=25&page=4" - }, - "prev": { - "example": "/dsr-appointment-video-chat?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } + "$ref": "#/components/schemas/JoinAppointmentResponse" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/{appointmentId}/start": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Appointment" ], - "summary": "Create a new Dsr Appointment Video Chat resources.", - "description": "", - "operationId": "createDsrAppointmentVideoChat", + "summary": "Start a presentation for a appointment", + "description": "Complete all needed data start the presentation", + "operationId": "startAppointment", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - }, "responses": { - "200": { - "description": "Detail of DsrAppointmentVideoChat", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + "204": { + "description": "" } } } }, - "/search/dsr-appointment-video-chat": { + "/_action/dsr/appointment/{appointmentId}/end": { "post": { "tags": [ - "Dsr Appointment Video Chat" + "Appointment" ], - "summary": "Search for the Dsr Appointment Video Chat resources.", - "description": "", - "operationId": "searchDsrAppointmentVideoChat", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "End a presentation for a appointment", + "description": "Complete all needed data and remove unneeded to close the presentation", + "operationId": "endAppointment", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + "description": "" } } } }, - "/dsr-appointment-video-chat/{id}": { + "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { "get": { "tags": [ - "Dsr Appointment Video Chat" + "Appointment" ], - "summary": "Detailed information about a Dsr Appointment Video Chat resource.", - "description": "", - "operationId": "getDsrAppointmentVideoChat", + "summary": "Get the sw-context-token for a attendee", + "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", + "operationId": "getAttendeeToken", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -4671,523 +4994,359 @@ ], "responses": { "200": { - "description": "Detail of DsrAppointmentVideoChat", + "description": "The sw-context-token from the attendee", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "attendee-sw-context-token": { + "type": "string" } + }, + "example": { + "attendee-sw-context-token": "context token of attendee" } } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/{appointmentId}/instant-listing": { + "post": { "tags": [ - "Dsr Appointment Video Chat" + "Appointment" ], - "summary": "Delete a Dsr Appointment Video Chat resource.", - "description": "", - "operationId": "deleteDsrAppointmentVideoChat", + "summary": "Add a instant listing to the presentation", + "description": "Add a page as the instant listing to the presentation", + "operationId": "addInstantListing", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", + "description": "Appointment id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "patch": { - "tags": [ - "Dsr Appointment Video Chat" - ], - "summary": "Partially update information about a Dsr Appointment Video Chat resource.", - "description": "", - "operationId": "updateDsrAppointmentVideoChat", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_appointment_video_chat", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } } ], "requestBody": { - "description": "Partially update information about a Dsr Appointment Video Chat resource.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "required": [ + "productIds" + ], + "properties": { + "productIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" + } + }, + "type": "object" } } } }, "responses": { - "200": { - "description": "Detail of DsrAppointmentVideoChat", + "201": { + "description": "Created a new instant listing", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" + "index": { + "type": "integer", + "description": "The current index of the instant listing which is created by this request" } + }, + "example": { + "index": 1 } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - } - }, - "/aggregate/dsr-appointment-video-chat": { - "post": { + }, + "patch": { "tags": [ - "Dsr Appointment Video Chat" + "Appointment" + ], + "summary": "Update a instant listing from the presentation", + "description": "Updates the products for the given listing", + "operationId": "updateInstantListing", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Aggregate for the Dsr Appointment Video Chat resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAppointmentVideoChat", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "addProductIds", + "removeProductIds", + "currentPageGroupId" + ], "properties": { - "aggregations": { + "addProductIds": { "type": "array", "items": { - "$ref": "#/components/schemas/Aggregation" - } + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be added to the instant listing" + }, + "removeProductIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which should be removed to the instant listing" + }, + "currentPageGroupId": { + "type": "string", + "description": "Id of the current cms page", + "pattern": "^[0-9a-f]{32}$" + }, + "pageName": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The name of the instant listing page" } }, - "required": [ - "aggregations" - ] + "type": "object" } } } }, "responses": { "200": { - "description": "List of DsrAppointmentVideoChat", + "description": "Updated the instant listing", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the instant listing page" }, - "data": { + "pickedProductIds": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAppointmentVideoChat" - } + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "description": "Ids of the products which are picked for the instant listing" + }, + "title": { + "type": "string", + "description": "The title of the instant listing" } + }, + "example": { + "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", + "pickedProductIds": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ], + "title": "Default Digital Sales Rooms product listing page" } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-attendee-product-collection": { + "/_action/dsr/appointment/{appointmentId}/presentation/state": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "List with basic information of Dsr Attendee Product Collection resources.", - "description": "", - "operationId": "getDsrAttendeeProductCollectionList", + "summary": "Get the current presentation state", + "description": "Returns the presentation state for all and the guide", + "operationId": "getGuidePresentationState", "parameters": [ { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, - { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } - }, - { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Attendee Product Collection resources.", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-attendee-product-collection?limit=25" - }, - "last": { - "example": "/dsr-attendee-product-collection?limit=25&page=11" - }, - "next": { - "example": "/dsr-attendee-product-collection?limit=25&page=4" - }, - "prev": { - "example": "/dsr-attendee-product-collection?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } + "$ref": "#/components/schemas/GuidePresentationStateResponse" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/{appointmentId}/video-room": { "post": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "Create a new Dsr Attendee Product Collection resources.", - "description": "", - "operationId": "createDsrAttendeeProductCollection", + "summary": "Create a video room", + "description": "Creates a video room on the remote video tool", + "operationId": "createVideoRoom", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } - }, "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } + "$ref": "#/components/schemas/VideoChatCreateStruct" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + } + } + }, + "delete": { + "tags": [ + "Appointment" + ], + "summary": "Delete a video room", + "description": "Delete a video room and tokens on the remote video tool", + "operationId": "deleteVideoRoom", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": [] + } } } } }, - "/search/dsr-attendee-product-collection": { - "post": { + "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { + "get": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "Search for the Dsr Attendee Product Collection resources.", - "description": "", - "operationId": "searchDsrAttendeeProductCollection", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Get attendee insights", + "description": "Get attendee insights for the given appointment", + "operationId": "getAttendeeInsights", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } + "$ref": "#/components/schemas/GetAttendeeInsightsResponse" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-attendee-product-collection/{id}": { + "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { "get": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "Detailed information about a Dsr Attendee Product Collection resource.", - "description": "", - "operationId": "getDsrAttendeeProductCollection", + "summary": "Get cart insights", + "description": "Get cart insights for the given appointment", + "operationId": "getCartInsights", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5197,60 +5356,81 @@ ], "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } - ] + "$ref": "#/components/schemas/GetCartInsightsResponse" } - }, + } + } + } + } + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { + "get": { + "tags": [ + "Appointment" + ], + "summary": "Get cart statistics", + "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", + "operationId": "getCartStatistics", + "parameters": [ + { + "name": "appointmentId", + "in": "path", + "description": "Appointment id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the cart line items", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the cart line items", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "", + "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } - }, - "delete": { + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { + "get": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "Delete a Dsr Attendee Product Collection resource.", - "description": "", - "operationId": "deleteDsrAttendeeProductCollection", + "summary": "Get last seen products insights", + "description": "Get last seen products of all attendees for the given appointment", + "operationId": "getLastSeenProductsInsights", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5258,39 +5438,68 @@ } }, { - "name": "_response", + "name": "limit", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the products", "schema": { "type": "string" } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the last seen products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } ], "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } + } + } } } - }, - "patch": { + } + }, + "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { + "get": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "Partially update information about a Dsr Attendee Product Collection resource.", - "description": "", - "operationId": "updateDsrAttendeeProductCollection", + "summary": "Get wishlist insights", + "description": "Get wishlist of all the attendees for the given appointment", + "operationId": "getWishlistInsights", "parameters": [ { - "name": "id", + "name": "appointmentId", "in": "path", - "description": "Identifier for the dsr_attendee_product_collection", + "description": "Appointment id", "required": true, "schema": { "type": "string", @@ -5298,182 +5507,198 @@ } }, { - "name": "_response", + "name": "limit", "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, + "description": "The limit of the products which should be returned", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "page", + "in": "query", + "description": "The page of the products which should be returned", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "term", + "in": "query", + "description": "The search term for the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "order", + "in": "query", + "description": "The order of the wishlist products", + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "in": "query", + "description": "The sort of the wishlist products", "schema": { "type": "string" } + }, + { + "name": "attendeeId", + "in": "query", + "description": "The attendee id for which the wishlist products should be returned", + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } } ], - "requestBody": { - "description": "Partially update information about a Dsr Attendee Product Collection resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WidgetProductListing" + } } } } - }, + } + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/remove": { + "post": { + "tags": [ + "Appointment" + ], + "summary": "Remove an attendee from the appointment", + "description": "Remove an attendee from the appointment", + "operationId": "removeAttendee", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], "responses": { "200": { - "description": "Detail of DsrAttendeeProductCollection", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", - "required": [ - "data" - ], "properties": { - "data": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "message": { + "type": "string" + }, + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the removed attendee" } + }, + "example": { + "message": "Attendee removed successfully", + "attendeeId": "018c19b80403709cb2cef54f70860042" } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/aggregate/dsr-attendee-product-collection": { - "post": { + "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { + "get": { "tags": [ - "Dsr Attendee Product Collection" + "Appointment" ], - "summary": "Aggregate for the Dsr Attendee Product Collection resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrAttendeeProductCollection", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "summary": "Get ids of last seen products", + "description": "Get all product ids of that attendee has seen", + "operationId": "getLastSeenProductIds", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrAttendeeProductCollection", + "description": "", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { + "type": "object", + "properties": { + "collection": { "type": "object", "properties": { - "data": { + "lastSeen": { "type": "array", "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } } } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrAttendeeProductCollection" - } + }, + "example": { + "collection": { + "lastSeen": [ + "018c19b80403709cb2cef54f70860042", + "018c19b804027291955d8f076c272d0d" + ] } } } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-cms-slide": { + "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { "get": { "tags": [ - "Dsr Cms Slide" + "Appointment" ], - "summary": "List with basic information of Dsr Cms Slide resources.", - "description": "", - "operationId": "getDsrCmsSlideList", + "summary": "Load a temporary cart for the attendee", + "description": "Load a temporary cart for the attendee", + "operationId": "loadTempCart", "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", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "name": "sw-context-token", + "in": "header", + "description": "Contains sw-context-token value", "schema": { "type": "string" } @@ -5481,239 +5706,109 @@ ], "responses": { "200": { - "description": "List of Dsr Cms Slide resources.", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-cms-slide?limit=25" - }, - "last": { - "example": "/dsr-cms-slide?limit=25&page=11" - }, - "next": { - "example": "/dsr-cms-slide?limit=25&page=4" - }, - "prev": { - "example": "/dsr-cms-slide?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "401": { - "$ref": "#/components/responses/401" } } - }, + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { "post": { "tags": [ - "Dsr Cms Slide" + "Appointment" ], - "summary": "Create a new Dsr Cms Slide resources.", - "description": "", - "operationId": "createDsrCmsSlide", + "summary": "Add discount to the temp cart", + "description": "Add discount to the temp cart", + "operationId": "addTempDiscount", "parameters": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, "schema": { "type": "string", - "enum": [ - "basic", - "detail" - ] + "pattern": "^[0-9a-f]{32}$" } } ], "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" + "$ref": "#/components/schemas/AddTempDiscountRequestBody" } } } }, "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "", "content": { - "application/vnd.api+json": { + "application/json": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/search/dsr-cms-slide": { + "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { "post": { "tags": [ - "Dsr Cms Slide" + "Appointment" ], - "summary": "Search for the Dsr Cms Slide resources.", - "description": "", - "operationId": "searchDsrCmsSlide", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "summary": "Remove all discount from the temp cart", + "description": "Remove all discount from the temp cart", + "operationId": "removeTempDiscount", + "parameters": [ + { + "name": "attendeeId", + "in": "path", + "description": "Attendee id", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - }, + ], "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-cms-slide/{id}": { - "get": { + "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { + "post": { "tags": [ - "Dsr Cms Slide" + "Appointment" ], - "summary": "Detailed information about a Dsr Cms Slide resource.", - "description": "", - "operationId": "getDsrCmsSlide", + "summary": "Apply the discount from the temp cart to the attendee cart", + "description": "Apply the discount from the temp cart to the attendee cart", + "operationId": "applyTempDiscount", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Attendee id", "required": true, "schema": { "type": "string", @@ -5723,21124 +5818,10847 @@ ], "responses": { "200": { - "description": "Detail of DsrCmsSlide", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Cms Slide" - ], - "summary": "Delete a Dsr Cms Slide resource.", - "description": "", - "operationId": "deleteDsrCmsSlide", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_cms_slide", - "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": { + } + }, + "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { + "post": { "tags": [ - "Dsr Cms Slide" + "Appointment" ], - "summary": "Partially update information about a Dsr Cms Slide resource.", - "description": "", - "operationId": "updateDsrCmsSlide", + "summary": "Add discount to the attendee cart", + "description": "Add discount to the attendee cart", + "operationId": "addCartDiscount", "parameters": [ { - "name": "id", + "name": "attendeeId", "in": "path", - "description": "Identifier for the dsr_cms_slide", + "description": "Attendee id", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Dsr Cms Slide resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DsrCmsSlide", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" } - } - } - }, - "/aggregate/dsr-cms-slide": { - "post": { - "tags": [ - "Dsr Cms Slide" ], - "summary": "Aggregate for the Dsr Cms Slide resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrCmsSlide", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "$ref": "#/components/schemas/AddCartDiscountRequestBody" } } } }, "responses": { "200": { - "description": "List of DsrCmsSlide", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrCmsSlide" - } - } - } + "$ref": "#/components/schemas/Cart" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } }, - "/dsr-interaction": { - "get": { + "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}": { + "post": { "tags": [ - "Dsr Interaction" + "Appointment" ], - "summary": "List with basic information of Dsr Interaction resources.", - "description": "", - "operationId": "getDsrInteractionList", + "summary": "Load line item ids of a shopping lists from the appointment", + "description": "Load line item ids of a shopping lists from the appointment", + "operationId": "setSharingShoppingList", "parameters": [ { - "name": "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", + "name": "appointmentId", + "in": "path", + "description": "The appointment id you are joining", + "required": true, "schema": { - "type": "integer" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", + "name": "shoppingListId", + "in": "path", + "description": "The shopping list id you want to load", + "required": true, "schema": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } ], "responses": { "200": { - "description": "List of Dsr Interaction resources.", + "description": "", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" - }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-interaction?limit=25" - }, - "last": { - "example": "/dsr-interaction?limit=25&page=11" - }, - "next": { - "example": "/dsr-interaction?limit=25&page=4" - }, - "prev": { - "example": "/dsr-interaction?limit=25&page=2" - } - } - } - ] - } - } - } - ] - } - }, "application/json": { "schema": { "type": "object", "properties": { - "total": { - "type": "integer" - }, "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" + "type": "object", + "example": { + "data": { + "01938f89c632709ba4d65eb53604bf5b": { + "quantity": "1" + }, + "01938f89c8647036a617b7d88e1e24f5": { + "quantity": "1" + }, + "01938f8a23d47305b1e289163cea5074": { + "quantity": "1" + } + } } } } } } } - }, - "401": { - "$ref": "#/components/responses/401" } - } - }, - "post": { - "tags": [ - "Dsr Interaction" - ], - "summary": "Create a new Dsr Interaction resources.", - "description": "", - "operationId": "createDsrInteraction", - "parameters": [ + }, + "security": [ { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } + "ApiKey": [] } + ] + } + } + }, + "components": { + "schemas": { + "success": { + "required": [ + "data" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrInteraction" + "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 } }, - "responses": { - "200": { - "description": "Detail of DsrInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - } + "type": "object", + "additionalProperties": false + }, + "failure": { + "required": [ + "errors" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "400": { - "$ref": "#/components/responses/400" + "links": { + "$ref": "#/components/schemas/links" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/dsr-interaction": { - "post": { - "tags": [ - "Dsr Interaction" - ], - "summary": "Search for the Dsr Interaction resources.", - "description": "", - "operationId": "searchDsrInteraction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/error" + }, + "uniqueItems": true } }, - "responses": { - "200": { - "description": "List of DsrInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - } - } + "type": "object", + "additionalProperties": false + }, + "info": { + "required": [ + "meta" + ], + "properties": { + "meta": { + "$ref": "#/components/schemas/meta" }, - "400": { - "$ref": "#/components/responses/400" + "links": { + "$ref": "#/components/schemas/links" }, - "401": { - "$ref": "#/components/responses/401" + "jsonapi": { + "$ref": "#/components/schemas/jsonapi" } - } - } - }, - "/dsr-interaction/{id}": { - "get": { - "tags": [ - "Dsr Interaction" - ], - "summary": "Detailed information about a Dsr Interaction resource.", - "description": "", - "operationId": "getDsrInteraction", - "parameters": [ + }, + "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": [ { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$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" ], - "responses": { - "200": { - "description": "Detail of DsrInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] + "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" } }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } + { + "$ref": "#/components/schemas/link" } - } - }, - "404": { - "$ref": "#/components/responses/404" + ] }, - "401": { - "$ref": "#/components/responses/401" + "related": { + "$ref": "#/components/schemas/link" } + }, + "type": "object", + "additionalProperties": true + }, + "links": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/link" } }, - "delete": { - "tags": [ - "Dsr Interaction" - ], - "summary": "Delete a Dsr Interaction resource.", - "description": "", - "operationId": "deleteDsrInteraction", - "parameters": [ + "link": { + "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", + "oneOf": [ { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "A string containing the link's URL.", + "type": "string", + "format": "uri-reference" + }, + "meta": { + "$ref": "#/components/schemas/meta" + } } } - ], - "responses": { - "204": { - "$ref": "#/components/responses/204" + ] + }, + "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" + ] }, - "404": { - "$ref": "#/components/responses/404" + { + "required": [ + "meta" + ] }, - "401": { - "$ref": "#/components/responses/401" + { + "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" + } + ] + } + } } - } - }, - "patch": { - "tags": [ - "Dsr Interaction" ], - "summary": "Partially update information about a Dsr Interaction resource.", - "description": "", - "operationId": "updateDsrInteraction", - "parameters": [ + "additionalProperties": false + }, + "relationshipToOne": { + "allOf": [ { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_interaction", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "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." }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } + "$ref": "#/components/schemas/linkage" } + ] + }, + "relationshipToMany": { + "description": "An array of objects each containing \\\"type\\\" and \\\"id\\\" members for to-many relationships.", + "type": "array", + "items": { + "$ref": "#/components/schemas/linkage" + }, + "uniqueItems": true + }, + "linkage": { + "description": "The \"type\" and \"id\" to non-empty members.", + "required": [ + "type", + "id" ], - "requestBody": { - "description": "Partially update information about a Dsr Interaction resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrInteraction" - } - } + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "responses": { - "200": { - "description": "Detail of DsrInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - } + "type": "object", + "additionalProperties": false + }, + "pagination": { + "properties": { + "first": { + "description": "The first page of data", + "type": "string", + "format": "uri-reference" }, - "400": { - "$ref": "#/components/responses/400" + "last": { + "description": "The last page of data", + "type": "string", + "format": "uri-reference" }, - "404": { - "$ref": "#/components/responses/404" + "prev": { + "description": "The previous page of data", + "type": "string", + "format": "uri-reference" }, - "401": { - "$ref": "#/components/responses/401" + "next": { + "description": "The next page of data", + "type": "string", + "format": "uri-reference" } - } - } - }, - "/aggregate/dsr-interaction": { - "post": { - "tags": [ - "Dsr Interaction" - ], - "summary": "Aggregate for the Dsr Interaction resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrInteraction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + }, + "type": "object" + }, + "jsonapi": { + "description": "An object describing the server's implementation", + "properties": { + "version": { + "type": "string" + }, + "meta": { + "$ref": "#/components/schemas/meta" } }, - "responses": { - "200": { - "description": "List of DsrInteraction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } - ] - } + "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]." }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrInteraction" - } - } - } - } + "parameter": { + "type": "string", + "description": "A string indicating which query parameter caused the error." } } }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + "meta": { + "$ref": "#/components/schemas/meta" } - } - } - }, - "/dsr-presentation": { - "get": { - "tags": [ - "Dsr Presentation" - ], - "summary": "List with basic information of Dsr Presentation resources.", - "description": "", - "operationId": "getDsrPresentationList", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "Max amount of resources to be returned in a page", - "schema": { - "type": "integer" - } - }, + }, + "type": "object", + "additionalProperties": false + }, + "AclRoleJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ { - "name": "page", - "in": "query", - "description": "The page to be returned", - "schema": { - "type": "integer" - } + "$ref": "#/components/schemas/resource" }, { - "name": "query", - "in": "query", - "description": "Encoded SwagQL in JSON", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of Dsr Presentation resources.", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "allOf": [ - { - "$ref": "#/components/schemas/data" + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "users": { + "properties": { + "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" }, - { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } + "id": { + "type": "string", + "example": "9bc65c2abec141778ffaa729489f3e87" } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" + } + } + } + }, + "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" }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-presentation?limit=25" - }, - "last": { - "example": "/dsr-presentation?limit=25&page=11" - }, - "next": { - "example": "/dsr-presentation?limit=25&page=4" - }, - "prev": { - "example": "/dsr-presentation?limit=25&page=2" - } - } + "id": { + "type": "string", + "example": "415320131958c70f4f250ca4d7e63bbd" } - ] + } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } + ] }, - "post": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Create a new Dsr Presentation resources.", - "description": "", - "operationId": "createDsrPresentation", - "parameters": [ - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "schema": { - "type": "string", - "enum": [ - "basic", - "detail" - ] - } - } + "AclRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the ACL role defined.", + "type": "string" + }, + "description": { + "description": "A short description of the ACL role.", + "type": "string" + }, + "privileges": { + "type": "array", + "items": { + "type": "string" } - } - }, - "responses": { - "200": { - "description": "Detail of DsrPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } + }, + "deletedAt": { + "description": "Time and date when the ACL role was deleted.", + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" } }, - "400": { - "$ref": "#/components/responses/400" + "app": { + "$ref": "#/components/schemas/App" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/dsr-presentation": { - "post": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Search for the Dsr Presentation resources.", - "description": "", - "operationId": "searchDsrPresentation", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } + "integrations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Integration" } } }, - "responses": { - "200": { - "description": "List of DsrPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - } - } + "type": "object" + }, + "AclUserRole": { + "description": "Added since version: 6.0.0.0", + "required": [ + "userId", + "aclRoleId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "400": { - "$ref": "#/components/responses/400" + "userId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/dsr-presentation/{id}": { - "get": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Detailed information about a Dsr Presentation resource.", - "description": "", - "operationId": "getDsrPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of DsrPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" + "aclRoleId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Delete a Dsr Presentation resource.", - "description": "", - "operationId": "deleteDsrPresentation", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - { - "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" + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "404": { - "$ref": "#/components/responses/404" + "user": { + "$ref": "#/components/schemas/User" }, - "401": { - "$ref": "#/components/responses/401" + "aclRole": { + "$ref": "#/components/schemas/AclRole" } - } + }, + "type": "object" }, - "patch": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Partially update information about a Dsr Presentation resource.", - "description": "", - "operationId": "updateDsrPresentation", - "parameters": [ + "AppJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "$ref": "#/components/schemas/resource" }, { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Dsr Presentation resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DsrPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } - } - ] + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" } }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentation" - } - } + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/dsr-presentation": { - "post": { - "tags": [ - "Dsr Presentation" - ], - "summary": "Aggregate for the Dsr Presentation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentation", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + }, + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" + }, + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" + } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of DsrPresentation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentation" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/dsr-presentation-cms-page": { - "get": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "List with basic information of Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPageList", - "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 Dsr Presentation Cms Page 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/DsrPresentationCmsPage" - } - } - ] - }, - "links": { - "allOf": [ - { - "$ref": "#/components/schemas/pagination" - }, - { - "type": "object", - "properties": { - "first": { - "example": "/dsr-presentation-cms-page?limit=25" - }, - "last": { - "example": "/dsr-presentation-cms-page?limit=25&page=11" - }, - "next": { - "example": "/dsr-presentation-cms-page?limit=25&page=4" - }, - "prev": { - "example": "/dsr-presentation-cms-page?limit=25&page=2" - } - } + "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" } - ] + } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "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" + } + } + } } - } - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "post": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Create a new Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "createDsrPresentationCmsPage", - "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/DsrPresentationCmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "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" + } + } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/search/dsr-presentation-cms-page": { - "post": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Search for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.0.0.0", - "operationId": "searchDsrPresentationCmsPage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Criteria" - } - } - } - }, - "responses": { - "200": { - "description": "List of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "type": "object" + }, + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/dsr-presentation-cms-page/{id}": { - "get": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Detailed information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "getDsrPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "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" + } + } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Delete a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "deleteDsrPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "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": [ - "Dsr Presentation Cms Page" - ], - "summary": "Partially update information about a Dsr Presentation Cms Page resource.", - "description": "Available since: 6.0.0.0", - "operationId": "updateDsrPresentationCmsPage", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the dsr_presentation_cms_page", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "_response", - "in": "query", - "description": "Data format for response. Empty if none is provided.", - "allowEmptyValue": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Partially update information about a Dsr Presentation Cms Page resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - }, - "responses": { - "200": { - "description": "Detail of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + "type": "object" + }, + "cmsBlocks": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app/ac863f346e618f9a959b5c95d5d28941/cmsBlocks" + } } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "required": [ - "data" - ], - "properties": { - "data": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/dsr-presentation-cms-page": { - "post": { - "tags": [ - "Dsr Presentation Cms Page" - ], - "summary": "Aggregate for the Dsr Presentation Cms Page resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateDsrPresentationCmsPage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of DsrPresentationCmsPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app_cms_block" + }, + "id": { + "type": "string", + "example": "3636c4901eab836dfb837e1a9a37d3c0" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/flow": { - "post": { - "tags": [ - "Flow" - ], - "summary": "Aggregate for the Flow resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateFlow", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Flow", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Flow" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/flow-sequence": { - "post": { - "tags": [ - "Flow Sequence" - ], - "summary": "Aggregate for the Flow Sequence resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateFlowSequence", - "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 FlowSequence", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowSequence" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/flow-template": { - "post": { - "tags": [ - "Flow Template" + ] + }, + "App": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "name", + "path", + "version", + "integrationId", + "aclRoleId", + "label" ], - "summary": "Aggregate for the Flow Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateFlowTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app.", + "type": "string" + }, + "author": { + "description": "Creator of the App.", + "type": "string" + }, + "copyright": { + "description": "Legal rights on the created app.", + "type": "string" + }, + "license": { + "description": "Software license's like MIT, etc.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", + "type": "boolean" + }, + "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", + "type": "boolean" + }, + "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", + "type": "string" + }, + "version": { + "description": "Version of the plugin.", + "type": "string" + }, + "icon": { + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "modules": { + "type": "array", + "items": { + "type": "object" } - } - }, - "responses": { - "200": { - "description": "List of FlowTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FlowTemplate" - } - } - } - } - } + }, + "mainModule": { + "type": "object" + }, + "cookies": { + "type": "array", + "items": { + "type": "object" } }, - "400": { - "$ref": "#/components/responses/400" + "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", + "type": "boolean" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/import-export-file": { - "post": { - "tags": [ - "Import Export File" - ], - "summary": "Aggregate for the Import Export File resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateImportExportFile", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "baseAppUrl": { + "description": "Root URL for an app.", + "type": "string" + }, + "allowedHosts": { + "type": "array", + "items": { + "type": "string" } - } - }, - "responses": { - "200": { - "description": "List of ImportExportFile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportFile" - } - } - } - } - } + }, + "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", + "type": "integer", + "format": "int64" + }, + "checkoutGatewayUrl": { + "type": "string" + }, + "contextGatewayUrl": { + "type": "string" + }, + "inAppPurchasesGatewayUrl": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceConfig": { + "type": "object" + }, + "selfManaged": { + "type": "boolean" + }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" } }, - "400": { - "$ref": "#/components/responses/400" + "label": { + "type": "string" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/import-export-log": { - "post": { - "tags": [ - "Import Export Log" - ], - "summary": "Aggregate for the Import Export Log resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateImportExportLog", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "description": { + "type": "string" + }, + "privacyPolicyExtensions": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "integrationId": { + "description": "Unique identity of integration.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "aclRoleId": { + "description": "Unique identity of ACL Role.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "integration": { + "$ref": "#/components/schemas/Integration" + }, + "aclRole": { + "$ref": "#/components/schemas/AclRole" + }, + "customFieldSets": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSet" } - } - }, - "responses": { - "200": { - "description": "List of ImportExportLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportLog" - } - } - } - } - } + }, + "actionButtons": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppActionButton" } }, - "400": { - "$ref": "#/components/responses/400" + "templates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppTemplate" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/import-export-profile": { - "post": { - "tags": [ - "Import Export Profile" - ], - "summary": "Aggregate for the Import Export Profile resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateImportExportProfile", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "webhooks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Webhook" } - } - }, - "responses": { - "200": { - "description": "List of ImportExportProfile", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ImportExportProfile" - } - } - } - } - } + }, + "paymentMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppPaymentMethod" } }, - "400": { - "$ref": "#/components/responses/400" + "taxProviders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxProvider" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/integration": { - "post": { - "tags": [ - "Integration" - ], - "summary": "Aggregate for the Integration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateIntegration", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "cmsBlocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppCmsBlock" } - } - }, - "responses": { - "200": { - "description": "List of Integration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Integration" - } - } - } - } - } + }, + "flowActions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowAction" } }, - "400": { - "$ref": "#/components/responses/400" + "flowEvents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppFlowEvent" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/landing-page": { - "post": { - "tags": [ - "Landing Page" - ], - "summary": "Aggregate for the Landing Page resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLandingPage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "appShippingMethods": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AppShippingMethod" } } }, - "responses": { - "200": { - "description": "List of LandingPage", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" + "type": "object" + }, + "AppActionButtonJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" + }, + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" + }, + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" + }, + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/language": { - "post": { - "tags": [ - "Language" + ] + }, + "AppActionButton": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "entity", + "view", + "url", + "action", + "appId", + "label" ], - "summary": "Aggregate for the Language resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLanguage", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Language", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Language" - } - } - } - } - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "400": { - "$ref": "#/components/responses/400" + "entity": { + "description": "Indicates in which particular entity.", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/locale": { - "post": { - "tags": [ - "Locale" - ], - "summary": "Aggregate for the Locale resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLocale", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Locale", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Locale" - } - } - } - } - } - } + "view": { + "description": "Indicates whether it is detail page view or listing page view.", + "type": "string" }, - "400": { - "$ref": "#/components/responses/400" + "url": { + "description": "An url associated with the AppActionButton.", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/log-entry": { - "post": { - "tags": [ - "Log Entry" - ], - "summary": "Aggregate for the Log Entry resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateLogEntry", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" } }, - "responses": { - "200": { - "description": "List of LogEntry", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } - ] - } + "type": "object" + }, + "AppAdministrationSnippetJsonApi": { + "description": "Added since version: 6.4.15.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "value", + "appId", + "localeId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LogEntry" - } - } - } - } + "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 } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/mail-header-footer": { - "post": { - "tags": [ - "Mail Header Footer" + ] + }, + "AppAdministrationSnippet": { + "description": "Added since version: 6.4.15.0", + "required": [ + "id", + "value", + "appId", + "localeId" ], - "summary": "Aggregate for the Mail Header Footer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMailHeaderFooter", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "value": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "localeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "responses": { - "200": { - "description": "List of MailHeaderFooter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" + "type": "object" + }, + "AppCmsBlockJsonApi": { + "description": "Added since version: 6.4.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app's CMS block.", + "type": "string" + }, + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-cms-block/954814c609e0fd182bf61e99769a25f7/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailHeaderFooter" - } - } + "type": "object" } - } + }, + "type": "object" } - } + }, + "type": "object" + } + ] + }, + "AppCmsBlock": { + "description": "Added since version: 6.4.2.0", + "required": [ + "id", + "name", + "block", + "template", + "styles", + "appId", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "400": { - "$ref": "#/components/responses/400" + "name": { + "description": "Name of app's CMS block.", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/mail-template": { - "post": { - "tags": [ - "Mail Template" - ], - "summary": "Aggregate for the Mail Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMailTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "block": { + "type": "object" + }, + "template": { + "description": "Template that defines app CMS block.", + "type": "string" + }, + "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", + "type": "string" + }, + "label": { + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" } }, - "responses": { - "200": { - "description": "List of MailTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" + "type": "object" + }, + "AppFlowActionJsonApi": { + "description": "Added since version: 6.4.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appId", + "name", + "url", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" + } + }, + "iconRaw": { + "type": "string" + }, + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-flow-action/d976e1ecc9f1084ec17f507c84f92278/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplate" + "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", + "label" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of app flow action.", + "type": "string" + }, + "badge": { + "type": "string" + }, + "parameters": { + "type": "object" + }, + "config": { + "type": "object" + }, + "headers": { + "type": "object" + }, + "requirements": { + "type": "array", + "items": { + "type": "string" } }, - "400": { - "$ref": "#/components/responses/400" + "iconRaw": { + "type": "string" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/mail-template-type": { - "post": { - "tags": [ - "Mail Template Type" - ], - "summary": "Aggregate for the Mail Template Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMailTemplateType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "icon": { + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", + "type": "string", + "readOnly": true + }, + "swIcon": { + "type": "string" + }, + "url": { + "description": "An URL to app flow action.", + "type": "string" + }, + "delayable": { + "type": "boolean" + }, + "label": { + "type": "string" + }, + "description": { + "type": "string" + }, + "headline": { + "type": "string" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "flowSequences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FlowSequence" } } }, - "responses": { - "200": { - "description": "List of MailTemplateType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" + "type": "object" + }, + "AppFlowEventJsonApi": { + "description": "Added since version: 6.5.2.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appId", + "name", + "aware" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" + } + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MailTemplateType" + "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" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the AppFlowEvent.", + "type": "string" + }, + "aware": { + "type": "array", + "items": { + "type": "string" } }, - "400": { - "$ref": "#/components/responses/400" + "customFields": { + "type": "object" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/main-category": { - "post": { - "tags": [ - "Main Category" - ], - "summary": "Aggregate for the Main Category resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMainCategory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "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" + } } }, - "responses": { - "200": { - "description": "List of MainCategory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" + "type": "object" + }, + "AppPaymentMethodJsonApi": { + "description": "Added since version: 6.4.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "description": "Name of the app.", + "type": "string" + }, + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" + }, + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" + }, + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" + }, + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MainCategory" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media": { - "post": { - "tags": [ - "Media" - ], - "summary": "Aggregate for the Media resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMedia", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Media", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Media" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/media-default-folder": { - "post": { - "tags": [ - "Media Default Folder" + ] + }, + "AppPaymentMethod": { + "description": "Added since version: 6.4.1.0", + "required": [ + "id", + "appName", + "identifier", + "paymentMethodId" ], - "summary": "Aggregate for the Media Default Folder resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaDefaultFolder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "description": "Name of the app.", + "type": "string" + }, + "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", + "type": "string" + }, + "payUrl": { + "description": "A URL sending the pay request.", + "type": "string" + }, + "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", + "type": "string" + }, + "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", + "type": "string" + }, + "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", + "type": "string" + }, + "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", + "type": "string" + }, + "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", + "type": "string" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "description": "Unique identity of original media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "paymentMethodId": { + "description": "Unique identity of payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "originalMedia": { + "$ref": "#/components/schemas/Media" + }, + "paymentMethod": { + "$ref": "#/components/schemas/PaymentMethod" } }, - "responses": { - "200": { - "description": "List of MediaDefaultFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "type": "object" + }, + "AppScriptConditionJsonApi": { + "description": "Added since version: 6.4.10.3", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "identifier", + "active", + "appId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" + }, + "group": { + "description": "Categorizes script conditions within a specific group.", + "type": "string" + }, + "script": { + "description": "Internal field.", + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "app": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/app-script-condition/145c18275de1a9701ba31357e0bce9b5/app" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "app" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "d2a57dc1d883fd21fb9951699df71cc7" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaDefaultFolder" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/media-folder": { - "post": { - "tags": [ - "Media Folder" + ] + }, + "AppScriptCondition": { + "description": "Added since version: 6.4.10.3", + "required": [ + "id", + "identifier", + "active", + "appId", + "name" ], - "summary": "Aggregate for the Media Folder resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaFolder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", + "type": "string" + }, + "name": { + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", + "type": "boolean" + }, + "group": { + "description": "Categorizes script conditions within a specific group.", + "type": "string" + }, + "script": { + "description": "Internal field.", + "type": "string" + }, + "config": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "app": { + "$ref": "#/components/schemas/App" + }, + "ruleConditions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RuleCondition" } } }, - "responses": { - "200": { - "description": "List of MediaFolder", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" + "type": "object" + }, + "AppShippingMethodJsonApi": { + "description": "Added since version: 6.5.7.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "appName", + "identifier", + "shippingMethodId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "appName": { + "type": "string" + }, + "identifier": { + "type": "string" + }, + "appId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shippingMethodId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "originalMediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolder" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/media-folder-configuration": { - "post": { - "tags": [ - "Media Folder Configuration" - ], - "summary": "Aggregate for the Media Folder Configuration resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaFolderConfiguration", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of MediaFolderConfiguration", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaFolderConfiguration" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/media-thumbnail": { - "post": { - "tags": [ - "Media Thumbnail" + ] + }, + "AppShippingMethod": { + "description": "Added since version: 6.5.7.0", + "required": [ + "id", + "appName", + "identifier", + "shippingMethodId" ], - "summary": "Aggregate for the Media Thumbnail resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaThumbnail", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "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" } }, - "responses": { - "200": { - "description": "List of MediaThumbnail", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" + "type": "object" + }, + "AppTemplateJsonApi": { + "description": "Added since version: 6.3.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "template", + "path", + "active", + "appId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "description": "Template for an app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app template.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "app": { + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnail" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/media-thumbnail-size": { - "post": { - "tags": [ - "Media Thumbnail Size" + ] + }, + "AppTemplate": { + "description": "Added since version: 6.3.1.0", + "required": [ + "id", + "template", + "path", + "active", + "appId" ], - "summary": "Aggregate for the Media Thumbnail Size resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaThumbnailSize", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "template": { + "description": "Template for an app.", + "type": "string" + }, + "path": { + "description": "A relative URL to the app template.", + "type": "string" + }, + "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", + "type": "boolean" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "app": { + "$ref": "#/components/schemas/App" } }, - "responses": { - "200": { - "description": "List of MediaThumbnailSize", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "type": "object" + }, + "CategoryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media added to identify category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string" + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "type": "string" + }, + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" + }, + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "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": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "description": "Unique identity of product stream.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "parent": { + "description": "Unique identity of category.", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MediaThumbnailSize" + "type": "object" + }, + "children": { + "description": "Child categories within this category for hierarchical navigation", + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/newsletter-recipient": { - "post": { - "tags": [ - "Newsletter Recipient" - ], - "summary": "Aggregate for the Newsletter Recipient resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNewsletterRecipient", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NewsletterRecipient", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "type": "object" + }, + "media": { + "description": "Category image or banner", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NewsletterRecipient" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/notification": { - "post": { - "tags": [ - "Notification" - ], - "summary": "Aggregate for the Notification resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNotification", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Notification", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Notification" + "type": "object" + }, + "tags": { + "description": "Tags for organizing and filtering categories", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range": { - "post": { - "tags": [ - "Number Range" - ], - "summary": "Aggregate for the Number Range resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRange", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRange", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" + "type": "object" + }, + "cmsPage": { + "description": "CMS page layout for the category", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/cmsPage" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_page" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7b1460918b1abb93311108f3dc021c9b" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRange" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range-sales-channel": { - "post": { - "tags": [ - "Number Range Sales Channel" - ], - "summary": "Aggregate for the Number Range Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeSalesChannel" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range-state": { - "post": { - "tags": [ - "Number Range State" - ], - "summary": "Aggregate for the Number Range State resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeState", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeState" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/number-range-type": { - "post": { - "tags": [ - "Number Range Type" - ], - "summary": "Aggregate for the Number Range Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateNumberRangeType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of NumberRangeType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" + "type": "object" + }, + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/category/3adbdb3ac060038aa0e6e6c138ef9873/seoUrls" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "seo_url" + }, + "id": { + "type": "string", + "example": "5321b5a71127b8b98cdd4b068ad56c4c" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NumberRangeType" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/order": { - "post": { - "tags": [ - "Order" + ] + }, + "Category": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" ], - "summary": "Aggregate for the Order resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrder", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Order", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Order" - } - } - } - } - } + "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": { + "description": "Unique identity of the category under which the new category is to be created.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "afterCategoryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "description": "Unique identity of media added to identify category.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", + "type": "boolean" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "breadcrumb": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false + }, + "readOnly": true + }, + "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "path": { + "description": "A relative URL to the category.", + "type": "string", + "readOnly": true + }, + "childCount": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "type": { + "description": "Type of categories like `page`, `folder`, `link`.", + "type": "string" + }, + "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", + "type": "string" + }, + "visible": { + "description": "Displays categories on category page when true.", + "type": "boolean" + }, + "active": { + "description": "When boolean value is `true`, the category is listed for selection.", + "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": { + "description": "Unique identity of CMS page.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productStreamId": { + "description": "Unique identity of product stream.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customEntityTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "parent": { + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." + }, + "children": { + "description": "Child categories within this category for hierarchical navigation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" } }, - "400": { - "$ref": "#/components/responses/400" + "media": { + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-address": { - "post": { - "tags": [ - "Order Address" - ], - "summary": "Aggregate for the Order Address resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderAddress", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" } - } - }, - "responses": { - "200": { - "description": "List of OrderAddress", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderAddress" - } - } - } - } - } + }, + "nestedProducts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" } }, - "400": { - "$ref": "#/components/responses/400" + "tags": { + "description": "Tags for organizing and filtering categories", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-customer": { - "post": { - "tags": [ - "Order Customer" - ], - "summary": "Aggregate for the Order Customer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderCustomer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "cmsPage": { + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" + }, + "productStream": { + "$ref": "#/components/schemas/ProductStream" + }, + "navigationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" } - } - }, - "responses": { - "200": { - "description": "List of OrderCustomer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderCustomer" - } - } - } - } - } + }, + "footerSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" } }, - "400": { - "$ref": "#/components/responses/400" + "serviceSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-delivery": { - "post": { - "tags": [ - "Order Delivery" - ], - "summary": "Aggregate for the Order Delivery resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderDelivery", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "mainCategories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MainCategory" + } + }, + "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", + "type": "array", + "items": { + "$ref": "#/components/schemas/SeoUrl" } } }, - "responses": { - "200": { - "description": "List of OrderDelivery", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDelivery" - } - } - } - } - } - } + "type": "object" + }, + "CategoryTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "categoryId", + "tagId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "400": { - "$ref": "#/components/responses/400" + "categoryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "401": { - "$ref": "#/components/responses/401" + "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" } - } - } - }, - "/aggregate/order-delivery-position": { - "post": { - "tags": [ - "Order Delivery Position" - ], - "summary": "Aggregate for the Order Delivery Position resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderDeliveryPosition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + }, + "type": "object" + }, + "CmsBlockJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "sectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Unique name of the CMS Block.", + "type": "string" + }, + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" + }, + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" + }, + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" + }, + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" + }, + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderDeliveryPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "type": "object" + }, + "sectionId": { + "description": "Unique identity of section.", + "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": { + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderDeliveryPosition" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-line-item": { - "post": { - "tags": [ - "Order Line Item" - ], - "summary": "Aggregate for the Order Line Item resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderLineItem", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderLineItem", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItem" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-line-item-download": { - "post": { - "tags": [ - "Order Line Item Download" - ], - "summary": "Aggregate for the Order Line Item Download resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderLineItemDownload", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "type": "object" } }, - "required": [ - "aggregations" - ] + "type": "object" } - } + }, + "type": "object" } - }, - "responses": { - "200": { - "description": "List of OrderLineItemDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } - ] - } + ] + }, + "CmsBlock": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "sectionId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Unique name of the CMS Block.", + "type": "string" + }, + "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", + "type": "string" + }, + "marginTop": { + "description": "Defines the margin area on the top of an element.", + "type": "string" + }, + "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", + "type": "string" + }, + "marginLeft": { + "description": "Defines for the margin area on the left of an element.", + "type": "string" + }, + "marginRight": { + "description": "Defines the margin area on the right of an element.", + "type": "string" + }, + "backgroundColor": { + "description": "Defines the background color of an element.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderLineItemDownload" - } - } - } - } + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" } - } + }, + "type": "object" }, - "400": { - "$ref": "#/components/responses/400" + "sectionId": { + "description": "Unique identity of section.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction": { - "post": { - "tags": [ - "Order Transaction" - ], - "summary": "Aggregate for the Order Transaction resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransaction", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "customFields": { + "type": "object" + }, + "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" } } }, - "responses": { - "200": { - "description": "List of OrderTransaction", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" + "type": "object" + }, + "CmsPageJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" + }, + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" + } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "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" + }, + "extensions": { + "properties": { + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransaction" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction-capture": { - "post": { - "tags": [ - "Order Transaction Capture" - ], - "summary": "Aggregate for the Order Transaction Capture resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCapture", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "type": "object" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCapture", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "type": "object" + }, + "relationships": { + "properties": { + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/sections" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "cms_section" + }, + "id": { + "type": "string", + "example": "ff4dee88db82e98f0e0d524d965b9aa7" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCapture" + "type": "object" + }, + "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction-capture-refund": { - "post": { - "tags": [ - "Order Transaction Capture Refund" - ], - "summary": "Aggregate for the Order Transaction Capture Refund resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCaptureRefund", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefund", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefund" + "type": "object" + }, + "landingPages": { + "description": "Landing pages using this CMS layout", + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/order-transaction-capture-refund-position": { - "post": { - "tags": [ - "Order Transaction Capture Refund Position" - ], - "summary": "Aggregate for the Order Transaction Capture Refund Position resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderTransactionCaptureRefundPosition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of OrderTransactionCaptureRefundPosition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrderTransactionCaptureRefundPosition" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/payment-method": { - "post": { - "tags": [ - "Payment Method" + ] + }, + "CmsPage": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type" ], - "summary": "Aggregate for the Payment Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePaymentMethod", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", + "type": "string" + }, + "entity": { + "description": "This field will be implemented in the future.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "config": { + "properties": { + "backgroundColor": { + "type": "string" } - } - } - }, - "responses": { - "200": { - "description": "List of PaymentMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" - } - } + }, + "type": "object" + }, + "previewMediaId": { + "description": "Unique identity of media to be previewed.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFields": { + "type": "object" + }, + "locked": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "extensions": { + "properties": { + "createdBy": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" } } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PaymentMethod" + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "user" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "34998857f537140306898d54d4b970dc" } } } - } + }, + "type": "object" } + }, + "type": "object" + }, + "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsSection" } }, - "400": { - "$ref": "#/components/responses/400" + "previewMedia": { + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, - "401": { - "$ref": "#/components/responses/401" + "categories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Category" + } + }, + "landingPages": { + "description": "Landing pages using this CMS layout", + "type": "array", + "items": { + "$ref": "#/components/schemas/LandingPage" + } + }, + "homeSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } + }, + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } - } - } - }, - "/aggregate/plugin": { - "post": { - "tags": [ - "Plugin" - ], - "summary": "Aggregate for the Plugin resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePlugin", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + }, + "type": "object" + }, + "CmsSectionJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "position", + "type", + "pageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Name of the CMS section defined.", + "type": "string" + }, + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", + "type": "string" + }, + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" + }, + "backgroundColor": { + "description": "Background color of CMS page.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "pageId": { + "description": "Unique identity of page where CMS section is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "mobile": { + "type": "boolean" + }, + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Plugin", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" + "type": "object" + }, + "customFields": { + "type": "object" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "dsrSlideExtension": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_cms_slide" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f7b1c34af8f346efae2c5862529520d8" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plugin" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product": { - "post": { - "tags": [ - "Product" - ], - "summary": "Aggregate for the Product resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProduct", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "type": "object" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Product", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "type": "object" + }, + "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", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-configurator-setting": { - "post": { - "tags": [ - "Product Configurator Setting" - ], - "summary": "Aggregate for the Product Configurator Setting resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductConfiguratorSetting", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + }, + "type": "object" } }, - "required": [ - "aggregations" - ] + "type": "object" } - } + }, + "type": "object" } - }, - "responses": { - "200": { - "description": "List of ProductConfiguratorSetting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } - ] - } + ] + }, + "CmsSection": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "position", + "type", + "pageId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", + "type": "integer", + "format": "int64" + }, + "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "name": { + "description": "Name of the CMS section defined.", + "type": "string" + }, + "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", + "type": "string" + }, + "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", + "type": "string" + }, + "backgroundColor": { + "description": "Background color of CMS page.", + "type": "string" + }, + "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", + "type": "string" + }, + "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", + "type": "string" + }, + "pageId": { + "description": "Unique identity of page where CMS section is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "visibility": { + "properties": { + "mobile": { + "type": "boolean" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductConfiguratorSetting" - } - } - } - } + "desktop": { + "type": "boolean" + }, + "tablet": { + "type": "boolean" } - } + }, + "type": "object" }, - "400": { - "$ref": "#/components/responses/400" + "customFields": { + "type": "object" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-cross-selling": { - "post": { - "tags": [ - "Product Cross Selling" - ], - "summary": "Aggregate for the Product Cross Selling resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductCrossSelling", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "dsrSlideExtension": { "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductCrossSelling", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" - } - } + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" } } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSelling" + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_cms_slide" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f7b1c34af8f346efae2c5862529520d8" } } } - } + }, + "type": "object" } - } + }, + "type": "object" }, - "400": { - "$ref": "#/components/responses/400" + "page": { + "$ref": "#/components/schemas/CmsPage" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-cross-selling-assigned-products": { - "post": { - "tags": [ - "Product Cross Selling Assigned Products" - ], - "summary": "Aggregate for the Product Cross Selling Assigned Products resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductCrossSellingAssignedProducts", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "backgroundMedia": { + "$ref": "#/components/schemas/Media" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CmsBlock" } } }, - "responses": { - "200": { - "description": "List of ProductCrossSellingAssignedProducts", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductCrossSellingAssignedProducts" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" + "type": "object" + }, + "CmsSlotJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-download": { - "post": { - "tags": [ - "Product Download" - ], - "summary": "Aggregate for the Product Download resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductDownload", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { + { + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "type": "string" + }, + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductDownload", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductDownload" - } - } + "type": "object" } - } + }, + "type": "object" } - } + }, + "type": "object" + } + ] + }, + "CmsSlot": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "type", + "slot", + "blockId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "400": { - "$ref": "#/components/responses/400" + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "401": { - "$ref": "#/components/responses/401" + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, + "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", + "type": "string" + }, + "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "config": { + "type": "object" + }, + "customFields": { + "type": "object" + }, + "data": { + "type": "object", + "readOnly": true + }, + "blockId": { + "description": "Unique identity of CMS block where slot is defined.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "block": { + "$ref": "#/components/schemas/CmsBlock" } - } - } - }, - "/aggregate/product-export": { - "post": { - "tags": [ - "Product Export" - ], - "summary": "Aggregate for the Product Export resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductExport", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + }, + "type": "object" + }, + "CountryJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "addressFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" + }, + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" + }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" } }, + "type": "object" + }, + "companyTax": { "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductExport", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" + } + }, + "type": "object" + }, + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "relationships": { + "properties": { + "states": { + "description": "States/provinces/regions within the country", + "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", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductExport" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-feature-set": { - "post": { - "tags": [ - "Product Feature Set" - ], - "summary": "Aggregate for the Product Feature Set resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductFeatureSet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductFeatureSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductFeatureSet" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-keyword-dictionary": { - "post": { - "tags": [ - "Product Keyword Dictionary" - ], - "summary": "Aggregate for the Product Keyword Dictionary resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductKeywordDictionary", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductKeywordDictionary", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductKeywordDictionary" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/product-manufacturer": { - "post": { - "tags": [ - "Product Manufacturer" + ] + }, + "Country": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "addressFormat" ], - "summary": "Aggregate for the Product Manufacturer resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductManufacturer", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", + "type": "boolean" + }, + "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", + "type": "boolean" + }, + "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", + "type": "string" + }, + "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", + "type": "boolean" + }, + "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", + "type": "boolean" + }, + "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", + "type": "boolean" + }, + "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", + "type": "boolean" + }, + "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", + "type": "string" + }, + "customFields": { + "type": "object" + }, + "customerTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" + }, + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" } - } - } - }, - "responses": { - "200": { - "description": "List of ProductManufacturer", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } - ] - } + }, + "type": "object" + }, + "companyTax": { + "required": [ + "enabled", + "currencyId", + "amount" + ], + "properties": { + "enabled": { + "type": "boolean" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductManufacturer" - } - } - } - } + "currencyId": { + "type": "string" + }, + "amount": { + "type": "number", + "format": "float" } + }, + "type": "object" + }, + "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", + "type": "boolean" + }, + "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", + "type": "boolean" + }, + "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", + "type": "boolean" + }, + "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", + "type": "string" + }, + "addressFormat": { + "type": "object" + }, + "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", + "type": "string" + }, + "isEu": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "translated": { + "type": "object" + }, + "states": { + "description": "States/provinces/regions within the country", + "type": "array", + "items": { + "$ref": "#/components/schemas/CountryState" } }, - "400": { - "$ref": "#/components/responses/400" + "customerAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-media": { - "post": { - "tags": [ - "Product Media" - ], - "summary": "Aggregate for the Product Media resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductMedia", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "orderAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderAddress" } - } - }, - "responses": { - "200": { - "description": "List of ProductMedia", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductMedia" - } - } - } - } - } + }, + "salesChannelDefaultAssignments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" } }, - "400": { - "$ref": "#/components/responses/400" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-price": { - "post": { - "tags": [ - "Product Price" - ], - "summary": "Aggregate for the Product Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductPrice", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "taxRules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TaxRule" + } + }, + "currencyCountryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" } } }, - "responses": { - "200": { - "description": "List of ProductPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "type": "object" + }, + "CountryStateJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "countryId", + "shortCode", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "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", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductPrice" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/product-review": { - "post": { - "tags": [ - "Product Review" - ], - "summary": "Aggregate for the Product Review resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReview", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + ] + }, + "CountryState": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "countryId", + "shortCode", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of the country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "shortCode": { + "description": "An abbreviation for the country's state.", + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, + "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", + "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" } } }, - "responses": { - "200": { - "description": "List of ProductReview", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductReview" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" + "type": "object" + }, + "CurrencyJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-search-config": { - "post": { - "tags": [ - "Product Search Config" - ], - "summary": "Aggregate for the Product Search Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchConfig", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + { + "required": [ + "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" + }, + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "type": "string" + }, + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" + }, + "shortName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - ] - } + "type": "object" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-search-config-field": { - "post": { - "tags": [ - "Product Search Config Field" - ], - "summary": "Aggregate for the Product Search Config Field resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchConfigField", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchConfigField", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-search-keyword": { - "post": { - "tags": [ - "Product Search Keyword" - ], - "summary": "Aggregate for the Product Search Keyword resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSearchKeyword", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSearchKeyword", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchKeyword" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-sorting": { - "post": { - "tags": [ - "Product Sorting" - ], - "summary": "Aggregate for the Product Sorting resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductSorting", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductSorting", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSorting" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-stream": { - "post": { - "tags": [ - "Product Stream" - ], - "summary": "Aggregate for the Product Stream resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductStream", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ProductStream", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStream" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/product-stream-filter": { - "post": { - "tags": [ - "Product Stream Filter" + ] + }, + "Currency": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "factor", + "symbol", + "isoCode", + "itemRounding", + "totalRounding", + "shortName", + "name" ], - "summary": "Aggregate for the Product Stream Filter resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductStreamFilter", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "factor": { + "description": "Currency exchange rate.", + "type": "number", + "format": "float" + }, + "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", + "type": "string" + }, + "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", + "type": "string" + }, + "shortName": { + "type": "string" + }, + "name": { + "type": "string" + }, + "position": { + "description": "The order of the tabs for multiple currencies defined.", + "type": "integer", + "format": "int64" + }, + "isSystemDefault": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", + "type": "number", + "format": "float" + }, + "customFields": { + "type": "object" + }, + "itemRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } - } - } - }, - "responses": { - "200": { - "description": "List of ProductStreamFilter", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } - ] - } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductStreamFilter" - } - } - } - } + "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" } }, - "400": { - "$ref": "#/components/responses/400" + "orders": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Order" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/product-visibility": { - "post": { - "tags": [ - "Product Visibility" - ], - "summary": "Aggregate for the Product Visibility resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductVisibility", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" } - } - }, - "responses": { - "200": { - "description": "List of ProductVisibility", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductVisibility" - } - } - } - } - } + }, + "salesChannelDomains": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannelDomain" } }, - "400": { - "$ref": "#/components/responses/400" + "promotionDiscountPrices": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PromotionDiscountPrices" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion": { - "post": { - "tags": [ - "Promotion" - ], - "summary": "Aggregate for the Promotion resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotion", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "productExports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductExport" + } + }, + "countryRoundings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CurrencyCountryRounding" } } }, - "responses": { - "200": { - "description": "List of Promotion", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Promotion" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" + "type": "object" + }, + "CurrencyCountryRoundingJsonApi": { + "description": "Added since version: 6.4.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-discount": { - "post": { - "tags": [ - "Promotion Discount" - ], - "summary": "Aggregate for the Promotion Discount resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionDiscount", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + { + "required": [ + "id", + "currencyId", + "countryId", + "itemRounding", + "totalRounding" + ], + "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": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionDiscount", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - } - ] - } + "type": "object" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscount" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-discount-prices": { - "post": { - "tags": [ - "Promotion Discount Prices" - ], - "summary": "Aggregate for the Promotion Discount Prices resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionDiscountPrices", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "decimals": { + "type": "integer", + "format": "int64" + }, + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionDiscountPrices", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionDiscountPrices" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/promotion-individual-code": { - "post": { - "tags": [ - "Promotion Individual Code" + ] + }, + "CurrencyCountryRounding": { + "description": "Added since version: 6.4.0.0", + "required": [ + "id", + "currencyId", + "countryId", + "itemRounding", + "totalRounding" ], - "summary": "Aggregate for the Promotion Individual Code resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionIndividualCode", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] + "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" } - } - } - }, - "responses": { - "200": { - "description": "List of PromotionIndividualCode", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - } - ] - } + }, + "type": "object" + }, + "totalRounding": { + "required": [ + "decimals", + "interval", + "roundForNet" + ], + "properties": { + "decimals": { + "type": "integer", + "format": "int64" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionIndividualCode" - } - } - } - } + "interval": { + "type": "number", + "format": "float" + }, + "roundForNet": { + "type": "boolean" } - } + }, + "type": "object" }, - "400": { - "$ref": "#/components/responses/400" + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/promotion-sales-channel": { - "post": { - "tags": [ - "Promotion Sales Channel" - ], - "summary": "Aggregate for the Promotion Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "currency": { + "$ref": "#/components/schemas/Currency" + }, + "country": { + "$ref": "#/components/schemas/Country" } }, - "responses": { - "200": { - "description": "List of PromotionSalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - } - ] - } + "type": "object" + }, + "CustomEntityJsonApi": { + "description": "Added since version: 6.4.9.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "fields" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSalesChannel" - } - } - } - } + "name": { + "description": "Unique name of the entity.", + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" + }, + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/promotion-setgroup": { - "post": { - "tags": [ - "Promotion Setgroup" + ] + }, + "CustomEntity": { + "description": "Added since version: 6.4.9.0", + "required": [ + "id", + "name", + "fields" ], - "summary": "Aggregate for the Promotion Setgroup resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePromotionSetgroup", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of the entity.", + "type": "string" + }, + "fields": { + "type": "object" + }, + "flags": { + "type": "object" + }, + "appId": { + "description": "Unique identity of app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "pluginId": { + "description": "Unique identity of plugin.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "storeApiAware": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, + "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", + "type": "boolean" + }, + "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", + "type": "string" + }, + "deletedAt": { + "type": "string", + "format": "date-time" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true } }, - "responses": { - "200": { - "description": "List of PromotionSetgroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "type": "object" + }, + "CustomFieldJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "type" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field.", + "type": "string" + }, + "type": { + "description": "Custom field type can be selection, media , etc", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" + }, + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" + }, + "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PromotionSetgroup" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/property-group": { - "post": { - "tags": [ - "Property Group" + ] + }, + "CustomField": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "type" ], - "summary": "Aggregate for the Property Group resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePropertyGroup", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field.", + "type": "string" + }, + "type": { + "description": "Custom field type can be selection, media , etc", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", + "type": "boolean" + }, + "customFieldSetId": { + "description": "Unique identity of customFieldSet.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", + "type": "boolean" + }, + "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", + "type": "boolean" + }, + "storeApiAware": { + "type": "boolean" + }, + "includeInSearch": { + "type": "boolean" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" + }, + "productSearchConfigFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductSearchConfigField" } } }, - "responses": { - "200": { - "description": "List of PropertyGroup", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" + "type": "object" + }, + "CustomFieldSetJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field set.", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" + }, + "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" + }, + "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", + "type": "integer", + "format": "int64" + }, + "appId": { + "description": "Unique identity of an app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFields": { + "properties": { + "links": { + "type": "object", + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/property-group-option": { - "post": { - "tags": [ - "Property Group Option" - ], - "summary": "Aggregate for the Property Group Option resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregatePropertyGroupOption", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of PropertyGroupOption", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" + "type": "object" + }, + "relations": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/custom-field-set/9f7fdf62a1b51e5a8e6f99cb5e5e86b1/relations" } } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroupOption" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/rule": { - "post": { - "tags": [ - "Rule" - ], - "summary": "Aggregate for the Rule resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateRule", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Rule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "custom_field_set_relation" + }, + "id": { + "type": "string", + "example": "06c5b10273a69992d8c6933e294909fa" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Rule" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/rule-condition": { - "post": { - "tags": [ - "Rule Condition" - ], - "summary": "Aggregate for the Rule Condition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateRuleCondition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of RuleCondition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RuleCondition" - } - } + "type": "object" } - } + }, + "type": "object" } + }, + "type": "object" + } + ] + }, + "CustomFieldSet": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Unique name of a custom field set.", + "type": "string" + }, + "config": { + "type": "object" + }, + "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", + "type": "boolean" + }, + "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", + "type": "boolean" + }, + "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", + "type": "integer", + "format": "int64" + }, + "appId": { + "description": "Unique identity of an app.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomField" } }, - "400": { - "$ref": "#/components/responses/400" + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomFieldSetRelation" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel": { - "post": { - "tags": [ - "Sales Channel" - ], - "summary": "Aggregate for the Sales Channel resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannel", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "products": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" } + }, + "app": { + "$ref": "#/components/schemas/App" } }, - "responses": { - "200": { - "description": "List of SalesChannel", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" + "type": "object" + }, + "CustomFieldSetRelationJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customFieldSetId", + "entityName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "description": "Unique identity of a custom field set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "description": "Name of the entity.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "customFieldSet": { + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/sales-channel-analytics": { - "post": { - "tags": [ - "Sales Channel Analytics" + ] + }, + "CustomFieldSetRelation": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customFieldSetId", + "entityName" ], - "summary": "Aggregate for the Sales Channel Analytics resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelAnalytics", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customFieldSetId": { + "description": "Unique identity of a custom field set.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "entityName": { + "description": "Name of the entity.", + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "customFieldSet": { + "$ref": "#/components/schemas/CustomFieldSet" } }, - "responses": { - "200": { - "description": "List of SalesChannelAnalytics", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" + "type": "object" + }, + "CustomerJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "email": { + "description": "Email ID of the customer.", + "type": "string" + }, + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" + }, + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Password hash for customer recovery.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "attendee": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelAnalytics" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel-domain": { - "post": { - "tags": [ - "Sales Channel Domain" - ], - "summary": "Aggregate for the Sales Channel Domain resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelDomain", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "type": "object" } }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SalesChannelDomain", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "type": "object" + }, + "relationships": { + "properties": { + "group": { + "description": "Customer group determining pricing and permissions", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelDomain" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/sales-channel-type": { - "post": { - "tags": [ - "Sales Channel Type" - ], - "summary": "Aggregate for the Sales Channel Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalesChannelType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SalesChannelType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelType" + "type": "object" + }, + "language": { + "description": "Preferred language for customer communication", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannelType" + "type": "object" + }, + "lastPaymentMethod": { + "description": "Last used payment method by the customer", + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/salutation": { - "post": { - "tags": [ - "Salutation" - ], - "summary": "Aggregate for the Salutation resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSalutation", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Salutation", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" + "type": "object" + }, + "defaultBillingAddress": { + "description": "Default billing address for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" } } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Salutation" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/scheduled-task": { - "post": { - "tags": [ - "Scheduled Task" - ], - "summary": "Aggregate for the Scheduled Task resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateScheduledTask", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ScheduledTask", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "263d0f6e5d8d71fc4c288736f7c90990" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ScheduledTask" + "type": "object" + }, + "activeBillingAddress": { + "description": "Currently active billing address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "1a4362407b6a71fa80952dcd4ba7feb3" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/script": { - "post": { - "tags": [ - "Script" - ], - "summary": "Aggregate for the Script resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateScript", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Script", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" + "type": "object" + }, + "defaultShippingAddress": { + "description": "Default shipping address for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "8218c377171d06883caea7e2baf67f31" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Script" + "type": "object" + }, + "activeShippingAddress": { + "description": "Currently active shipping address in the session", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f6e2f5dd29b543b8547e30d2d71a6974" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/seo-url": { - "post": { - "tags": [ - "Seo Url" - ], - "summary": "Aggregate for the Seo Url resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrl", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SeoUrl", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" + "type": "object" + }, + "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salutation" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "salutation" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "7a6efb02514153b5aa9a8f40c6f8bcc3" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrl" + "type": "object" + }, + "addresses": { + "description": "All addresses saved for the customer", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/addresses" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer_address" + }, + "id": { + "type": "string", + "example": "963e3a2fe559e393bad631f3dc686f69" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/seo-url-template": { - "post": { - "tags": [ - "Seo Url Template" - ], - "summary": "Aggregate for the Seo Url Template resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSeoUrlTemplate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SeoUrlTemplate", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SeoUrlTemplate" + "type": "object" + }, + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/tags" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "tag" + }, + "id": { + "type": "string", + "example": "d57ac45256849d9b13e2422d91580fb9" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/shipping-method": { - "post": { - "tags": [ - "Shipping Method" - ], - "summary": "Aggregate for the Shipping Method resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethod", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ShippingMethod", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethod" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/shipping-method-price": { - "post": { - "tags": [ - "Shipping Method Price" - ], - "summary": "Aggregate for the Shipping Method Price resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateShippingMethodPrice", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of ShippingMethodPrice", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ShippingMethodPrice" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/snippet": { - "post": { - "tags": [ - "Snippet" - ], - "summary": "Aggregate for the Snippet resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Snippet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Snippet" + "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" + } + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/snippet-set": { - "post": { - "tags": [ - "Snippet Set" - ], - "summary": "Aggregate for the Snippet Set resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSnippetSet", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SnippetSet", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SnippetSet" + "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" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/state-machine": { - "post": { - "tags": [ - "State Machine" + ] + }, + "Customer": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "groupId", + "salesChannelId", + "languageId", + "defaultBillingAddressId", + "defaultShippingAddressId", + "customerNumber", + "firstName", + "lastName", + "email" ], - "summary": "Aggregate for the State Machine resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachine", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "groupId": { + "description": "Unique identity of customer group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "languageId": { + "description": "Unique identity of language.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "autoIncrement": { + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customerNumber": { + "description": "Unique number assigned to identity a customer.", + "type": "string" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "email": { + "description": "Email ID of the customer.", + "type": "string" + }, + "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", + "type": "string" + }, + "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", + "type": "string" + }, + "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", + "type": "string" + }, + "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", + "type": "boolean" + }, + "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", + "type": "boolean" + }, + "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", + "type": "string", + "format": "date-time" + }, + "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", + "type": "string", + "format": "date-time" + }, + "hash": { + "description": "Password hash for customer recovery.", + "type": "string" + }, + "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", + "type": "boolean" + }, + "firstLogin": { + "description": "To capture date and time of customer's first login.", + "type": "string", + "format": "date-time" + }, + "lastLogin": { + "description": "To capture date and time of customer's last login.", + "type": "string", + "format": "date-time" + }, + "birthday": { + "description": "To capture customer's birthday details.", + "type": "string" + }, + "lastOrderDate": { + "description": "Captures last order date.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "orderCount": { + "description": "Captures the number of orders placed.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "orderTotalAmount": { + "description": "Sum of total amount to be paid.", + "type": "number", + "format": "float", + "readOnly": true + }, + "reviewCount": { + "description": "Number of reviews the customer has given.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "customFields": { + "type": "object" + }, + "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", + "type": "string" + }, + "tagIds": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "readOnly": true + }, + "requestedGroupId": { + "description": "Unique identity of requested group.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "updatedById": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "extensions": { + "properties": { + "attendee": { "properties": { - "aggregations": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" + } + } + }, + "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of StateMachine", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { "type": "object", "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } + "type": { + "type": "string", + "example": "dsr_appointment_attendee" + }, + "id": { + "type": "string", + "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" } } } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachine" - } - } } - } + }, + "type": "object" } - } + }, + "type": "object" }, - "400": { - "$ref": "#/components/responses/400" + "group": { + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine-history": { - "post": { - "tags": [ - "State Machine History" - ], - "summary": "Aggregate for the State Machine History resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineHistory", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "salesChannel": { + "$ref": "#/components/schemas/SalesChannel" + }, + "language": { + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" + }, + "lastPaymentMethod": { + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" + }, + "defaultBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" + }, + "activeBillingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" + }, + "defaultShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" + }, + "activeShippingAddress": { + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" + }, + "salutation": { + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" + }, + "addresses": { + "description": "All addresses saved for the customer", + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomerAddress" } - } - }, - "responses": { - "200": { - "description": "List of StateMachineHistory", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineHistory" - } - } - } - } - } + }, + "orderCustomers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OrderCustomer" } }, - "400": { - "$ref": "#/components/responses/400" + "tags": { + "description": "Tags assigned to the customer for organization and segmentation", + "type": "array", + "items": { + "$ref": "#/components/schemas/Tag" + } }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine-state": { - "post": { - "tags": [ - "State Machine State" - ], - "summary": "Aggregate for the State Machine State resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineState", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "promotions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Promotion" } - } - }, - "responses": { - "200": { - "description": "List of StateMachineState", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineState" - } - } - } - } - } + }, + "productReviews": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ProductReview" } }, - "400": { - "$ref": "#/components/responses/400" + "recoveryCustomer": { + "$ref": "#/components/schemas/CustomerRecovery" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/state-machine-transition": { - "post": { - "tags": [ - "State Machine Transition" - ], - "summary": "Aggregate for the State Machine Transition resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateStateMachineTransition", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "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" } }, - "responses": { - "200": { - "description": "List of StateMachineTransition", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StateMachineTransition" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" + "type": "object" + }, + "CustomerAddressJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/system-config": { - "post": { - "tags": [ - "System Config" - ], - "summary": "Aggregate for the System Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateSystemConfig", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", + { + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "description": "Unique identity of customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" + }, + "city": { + "description": "Name of customer's city.", + "type": "string" + }, + "company": { + "description": "Name of customer's company.", + "type": "string" + }, + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "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": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of SystemConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" + "customer": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/customer-address/1b4b031005f93d02d887e7d66efb653b/customer" } } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SystemConfig" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/tag": { - "post": { - "tags": [ - "Tag" - ], - "summary": "Aggregate for the Tag resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTag", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Tag", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "customer" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "91ec1f9324753048c0096d036a694f86" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/tax": { - "post": { - "tags": [ - "Tax" - ], - "summary": "Aggregate for the Tax resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTax", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Tax", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tax" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tax" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/tax-provider": { - "post": { - "tags": [ - "Tax Provider" - ], - "summary": "Aggregate for the Tax Provider resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxProvider", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of TaxProvider", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxProvider" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/tax-rule": { - "post": { - "tags": [ - "Tax Rule" - ], - "summary": "Aggregate for the Tax Rule resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRule", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } + "type": "object" } }, - "required": [ - "aggregations" - ] + "type": "object" } - } + }, + "type": "object" } - }, - "responses": { - "200": { - "description": "List of TaxRule", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + ] + }, + "CustomerAddress": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "customerId", + "countryId", + "firstName", + "lastName", + "city", + "street" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "description": "Unique identity of customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryId": { + "description": "Unique identity of country.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "countryStateId": { + "description": "Unique identity of country's state.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salutationId": { + "description": "Unique identity of salutation.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "firstName": { + "description": "First name of the customer.", + "type": "string" + }, + "lastName": { + "description": "Last name of the customer.", + "type": "string" + }, + "zipcode": { + "description": "Postal or zip code of customer's address.", + "type": "string" + }, + "city": { + "description": "Name of customer's city.", + "type": "string" + }, + "company": { + "description": "Name of customer's company.", + "type": "string" + }, + "street": { + "description": "Name of customer's street.", + "type": "string" + }, + "department": { + "description": "Name of customer's department.", + "type": "string" + }, + "title": { + "description": "Titles given to customer like Dr. , Prof., etc", + "type": "string" + }, + "phoneNumber": { + "description": "Customer's phone number.", + "type": "string" + }, + "additionalAddressLine1": { + "description": "Additional customer's address information.", + "type": "string" + }, + "additionalAddressLine2": { + "description": "Additional customer's address information.", + "type": "string" + }, + "hash": { + "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 + }, + "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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "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", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRule" + "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", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", + "type": "boolean" + }, + "customFields": { + "type": "object" + }, + "registrationActive": { + "description": "To enable the registration of partner customer group.", + "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" } }, - "400": { - "$ref": "#/components/responses/400" + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } }, - "401": { - "$ref": "#/components/responses/401" + "registrationSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SalesChannel" + } } - } - } - }, - "/aggregate/tax-rule-type": { - "post": { - "tags": [ - "Tax Rule Type" + }, + "type": "object" + }, + "CustomerGroupRegistrationSalesChannels": { + "description": "Added since version: 6.3.1.0", + "required": [ + "customerGroupId", + "salesChannelId" ], - "summary": "Aggregate for the Tax Rule Type resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTaxRuleType", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "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" } }, - "responses": { - "200": { - "description": "List of TaxRuleType", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" + "type": "object" + }, + "CustomerRecoveryJsonApi": { + "description": "Added since version: 6.1.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "hash", + "customerId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "hash": { + "description": "Password hash for customer's account recovery.", + "type": "string" + }, + "customerId": { + "description": "Unique identity of the customer.", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TaxRuleType" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/theme": { - "post": { - "tags": [ - "Theme" + ] + }, + "CustomerRecovery": { + "description": "Added since version: 6.1.0.0", + "required": [ + "id", + "hash", + "customerId" ], - "summary": "Aggregate for the Theme resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateTheme", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Theme", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Theme" - } - } - } - } - } - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "400": { - "$ref": "#/components/responses/400" + "hash": { + "description": "Password hash for customer's account recovery.", + "type": "string" }, - "401": { - "$ref": "#/components/responses/401" + "customerId": { + "description": "Unique identity of the customer.", + "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" } - } - } - }, - "/aggregate/unit": { - "post": { - "tags": [ - "Unit" + }, + "type": "object" + }, + "CustomerTag": { + "description": "Added since version: 6.0.0.0", + "required": [ + "customerId", + "tagId" ], - "summary": "Aggregate for the Unit resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUnit", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + "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" } }, - "responses": { - "200": { - "description": "List of Unit", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "type": "object" + }, + "CustomerWishlistJsonApi": { + "description": "Added since version: 6.3.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "customerId", + "salesChannelId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "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", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Unit" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Unit" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/user": { - "post": { - "tags": [ - "User" + ] + }, + "CustomerWishlist": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "customerId", + "salesChannelId" ], - "summary": "Aggregate for the User resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUser", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "description": "Unique identity of the customer.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of the sales channel.", + "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" } }, - "responses": { - "200": { - "description": "List of User", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" + "type": "object" + }, + "CustomerWishlistProductJsonApi": { + "description": "Added since version: 6.3.4.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "productId", + "wishlistId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "description": "Unique identity of the wishlist.", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/user-access-key": { - "post": { - "tags": [ - "User Access Key" - ], - "summary": "Aggregate for the User Access Key resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserAccessKey", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } + ] + }, + "CustomerWishlistProduct": { + "description": "Added since version: 6.3.4.0", + "required": [ + "id", + "productId", + "wishlistId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "description": "Unique identity of the product.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "wishlistId": { + "description": "Unique identity of the wishlist.", + "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" } }, - "responses": { - "200": { - "description": "List of UserAccessKey", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" + "type": "object" + }, + "DeliveryTimeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "name", + "min", + "max", + "unit" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" + }, + "max": { + "description": "Maximum delivery time taken.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessKey" - } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/user-config": { - "post": { - "tags": [ - "User Config" - ], - "summary": "Aggregate for the User Config resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateUserConfig", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of UserConfig", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserConfig" + "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" + } } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserConfig" - } - } + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/user-recovery": { - "post": { - "tags": [ - "User Recovery" + ] + }, + "DeliveryTime": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "name", + "min", + "max", + "unit" ], - "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" - ] - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "min": { + "description": "Minimum delivery time taken.", + "type": "integer", + "format": "int64" + }, + "max": { + "description": "Maximum delivery time taken.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", + "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" } } }, - "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" + "type": "object" + }, + "DocumentJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentTypeId", + "orderId", + "config", + "deepLinkCode" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentA11yMediaFileId": { + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserRecovery" + "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" + } + } } - } - } - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/webhook": { - "post": { - "tags": [ - "Webhook" - ], - "summary": "Aggregate for the Webhook resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhook", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } - } - } - }, - "responses": { - "200": { - "description": "List of Webhook", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Webhook" + "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" + }, + "documentA11yMediaFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0ea973a1104089c9d0f93bdb06c47cab" + } + } + } + }, + "type": "object" } - } + }, + "type": "object" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" + }, + "type": "object" } - } - } - }, - "/aggregate/webhook-event-log": { - "post": { - "tags": [ - "Webhook Event Log" + ] + }, + "Document": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentTypeId", + "orderId", + "config", + "deepLinkCode" ], - "summary": "Aggregate for the Webhook Event Log resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateWebhookEventLog", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "aggregations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Aggregation" - } - } - }, - "required": [ - "aggregations" - ] - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "referencedDocumentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "orderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentMediaFileId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentA11yMediaFileId": { + "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" + }, + "documentA11yMediaFile": { + "$ref": "#/components/schemas/Media" } }, - "responses": { - "200": { - "description": "List of WebhookEventLog", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "type": "object" + }, + "DocumentBaseConfigJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentTypeId", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "description": "Unique identity of the document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "logoId": { + "description": "Unique identity of the company logo.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the document.", + "type": "string" + }, + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" + }, + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" + }, + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", + "type": "boolean" + }, + "documentNumber": { + "description": "Unique number associated with every document.", + "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", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "type": "object" + }, + "logo": { + "description": "Logo in the document at the top-right corner.", + "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" } } } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WebhookEventLog" + "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" } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/join-as-guide": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Join a meeting as a guide", - "description": "This route is used to join appointment as guide.", - "operationId": "joinAppointmentAsGuide", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + }, + "type": "object" } + ] + }, + "DocumentBaseConfig": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentTypeId", + "name" ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/JoinAppointmentResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/start": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Start a presentation for a appointment", - "description": "Complete all needed data start the presentation", - "operationId": "startAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "204": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/end": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "End a presentation for a appointment", - "description": "Complete all needed data and remove unneeded to close the presentation", - "operationId": "endAppointment", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "description": "Unique identity of the document type.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "logoId": { + "description": "Unique identity of the company logo.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "description": "Name of the document.", + "type": "string" + }, + "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", + "type": "string" + }, + "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", + "type": "string" + }, + "global": { + "description": "When set to `true`, the document can be used across all sales channels.", + "type": "boolean" + }, + "documentNumber": { + "description": "Unique number associated with every document.", + "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", + "description": "Logo in the document at the top-right corner." + }, + "salesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } } - ], - "responses": { - "200": { - "description": "" - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/sw-context-token": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the sw-context-token for a attendee", - "description": "Returns the context-token for the given attendee if the attendee granted the permission for the cart", - "operationId": "getAttendeeToken", - "parameters": [ + }, + "type": "object" + }, + "DocumentBaseConfigSalesChannelJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "The sw-context-token from the attendee", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "attendee-sw-context-token": { - "type": "string" - } - }, - "example": { - "attendee-sw-context-token": "context token of attendee" - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/instant-listing": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add a instant listing to the presentation", - "description": "Add a page as the instant listing to the presentation", - "operationId": "addInstantListing", - "parameters": [ + "$ref": "#/components/schemas/resource" + }, { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "productIds" - ], + "required": [ + "id", + "documentBaseConfigId" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "description": "Unique identity of document type.", + "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": { - "productIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } + } + } }, - "description": "Ids of the products which should be added to the instant listing" + "type": "object" }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" + "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" }, - "pageName": { - "oneOf": [ - { - "type": "string" + "salesChannel": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-base-config-sales-channel/02a1d1c4385bb5549fa51f219bb79824/salesChannel" + } + } }, - { - "type": "null" + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "sales_channel" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "ec3712a84143b57e0db620eaac6e55b8" + } + } } - ], - "description": "The name of the instant listing page" + }, + "type": "object" } }, "type": "object" } - } - } - }, - "responses": { - "201": { - "description": "Created a new instant listing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "index": { - "type": "integer", - "description": "The current index of the instant listing which is created by this request" - } - }, - "example": { - "index": 1 - } - } - } - } + }, + "type": "object" } - } + ] }, - "patch": { - "tags": [ - "Appointment" + "DocumentBaseConfigSalesChannel": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "documentBaseConfigId" ], - "summary": "Update a instant listing from the presentation", - "description": "Updates the products for the given listing", - "operationId": "updateInstantListing", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentBaseConfigId": { + "description": "Unique identity of document's base config.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "salesChannelId": { + "description": "Unique identity of sales channel.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentTypeId": { + "description": "Unique identity of document type.", + "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" } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "addProductIds", - "removeProductIds", - "currentPageGroupId" - ], + }, + "type": "object" + }, + "DocumentTypeJsonApi": { + "description": "Added since version: 6.0.0.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName", + "name" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "name": { + "type": "string" + }, + "technicalName": { + "description": "Technical name of document type.", + "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": { - "addProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the products which should be added to the instant listing" - }, - "removeProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "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" + } + } + } + } }, - "description": "Ids of the products which should be removed to the instant listing" - }, - "currentPageGroupId": { - "type": "string", - "description": "Id of the current cms page", - "pattern": "^[0-9a-f]{32}$" + "type": "object" }, - "pageName": { - "oneOf": [ - { - "type": "string" + "documentBaseConfigs": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigs" + } + } }, - { - "type": "null" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config" + }, + "id": { + "type": "string", + "example": "0e128fa41e6afdcd85baa8ee7b07b0e3" + } + } + } } - ], - "description": "The name of the instant listing page" - } - }, - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "Updated the instant listing", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the instant listing page" }, - "pickedProductIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "object" + }, + "documentBaseConfigSalesChannels": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-type/a3e4a918932e72ec84ec065eb5100c22/documentBaseConfigSalesChannels" + } + } }, - "description": "Ids of the products which are picked for the instant listing" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_base_config_sales_channel" + }, + "id": { + "type": "string", + "example": "9c990fde5b38ff70fc1a07bf84c12a17" + } + } + } + } }, - "title": { - "type": "string", - "description": "The title of the instant listing" - } - }, - "example": { - "id": "018c3e5ffd3a70899fa1321bf7e2a7f7", - "pickedProductIds": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ], - "title": "Default Digital Sales Rooms product listing page" + "type": "object" } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/presentation/state": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get the current presentation state", - "description": "Returns the presentation state for all and the guide", - "operationId": "getGuidePresentationState", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GuidePresentationStateResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/video-room": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Create a video room", - "description": "Creates a video room on the remote video tool", - "operationId": "createVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/VideoChatCreateStruct" - } + }, + "type": "object" } - } + }, + "type": "object" } - } + ] }, - "delete": { - "tags": [ - "Appointment" - ], - "summary": "Delete a video room", - "description": "Delete a video room and tokens on the remote video tool", - "operationId": "deleteVideoRoom", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": [] - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get attendee insights", - "description": "Get attendee insights for the given appointment", - "operationId": "getAttendeeInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetAttendeeInsightsResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-insights": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get cart insights", - "description": "Get cart insights for the given appointment", - "operationId": "getCartInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/GetCartInsightsResponse" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics": { - "get": { - "tags": [ - "Appointment" + "DocumentType": { + "description": "Added since version: 6.0.0.0", + "required": [ + "id", + "technicalName", + "name" ], - "summary": "Get cart statistics", - "description": "Get cart statistics (cart line items) of all the attendees for the given appointment", - "operationId": "getCartStatistics", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "order", - "in": "query", - "description": "The order of the cart line items", - "schema": { - "type": "string" - } + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - { - "name": "sort", - "in": "query", - "description": "The sort of the cart line items", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get last seen products insights", - "description": "Get last seen products of all attendees for the given appointment", - "operationId": "getLastSeenProductsInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "name": { + "type": "string" }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 - } + "technicalName": { + "description": "Technical name of document type.", + "type": "string" }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 - } + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - { - "name": "term", - "in": "query", - "description": "The search term for the products", - "schema": { - "type": "string" - } + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the last seen products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get wishlist insights", - "description": "Get wishlist of all the attendees for the given appointment", - "operationId": "getWishlistInsights", - "parameters": [ - { - "name": "appointmentId", - "in": "path", - "description": "Appointment id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "customFields": { + "type": "object" }, - { - "name": "limit", - "in": "query", - "description": "The limit of the products which should be returned", - "schema": { - "type": "integer", - "default": 10 - } + "translated": { + "type": "object" }, - { - "name": "page", - "in": "query", - "description": "The page of the products which should be returned", - "schema": { - "type": "integer", - "default": 1 + "documents": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" } }, - { - "name": "term", - "in": "query", - "description": "The search term for the wishlist products", - "schema": { - "type": "string" + "documentBaseConfigs": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfig" } }, - { - "name": "order", - "in": "query", - "description": "The order of the wishlist products", - "schema": { - "type": "string" + "documentBaseConfigSalesChannels": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentBaseConfigSalesChannel" } - }, + } + }, + "type": "object" + }, + "DsrAppointmentJsonApi": { + "allOf": [ { - "name": "sort", - "in": "query", - "description": "The sort of the wishlist products", - "schema": { - "type": "string" - } - }, - { - "name": "attendeeId", - "in": "query", - "description": "The attendee id for which the wishlist products should be returned", - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/WidgetProductListing" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Remove an attendee from the appointment", - "description": "Remove an attendee from the appointment", - "operationId": "removeAttendee", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "attendeeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the removed attendee" - } - }, - "example": { - "message": "Attendee removed successfully", - "attendeeId": "018c19b80403709cb2cef54f70860042" - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/last-seen-product-ids": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Get ids of last seen products", - "description": "Get all product ids of that attendee has seen", - "operationId": "getLastSeenProductIds", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "collection": { - "type": "object", - "properties": { - "lastSeen": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - } - } - }, - "example": { - "collection": { - "lastSeen": [ - "018c19b80403709cb2cef54f70860042", - "018c19b804027291955d8f076c272d0d" - ] - } - } - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/load-temp-cart": { - "get": { - "tags": [ - "Appointment" - ], - "summary": "Load a temporary cart for the attendee", - "description": "Load a temporary cart for the attendee", - "operationId": "loadTempCart", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "sw-context-token", - "in": "header", - "description": "Contains sw-context-token value", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add discount to the temp cart", - "description": "Add discount to the temp cart", - "operationId": "addTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddTempDiscountRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/remove-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Remove all discount from the temp cart", - "description": "Remove all discount from the temp cart", - "operationId": "removeTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/apply-temp-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Apply the discount from the temp cart to the attendee cart", - "description": "Apply the discount from the temp cart to the attendee cart", - "operationId": "applyTempDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - }, - "/_action/dsr/appointment/attendee/{attendeeId}/add-cart-discount": { - "post": { - "tags": [ - "Appointment" - ], - "summary": "Add discount to the attendee cart", - "description": "Add discount to the attendee cart", - "operationId": "addCartDiscount", - "parameters": [ - { - "name": "attendeeId", - "in": "path", - "description": "Attendee id", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/AddCartDiscountRequestBody" - } - } - } - }, - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Cart" - } - } - } - } - } - } - } - }, - "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" - ], - "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" - ], - "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" - ], - "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", - "version", - "integrationId", - "aclRoleId", - "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" - }, - "inAppPurchasesGatewayUrl": { - "type": "string" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "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", - "version", - "integrationId", - "aclRoleId", - "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" - }, - "inAppPurchasesGatewayUrl": { - "type": "string" - }, - "sourceType": { - "type": "string" - }, - "sourceConfig": { - "type": "object" - }, - "selfManaged": { - "type": "boolean" - }, - "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", - "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", - "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" - ], - "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" - ], - "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", - "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", - "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", - "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", - "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" - ], - "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" - ], - "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" - ], - "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" - ], - "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", - "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", - "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" - ], - "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" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "appName": { - "type": "string" - }, - "identifier": { - "type": "string" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "shippingMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "originalMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "app": { - "$ref": "#/components/schemas/App" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - }, - "originalMedia": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "AppTemplateJsonApi": { - "description": "Added since version: 6.3.1.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "template", - "path", - "active", - "appId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "template": { - "type": "string" - }, - "path": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "appId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "hash": { - "type": "string" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "app": { - "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" - ], - "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}$" - }, - "hash": { - "type": "string" - }, - "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", - "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", - "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" - ], - "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" - ], - "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" - ], - "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" - }, - "extensions": { - "properties": { - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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" - ], - "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" - }, - "extensions": { - "properties": { - "createdBy": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-page/64bf107168bcd03626208c1764ce6890/createdBy" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "user" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "34998857f537140306898d54d4b970dc" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "sections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsSection" - } - }, - "previewMedia": { - "$ref": "#/components/schemas/Media" - }, - "categories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Category" - } - }, - "landingPages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LandingPage" - } - }, - "homeSalesChannels": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Product" - } - } - }, - "type": "object" - }, - "CmsSectionJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "position", - "type", - "pageId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "type": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "sizingMode": { - "type": "string" - }, - "mobileBehavior": { - "type": "string" - }, - "backgroundColor": { - "type": "string" - }, - "backgroundMediaId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "backgroundMediaMode": { - "type": "string" - }, - "cssClass": { - "type": "string" - }, - "pageId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "visibility": { - "properties": { - "mobile": { - "type": "boolean" - }, - "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 - }, - "extensions": { - "properties": { - "dsrSlideExtension": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_cms_slide" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f7b1c34af8f346efae2c5862529520d8" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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" - ], - "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 - }, - "extensions": { - "properties": { - "dsrSlideExtension": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-section/d08def49fa8924d6f4a32bdb448d5fba/dsrSlideExtension" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_cms_slide" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f7b1c34af8f346efae2c5862529520d8" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "page": { - "$ref": "#/components/schemas/CmsPage" - }, - "backgroundMedia": { - "$ref": "#/components/schemas/Media" - }, - "blocks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CmsBlock" - } - } - }, - "type": "object" - }, - "CmsSlotJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "type", - "slot", - "blockId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "slot": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { - "type": "object" - }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "block": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/cms-slot/ac5ca6960137c6b8a97c90c11b71d4bb/block" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "cms_block" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "14511f2f5564650d129ca7cabc333278" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "CmsSlot": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "type", - "slot", - "blockId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "versionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "type": "string" - }, - "slot": { - "type": "string" - }, - "locked": { - "type": "boolean" - }, - "config": { - "type": "object" - }, - "customFields": { - "type": "object" - }, - "data": { - "type": "object", - "readOnly": true - }, - "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "block": { - "$ref": "#/components/schemas/CmsBlock" - } - }, - "type": "object" - }, - "CountryJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "addressFormat" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "iso": { - "type": "string" - }, - "position": { - "type": "integer", - "format": "int64" - }, - "active": { - "type": "boolean" - }, - "shippingAvailable": { - "type": "boolean" - }, - "iso3": { - "type": "string" - }, - "displayStateInRegistration": { - "type": "boolean" - }, - "forceStateInRegistration": { - "type": "boolean" - }, - "checkVatIdPattern": { - "type": "boolean" - }, - "vatIdRequired": { - "type": "boolean" - }, - "vatIdPattern": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "customerTax": { - "required": [ - "enabled", - "currencyId", - "amount" - ], - "properties": { - "enabled": { - "type": "boolean" - }, - "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", - "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", - "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", - "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", - "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", - "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" - ], - "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" - ], - "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" - ], - "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" - ], - "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" - ], - "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" - }, - "storeApiAware": { - "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" - ], - "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" - }, - "storeApiAware": { - "type": "boolean" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "customFieldSet": { - "$ref": "#/components/schemas/CustomFieldSet" - }, - "productSearchConfigFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ProductSearchConfigField" - } - } - }, - "type": "object" - }, - "CustomFieldSetJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "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" - ], - "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" - ], - "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" - ], - "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", - "defaultPaymentMethodId" - ], - "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" - }, - "email": { - "type": "string" - }, - "title": { - "type": "string" - }, - "affiliateCode": { - "type": "string" - }, - "campaignCode": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "doubleOptInRegistration": { - "type": "boolean" - }, - "doubleOptInEmailSentDate": { - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "type": "string", - "format": "date-time" - }, - "hash": { - "type": "string" - }, - "guest": { - "type": "boolean" - }, - "firstLogin": { - "type": "string", - "format": "date-time" - }, - "lastLogin": { - "type": "string", - "format": "date-time" - }, - "birthday": { - "type": "string" - }, - "lastOrderDate": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderTotalAmount": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reviewCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "remoteAddress": { - "type": "string" - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "requestedGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "boundSalesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "attendee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_appointment_attendee" - }, - "id": { - "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "relationships": { - "properties": { - "group": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/group" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_group" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "db0f6f37ebeb6ea09489124345af2a45" - } - } - } - }, - "type": "object" - }, - "salesChannel": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/salesChannel" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "sales_channel" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "ec3712a84143b57e0db620eaac6e55b8" - } - } - } - }, - "type": "object" - }, - "language": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/language" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "language" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8512ae7d57b1396273f76fe6ed341a23" - } - } - } - }, - "type": "object" - }, - "lastPaymentMethod": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/lastPaymentMethod" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "payment_method" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "bb083200005a374b86f6f5fbbff6f0e0" - } - } - } - }, - "type": "object" - }, - "defaultBillingAddress": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultBillingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "263d0f6e5d8d71fc4c288736f7c90990" - } - } - } - }, - "type": "object" - }, - "activeBillingAddress": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeBillingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "1a4362407b6a71fa80952dcd4ba7feb3" - } - } - } - }, - "type": "object" - }, - "defaultShippingAddress": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/defaultShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "8218c377171d06883caea7e2baf67f31" - } - } - } - }, - "type": "object" - }, - "activeShippingAddress": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/activeShippingAddress" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "customer_address" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "f6e2f5dd29b543b8547e30d2d71a6974" - } - } - } - }, - "type": "object" - }, - "salutation": { - "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", - "defaultPaymentMethodId" - ], - "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" - }, - "email": { - "type": "string" - }, - "title": { - "type": "string" - }, - "affiliateCode": { - "type": "string" - }, - "campaignCode": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "doubleOptInRegistration": { - "type": "boolean" - }, - "doubleOptInEmailSentDate": { - "type": "string", - "format": "date-time" - }, - "doubleOptInConfirmDate": { - "type": "string", - "format": "date-time" - }, - "hash": { - "type": "string" - }, - "guest": { - "type": "boolean" - }, - "firstLogin": { - "type": "string", - "format": "date-time" - }, - "lastLogin": { - "type": "string", - "format": "date-time" - }, - "birthday": { - "type": "string" - }, - "lastOrderDate": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "orderCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "orderTotalAmount": { - "type": "number", - "format": "float", - "readOnly": true - }, - "reviewCount": { - "type": "integer", - "format": "int64", - "readOnly": true - }, - "customFields": { - "type": "object" - }, - "remoteAddress": { - "type": "string" - }, - "tagIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "readOnly": true - }, - "requestedGroupId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "boundSalesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "updatedById": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "extensions": { - "properties": { - "attendee": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/customer/ce26601dac0dea138b7295f02b7620a7/attendee" - } - } - }, - "data": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "dsr_appointment_attendee" - }, - "id": { - "type": "string", - "example": "b7ce8294183a0f2a6092b6cb2f17b9b5" - } - } - } - } - }, - "type": "object" - } - }, - "type": "object" - }, - "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" - }, - "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "salutation": { - "$ref": "#/components/schemas/Salutation" - }, - "addresses": { - "type": "array", - "items": { - "$ref": "#/components/schemas/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" - ], - "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" - }, - "hash": { - "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": { - "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" - ], - "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" - }, - "hash": { - "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 - }, - "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", - "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", - "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" - ], - "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" - ], - "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" - ], - "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" - ], - "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" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "products": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomerWishlistProduct" - } - }, - "customer": { - "$ref": "#/components/schemas/Customer" - }, - "salesChannel": { - "$ref": "#/components/schemas/SalesChannel" - } - }, - "type": "object" - }, - "CustomerWishlistProductJsonApi": { - "description": "Added since version: 6.3.4.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "productId", - "wishlistId" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "wishlistId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "relationships": { - "properties": { - "wishlist": { - "properties": { - "links": { - "type": "object", - "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" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "wishlistId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "wishlist": { - "$ref": "#/components/schemas/CustomerWishlist" - }, - "product": { - "$ref": "#/components/schemas/Product" - } - }, - "type": "object" - }, - "DeliveryTimeJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "name", - "min", - "max", - "unit" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "name": { - "type": "string" - }, - "min": { - "type": "integer", - "format": "int64" - }, - "max": { - "type": "integer", - "format": "int64" - }, - "unit": { - "type": "string" - }, - "customFields": { - "type": "object" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "updatedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "translated": { - "type": "object" - }, - "relationships": { - "properties": { - "shippingMethods": { - "properties": { - "links": { - "type": "object", - "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" - ], - "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", - "orderId", - "config", - "deepLinkCode", - "fileType" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentMediaFileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentA11yMediaFileId": { - "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" - }, - "fileType": { - "type": "string" - }, - "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" - }, - "documentA11yMediaFile": { - "properties": { - "links": { - "type": "object", - "properties": { - "related": { - "type": "string", - "format": "uri-reference", - "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentA11yMediaFile" - } - } - }, - "data": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "media" - }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "example": "0ea973a1104089c9d0f93bdb06c47cab" - } - } - } - }, - "type": "object" - } - }, - "type": "object" - } - }, - "type": "object" - } - ] - }, - "Document": { - "description": "Added since version: 6.0.0.0", - "required": [ - "id", - "documentTypeId", - "orderId", - "config", - "deepLinkCode", - "fileType" - ], - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentTypeId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "referencedDocumentId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "orderId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentMediaFileId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentA11yMediaFileId": { - "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" - }, - "fileType": { - "type": "string" - }, - "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" - }, - "documentA11yMediaFile": { - "$ref": "#/components/schemas/Media" - } - }, - "type": "object" - }, - "DocumentBaseConfigJsonApi": { - "description": "Added since version: 6.0.0.0", - "allOf": [ - { - "$ref": "#/components/schemas/resource" - }, - { - "required": [ - "id", - "documentTypeId", - "name" - ], - "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" - ], - "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" - ], - "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" - ], - "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", - "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", - "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" - }, - "DsrAppointmentJsonApi": { - "allOf": [ - { - "$ref": "#/components/schemas/resource" + "$ref": "#/components/schemas/resource" }, { "required": [ @@ -29028,29 +18846,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29147,29 +18972,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29212,24 +19044,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -29318,6 +19155,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -29426,24 +19264,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -29478,7 +19321,8 @@ "$ref": "#/components/schemas/Rule" }, "parent": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "children": { "type": "array", @@ -29509,6 +19353,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -29541,6 +19386,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -29578,20 +19424,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -29657,20 +19508,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -30000,6 +19856,7 @@ { "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", @@ -30011,25 +19868,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -30041,12 +19906,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -30105,6 +19964,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", @@ -30116,25 +19976,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -30146,12 +20014,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -30193,25 +20055,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -30292,6 +20160,37 @@ }, "type": "object" }, + "stateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "c78c7ea361b7def0876b75bd1bd37879" + } + } + } + } + }, + "type": "object" + }, "aclRoles": { "properties": { "links": { @@ -30345,25 +20244,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -30416,6 +20321,12 @@ "app": { "$ref": "#/components/schemas/App" }, + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, "aclRoles": { "type": "array", "items": { @@ -30553,6 +20464,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -30613,6 +20525,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -30719,7 +20632,8 @@ } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", @@ -30728,6 +20642,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -30822,16 +20737,22 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -30884,6 +20805,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -30913,6 +20835,7 @@ "type": "object" }, "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -30942,6 +20865,7 @@ "type": "object" }, "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -30971,6 +20895,7 @@ "type": "object" }, "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -31334,16 +21259,22 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -31394,15 +21325,19 @@ "type": "object" }, "parent": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, "locale": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, "translationCode": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" }, "children": { + "description": "Child languages inheriting from this parent language", "type": "array", "items": { "$ref": "#/components/schemas/Language" @@ -31487,6 +21422,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -31597,6 +21533,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -31652,9 +21589,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -31693,9 +21632,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -32116,6 +22057,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -32197,6 +22139,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -32249,6 +22192,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32257,6 +22201,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32265,6 +22210,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32389,6 +22335,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32397,6 +22344,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32405,6 +22353,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32430,6 +22379,289 @@ }, "type": "object" }, + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "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": { + "measurementSystem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_system" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c0484ac171c930ce54e78cd2e0d80e5a" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "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" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" + } + }, + "type": "object" + }, + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "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": { + "units": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_display_unit" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "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" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } + } + }, + "type": "object" + }, "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -32446,29 +22678,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -32502,6 +22740,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -32624,6 +22863,7 @@ "type": "object" }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "properties": { "links": { "type": "object", @@ -33239,6 +23479,37 @@ }, "type": "object" }, + "a11yDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "f6c460e0d75110fa1ec7529fe364dbb5" + } + } + } + } + }, + "type": "object" + }, "appPaymentMethods": { "properties": { "links": { @@ -33320,29 +23591,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -33376,6 +23653,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -33471,6 +23749,7 @@ } }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" @@ -33584,6 +23863,12 @@ "$ref": "#/components/schemas/Document" } }, + "a11yDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, "appPaymentMethods": { "type": "array", "items": { @@ -33616,6 +23901,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -33682,6 +23968,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -33721,13 +24008,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33741,10 +24031,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -33763,6 +24055,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -33932,13 +24225,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -33952,10 +24248,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -33972,7 +24270,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." }, "children": { "type": "array", @@ -34011,16 +24310,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -34122,16 +24425,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -34240,21 +24547,28 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -34303,6 +24617,35 @@ } }, "type": "object" + }, + "mediaThumbnailSize": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail_size" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0d0b8659a3a47e9d7e1481961f127fd0" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -34326,21 +24669,28 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -34361,6 +24711,9 @@ }, "media": { "$ref": "#/components/schemas/Media" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" @@ -34383,10 +24736,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -34435,6 +24790,37 @@ } }, "type": "object" + }, + "mediaThumbnails": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -34457,10 +24843,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -34482,6 +24870,12 @@ "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } + }, + "mediaThumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } } }, "type": "object" @@ -34507,48 +24901,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34706,48 +25113,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34825,12 +25245,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -34841,10 +25264,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34939,12 +25364,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -34955,10 +25383,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35002,10 +25432,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -35015,9 +25447,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -35152,10 +25586,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -35165,9 +25601,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -35220,14 +25658,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35351,14 +25792,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35402,6 +25846,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35471,6 +25916,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35512,12 +25958,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -35621,12 +26069,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -35694,9 +26144,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35704,23 +26156,44 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -35762,21 +26235,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -35838,30 +26315,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35875,10 +26366,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35937,6 +26430,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -35965,7 +26459,68 @@ }, "type": "object" }, + "primaryOrderDelivery": { + "description": "Primary delivery information for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" + } + } + } + }, + "type": "object" + }, + "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbaa9e50388c524d97853a4fc4476b0e" + } + } + } + }, + "type": "object" + }, "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -35995,6 +26550,7 @@ "type": "object" }, "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -36024,6 +26580,7 @@ "type": "object" }, "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -36082,6 +26639,7 @@ "type": "object" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -36113,6 +26671,7 @@ "type": "object" }, "billingAddress": { + "description": "Billing address for the order", "properties": { "links": { "type": "object", @@ -36142,6 +26701,7 @@ "type": "object" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", @@ -36173,6 +26733,7 @@ "type": "object" }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", @@ -36204,6 +26765,7 @@ "type": "object" }, "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -36235,6 +26797,7 @@ "type": "object" }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -36266,6 +26829,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -36391,9 +26955,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36401,23 +26967,44 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -36459,21 +27046,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -36535,30 +27126,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", + "type": "string" + }, + "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36572,10 +27177,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36632,54 +27239,73 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" + }, + "primaryOrderDelivery": { + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" + }, + "primaryOrderTransaction": { + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" }, "orderCustomer": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } }, "transactions": { + "description": "Payment transactions for the order", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -36720,14 +27346,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36736,43 +27365,52 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "street": { + "description": "Street address", "type": "string" }, "zipcode": { + "description": "Zip code of the country.", "type": "string" }, "city": { + "description": "Name of the city.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "department": { + "description": "Name of the department.", "type": "string" }, "title": { - "type": "string" - }, - "vatId": { + "description": "Title name given to customer like DR. , Prof., etc.", "type": "string" }, "phoneNumber": { + "description": "Phone number of the customer.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional address input if necessary.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional address input if necessary.", "type": "string" }, "hash": { @@ -36782,6 +27420,11 @@ "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -36970,14 +27613,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36986,43 +27632,52 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "street": { + "description": "Street address", "type": "string" }, "zipcode": { + "description": "Zip code of the country.", "type": "string" }, "city": { + "description": "Name of the city.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "department": { + "description": "Name of the department.", "type": "string" }, "title": { - "type": "string" - }, - "vatId": { + "description": "Title name given to customer like DR. , Prof., etc.", "type": "string" }, "phoneNumber": { + "description": "Phone number of the customer.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional address input if necessary.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional address input if necessary.", "type": "string" }, "hash": { @@ -37032,6 +27687,11 @@ "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -37087,10 +27747,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37099,22 +27761,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -37124,12 +27792,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -37258,10 +27928,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37270,22 +27942,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -37295,12 +27973,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -37351,6 +28031,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37359,6 +28040,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37367,10 +28049,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37381,10 +28065,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -37461,6 +28147,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -37519,6 +28206,7 @@ "type": "object" }, "shippingOrderAddress": { + "description": "Shipping address for this delivery", "properties": { "links": { "type": "object", @@ -37548,6 +28236,7 @@ "type": "object" }, "shippingMethod": { + "description": "Shipping method used for this delivery", "properties": { "links": { "type": "object", @@ -37577,6 +28266,7 @@ "type": "object" }, "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -37606,6 +28296,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -37636,6 +28355,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37644,6 +28364,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37652,10 +28373,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37666,10 +28389,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -37744,22 +28469,29 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -37786,6 +28518,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37794,6 +28527,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37859,14 +28593,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -37968,6 +28705,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37976,6 +28714,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38041,14 +28780,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -38087,9 +28829,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -38101,6 +28843,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38109,6 +28852,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38117,6 +28861,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38129,44 +28874,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -38228,22 +28976,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -38257,6 +29016,7 @@ "relationships": { "properties": { "cover": { + "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", @@ -38315,6 +29075,7 @@ "type": "object" }, "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -38373,6 +29134,7 @@ "type": "object" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", @@ -38435,6 +29197,7 @@ "type": "object" }, "downloads": { + "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", @@ -38541,9 +29304,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -38555,6 +29318,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38563,6 +29327,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38571,6 +29336,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38583,44 +29349,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -38682,22 +29451,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -38709,18 +29489,21 @@ "readOnly": true }, "cover": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, "product": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -38733,6 +29516,7 @@ } }, "downloads": { + "description": "Digital downloads associated with this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -38774,6 +29558,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38782,14 +29567,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -38892,6 +29680,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38900,14 +29689,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -38988,6 +29780,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -38996,6 +29789,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39060,6 +29854,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39079,6 +29874,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -39137,6 +29933,7 @@ "type": "object" }, "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -39166,6 +29963,7 @@ "type": "object" }, "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -39195,6 +29993,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -39223,6 +30050,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39231,6 +30059,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39295,6 +30124,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39312,19 +30142,25 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" }, "captures": { + "description": "Payment captures for this transaction", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -39352,6 +30188,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39360,10 +30197,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -39553,6 +30392,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39561,10 +30401,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -39675,6 +30517,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39683,13 +30526,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -39879,6 +30725,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39887,13 +30734,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -40004,6 +30854,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40012,6 +30863,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40020,12 +30872,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -40185,6 +31040,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40193,6 +31049,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40201,12 +31058,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -40298,6 +31158,7 @@ { "required": [ "id", + "technicalName", "name" ], "properties": { @@ -40306,10 +31167,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -40323,23 +31186,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40348,38 +31216,13 @@ "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 + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -40396,6 +31239,7 @@ "relationships": { "properties": { "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -40647,6 +31491,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "name" ], "properties": { @@ -40655,10 +31500,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -40672,23 +31519,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -40697,38 +31549,13 @@ "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 + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -40743,7 +31570,8 @@ "type": "object" }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" @@ -40802,46 +31630,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -40935,46 +31776,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -41053,6 +31907,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41061,14 +31916,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41077,14 +31935,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41093,6 +31954,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41107,9 +31969,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -41119,21 +31983,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "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", "format": "int64" }, @@ -41144,6 +32013,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -41154,32 +32024,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -41189,29 +32067,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -41270,20 +32155,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -41318,6 +32198,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -41401,6 +32293,7 @@ "relationships": { "properties": { "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -41432,6 +32325,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -41461,6 +32355,7 @@ "type": "object" }, "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -41492,6 +32387,7 @@ "type": "object" }, "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -41521,6 +32417,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -41550,6 +32447,7 @@ "type": "object" }, "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -41579,6 +32477,7 @@ "type": "object" }, "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -41608,6 +32507,7 @@ "type": "object" }, "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", @@ -41666,6 +32566,7 @@ "type": "object" }, "cmsPage": { + "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", @@ -41695,6 +32596,7 @@ "type": "object" }, "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", @@ -41755,6 +32657,7 @@ "type": "object" }, "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -41786,6 +32689,7 @@ "type": "object" }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -41848,6 +32752,7 @@ "type": "object" }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -41941,6 +32846,7 @@ "type": "object" }, "productReviews": { + "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", @@ -41972,6 +32878,7 @@ "type": "object" }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -42003,6 +32910,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -42096,6 +33004,7 @@ "type": "object" }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -42127,6 +33036,7 @@ "type": "object" }, "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -42158,6 +33068,7 @@ "type": "object" }, "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -42189,6 +33100,7 @@ "type": "object" }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -42220,6 +33132,7 @@ "type": "object" }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -42251,6 +33164,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -42351,6 +33265,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42359,14 +33274,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42375,14 +33293,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42391,6 +33312,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42405,9 +33327,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -42417,21 +33341,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "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", "format": "int64" }, @@ -42442,6 +33371,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -42452,32 +33382,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -42487,29 +33425,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -42568,20 +33513,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -42616,6 +33556,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -42697,43 +33649,53 @@ "type": "object" }, "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "parent": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, "children": { + "description": "Product variants that inherit from this parent product", "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, "unit": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, "cover": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" }, "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" }, "prices": { "type": "array", @@ -42742,12 +33704,14 @@ } }, "media": { + "description": "Product images and media gallery", "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" @@ -42760,6 +33724,7 @@ } }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -42778,18 +33743,21 @@ } }, "productReviews": { + "description": "Customer reviews and ratings for the product", "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -42808,36 +33776,42 @@ } }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "properties": { + "description": "Product properties and characteristics for filtering", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "categories": { + "description": "Categories this product is assigned to", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "tags": { + "description": "Tags for organizing and filtering products", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -42946,6 +33920,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42954,10 +33929,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -42965,6 +33942,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -43095,6 +34073,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43103,10 +34082,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43114,6 +34095,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -43163,26 +34145,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43191,6 +34180,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43322,26 +34312,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43350,6 +34347,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43399,10 +34397,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43411,6 +34411,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -43505,10 +34506,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43517,6 +34520,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -43593,6 +34597,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43601,10 +34606,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -43706,6 +34713,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43714,10 +34722,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -43770,64 +34780,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -44017,64 +35045,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -44244,13 +35290,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { @@ -44305,13 +35354,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "language": { @@ -44341,6 +35393,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44455,6 +35508,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44517,6 +35571,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44525,10 +35580,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -44661,6 +35718,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44669,10 +35727,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -44763,6 +35823,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44771,6 +35832,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44781,10 +35843,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -44888,6 +35952,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44896,6 +35961,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44906,10 +35972,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -44988,6 +36056,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44996,37 +36065,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -45184,6 +36263,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45192,37 +36272,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -45270,13 +36360,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -45378,13 +36471,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -45434,23 +36530,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -45545,23 +36647,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -45608,10 +36716,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45620,9 +36730,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -45723,10 +36835,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45735,9 +36849,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -45888,6 +37004,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -45900,6 +37017,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -46099,6 +37220,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -46111,6 +37233,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -46205,6 +37331,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46213,21 +37340,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -46276,6 +37408,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -46356,6 +37489,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46364,21 +37498,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -46399,7 +37538,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -46493,6 +37633,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46501,10 +37642,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -46600,6 +37743,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46608,10 +37752,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -46654,53 +37800,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -47036,53 +38197,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -47219,36 +38395,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -47377,36 +38563,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -47456,14 +38652,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -47559,14 +38758,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -47635,10 +38837,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -47706,10 +38910,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -47834,14 +39040,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -47937,14 +39146,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -47987,16 +39199,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -48095,16 +39311,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -48181,15 +39401,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -48271,15 +39495,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -48329,6 +39557,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48340,12 +39569,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -48536,6 +39771,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -48547,12 +39783,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -48614,16 +39856,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -49108,16 +40354,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -49250,13 +40500,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49268,6 +40521,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -49345,6 +40599,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -49425,13 +40680,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49443,6 +40701,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -49466,7 +40725,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -49532,38 +40792,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49572,10 +40841,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49584,6 +40855,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49592,35 +40864,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -49642,6 +40925,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -49903,6 +41187,7 @@ "type": "object" }, "language": { + "description": "Default language for the sales channel", "properties": { "links": { "type": "object", @@ -49961,6 +41246,7 @@ "type": "object" }, "currency": { + "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", @@ -49990,6 +41276,7 @@ "type": "object" }, "paymentMethod": { + "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", @@ -50019,6 +41306,7 @@ "type": "object" }, "shippingMethod": { + "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", @@ -50048,6 +41336,7 @@ "type": "object" }, "country": { + "description": "Default country for the sales channel", "properties": { "links": { "type": "object", @@ -50168,6 +41457,7 @@ "type": "object" }, "domains": { + "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", @@ -50230,6 +41520,7 @@ "type": "object" }, "navigationCategory": { + "description": "Root category for navigation menu", "properties": { "links": { "type": "object", @@ -50259,6 +41550,7 @@ "type": "object" }, "footerCategory": { + "description": "Root category for footer navigation", "properties": { "links": { "type": "object", @@ -50288,6 +41580,7 @@ "type": "object" }, "serviceCategory": { + "description": "Root category for service pages", "properties": { "links": { "type": "object", @@ -50867,38 +42160,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -50907,10 +42209,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -50919,6 +42223,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -50927,35 +42232,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -50977,6 +42293,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -51085,22 +42402,27 @@ "$ref": "#/components/schemas/SalesChannelType" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" }, "country": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" }, "orders": { "type": "array", @@ -51118,6 +42440,7 @@ "$ref": "#/components/schemas/CmsPage" }, "domains": { + "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -51130,13 +42453,16 @@ } }, "navigationCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" }, "footerCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" }, "serviceCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" }, "productVisibilities": { "type": "array", @@ -51250,15 +42576,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Unique identity for tracking.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "createdAt": { @@ -51311,9 +42645,14 @@ ] }, "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "description": "Sales channel analytics configuration", "required": [ - "id" + "id", + "active", + "trackOrders", + "anonymizeIp", + "trackOffcanvasCart", + "createdAt" ], "properties": { "id": { @@ -51321,15 +42660,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Google Analytics tracking ID (e.g., UA-XXXXX-Y or G-XXXXXXXX)", "type": "string" }, "active": { + "description": "Whether Google Analytics tracking is enabled", "type": "boolean" }, "trackOrders": { + "description": "Track order completions in Google Analytics", "type": "boolean" }, "anonymizeIp": { + "description": "Anonymize visitor IP addresses for GDPR compliance", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, "createdAt": { @@ -51338,7 +42685,10 @@ "readOnly": true }, "updatedAt": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "readOnly": true }, @@ -51425,25 +42775,34 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -51697,25 +43056,34 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -51892,9 +43260,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -51984,9 +43354,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -52051,6 +43423,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -52254,6 +43627,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -52332,27 +43706,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -52387,27 +43768,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -52444,15 +43832,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -52523,15 +43915,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -52575,33 +43971,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -52709,33 +44114,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -52786,19 +44200,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -52866,19 +44285,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -52909,6 +44333,7 @@ { "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -52920,10 +44345,15 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -52931,21 +44361,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -52955,9 +44390,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -52974,6 +44406,7 @@ "relationships": { "properties": { "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -53003,6 +44436,7 @@ "type": "object" }, "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -53032,6 +44466,7 @@ "type": "object" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -53063,6 +44498,7 @@ "type": "object" }, "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -53092,6 +44528,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -53216,6 +44653,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -53285,6 +44723,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -53296,10 +44735,15 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -53307,21 +44751,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -53331,9 +44780,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -53348,21 +44794,26 @@ "type": "object" }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -53387,7 +44838,8 @@ } }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" @@ -53412,26 +44864,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -53563,26 +45021,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -53665,16 +45129,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -53744,16 +45212,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -53794,12 +45266,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -53901,12 +45375,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -53955,6 +45431,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -54096,6 +45573,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -54164,35 +45642,50 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -54320,6 +45813,35 @@ } }, "type": "object" + }, + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -54346,35 +45868,50 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -54396,6 +45933,9 @@ }, "user": { "$ref": "#/components/schemas/User" + }, + "integration": { + "$ref": "#/components/schemas/Integration" } }, "type": "object" @@ -54419,12 +45959,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54776,12 +46318,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -54881,17 +46425,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55020,17 +46568,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55077,6 +46629,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -55088,6 +46641,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55153,6 +46707,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -55164,6 +46719,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55600,14 +47156,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -55740,14 +47298,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -55804,26 +47364,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55925,26 +47491,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -55993,14 +47565,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -56026,10 +47601,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -56155,14 +47732,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -56188,10 +47768,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -56236,10 +47818,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -56314,10 +47898,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -56869,41 +48455,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57562,41 +49159,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -57923,16 +49531,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -58002,16 +49614,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -58052,10 +49668,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -58123,10 +49741,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -58166,9 +49786,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58234,9 +49856,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -58420,26 +50044,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -58449,13 +50080,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -58494,26 +50128,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -58523,13 +50164,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -58551,6 +50195,442 @@ }, "type": "object" }, + "infoConfigResponse": { + "type": "object", + "properties": { + "version": { + "type": "string", + "description": "Shopware version." + }, + "shopId": { + "type": "string", + "description": "Unique shop identifier." + }, + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." + }, + "adminWorker": { + "type": "object", + "description": "Admin worker feature flags and transport configuration.", + "properties": { + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." + }, + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", + "deprecated": true + }, + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." + }, + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { + "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", + "properties": { + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." + }, + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." + }, + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." + }, + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." + } + }, + "additionalProperties": false + }, + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true + } + } + }, + "required": [ + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false + }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "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)", @@ -58668,11 +50748,24 @@ }, "includes": { "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", "type": "object", "additionalProperties": { "type": "array", @@ -59287,7 +51380,8 @@ }, "required": [ "gross", - "net" + "net", + "linked" ] }, "regulationPrice": { @@ -59313,447 +51407,239 @@ }, "required": [ "gross", - "net" + "net", + "linked" ] } }, "required": [ "currencyId", "gross", - "net" + "net", + "linked" ] }, - "infoConfigResponse": { + "ConsentState": { "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" - ] - } - ] - }, - "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" - } - } - } - }, - "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" - } - } - } - } - }, - "GetListBodyRequest": { - "type": "object", - "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" - } - } - }, - "DiscountType": { - "type": "string", - "description": "Type of the discount", - "enum": [ - "percentage", - "absolute" - ] - }, - "AddTempDiscountRequestBody": { - "type": "object", - "required": [ - "discountType", - "discountValue", - "appliedItemIds" - ], - "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" - }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 - }, - "appliedItemIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the items to which the discount should be applied" - } - } - }, - "AddCartDiscountRequestBody": { - "type": "object", - "required": [ - "discountType", - "discountValue" + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt" ], "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" + "name": { + "type": "string", + "description": "The name of the consent" }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 - } - } - }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", - "properties": { - "id": { + "scopeName": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" + "description": "The scope of the consent that defines how the identifier is resolved" }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" - } - }, - "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - } - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "status": { "type": "string", - "description": "The type of the current dynamic page" + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" }, - "opened": { - "type": "boolean", - "default": true + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" } } }, - "WidgetProductListing": { + "Cart": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "extensions": { + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" + }, + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "lineItems": { + "description": "All items within the cart", "type": "array", - "description": "List of extensions", - "default": [] + "items": { + "$ref": "#/components/schemas/LineItem" + } }, - "products": { + "errors": { "type": "array", - "description": "List of last seen products", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "items": { - "allOf": [ - { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/CartError" + } + }, + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } + }, + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", + "type": "array", + "items": { + "type": "object", + "properties": { + "paymentMethodId": { + "type": "string" }, - { - "type": "object", - "properties": { - "customFields": { - "type": "object", - "properties": { - "wishlistAttendeeIds": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" } - ] + } } }, - "total": { - "type": "integer", - "description": "The total number of products" + "modified": { + "type": "boolean" }, - "page": { - "type": "integer", - "description": "The current page" + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true }, - "limit": { - "type": "integer", - "description": "The number of products per page" + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } } }, - "VideoChatCreateStruct": { + "CartDeliveryInformation": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", "properties": { - "roomUrl": { + "apiAlias": { "type": "string", - "description": "Url of the video room in daily" + "enum": [ + "cart_delivery_information" + ] }, - "roomName": { - "type": "string", - "description": "Name of the video room in daily" + "freeDelivery": { + "type": "boolean" }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" + ] + } + } }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" + "height": { + "type": "integer" + }, + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" } }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] + "required": [ + "apiAlias" + ] + }, + "StateForGuides": { + "type": "object", + "properties": { + "clients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "inactiveClients": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "guides": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "videoGuideToken": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "quickViewState": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "extensions": { + "type": "array", + "default": [] + } } }, "GetCartInsightsResponse": { @@ -59869,564 +51755,470 @@ } } }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + "DynamicProductListingPageOpenedPayload": { + "required": [ + "page" + ], + "properties": { + "page": { + "type": "integer", + "description": "Current page position in the pagination" } - ] + } }, - "CartPriceQuantity": { + "WidgetProductListing": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "extensions": { + "type": "array", + "description": "List of extensions", + "default": [] + }, + "products": { + "type": "array", + "description": "List of last seen products", + "items": { + "allOf": [ + { + "$ref": "#/components/schemas/Product" + }, + { + "type": "object", + "properties": { + "customFields": { + "type": "object", + "properties": { + "wishlistAttendeeIds": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + }, + "total": { + "type": "integer", + "description": "The total number of products" + }, + "page": { + "type": "integer", + "description": "The current page" + }, + "limit": { + "type": "integer", + "description": "The number of products per page" + } + } + }, + "CartListPrice": { "type": "object", + "description": "", "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" + }, + "price": { + "type": "number" + }, "apiAlias": { "type": "string", "enum": [ - "cart_price_quantity" + "cart_list_price" ] + } + }, + "required": [ + "apiAlias" + ] + }, + "GetListBodyRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" }, - "isCalculated": { - "type": "boolean" + "page": { + "type": "integer", + "description": "The page to be returned" + } + } + }, + "CartPriceReference": { + "type": "object", + "properties": { + "purchaseUnit": { + "type": "number" }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" + "referenceUnit": { + "type": "number" + }, + "unitName": { + "type": "string" }, "price": { "type": "number" }, - "quantity": { - "type": "number" + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_reference" + ] + }, + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, "regulationPrice": { + "type": "object", "properties": { "price": { - "type": "number", - "format": "float" + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitName" + ] + }, + "CartItems": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" + }, + { + "type": "object", + "properties": { + "pickedProductIds": { + "anyOf": [ + { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" + } + }, + { + "type": "null" + } + ], + "description": "The product id is assigned to presentation if it's product listing or instant listing" + } + } + } + ] + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] + }, + "StateForAll": { + "type": "object", + "properties": { + "currentGuideProductId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "lastActiveGuideSection": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentSectionId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "currentSlideAlias": { + "type": "integer", + "default": 0 + }, + "currentSlideData": { + "anyOf": [ + { + "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" + }, + { + "type": "null" + } + ] + }, + "currentDynamicPage": { + "$ref": "#/components/schemas/DynamicPageOpenedPayload" + }, + "started": { + "type": "boolean", + "default": false + }, + "running": { + "type": "boolean", + "default": false + }, + "ended": { + "type": "boolean", + "default": false + }, + "startedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - }, - "type": "object" + ] }, - "taxRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } + "endedAt": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - } - }, - "type": { - "type": "string" - } - }, - "required": [ - "apiAlias" - ] - }, - "BasePresentationSlideData": { - "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + ] }, - "extensions": { - "type": "object", - "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" + "accessibleFrom": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - } - } - } - }, - "PresentationSlideData": { - "type": "object", - "properties": { - "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + ] }, - "extensions": { - "type": "object", - "properties": { - "cmsPageRelation": { - "$ref": "#/components/schemas/PresentationCmsPage" + "accessibleTo": { + "anyOf": [ + { + "type": "string", + "format": "date-time" + }, + { + "type": "null" } - } + ] }, - "product": { - "$ref": "#/components/schemas/Product" + "appointmentMode": { + "type": "string", + "enum": [ + "guided", + "self" + ] }, - "category": { - "$ref": "#/components/schemas/Category" + "videoAudioSettings": { + "type": "string", + "enum": [ + "both", + "none", + "audio-only" + ], + "default": "none" }, - "configurator": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PropertyGroup" - } - } - }, - "example": { - "extensions": { - "cmsPageRelation": { - "translated": { - "title": null - }, - "createdAt": "2023-08-09T11:00:13.160+00:00", - "updatedAt": null, - "presentationId": "506cce706e914c1e8b083f05670d85c4", - "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "title": null, - "productId": null, - "productStreamId": null, - "position": 2, - "isInstantListing": false, - "cmsPage": { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "name": "Default Digital Sales Rooms product listing page", - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "name": "Default Digital Sales Rooms product listing page", - "type": "presentation_product_list", - "entity": null, - "sections": [ - { - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "default", - "blocks": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slots": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slot": "content", - "block": null, - "blockId": "96ea8b9676a5461c9149d205d792ecf2", - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "fieldConfig": null, - "translations": null, - "data": null, - "locked": false, - "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "customFields": null, - "apiAlias": "cms_slot" - } - ], - "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", - "position": 0, - "name": null, - "sectionPosition": "main", - "marginTop": "20px", - "marginBottom": "20px", - "marginLeft": "20px", - "marginRight": "20px", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_block" - } - ], - "pageId": "33e88c7994fa4cf79a1265e5105b93b2", - "page": null, - "position": 0, - "sizingMode": "boxed", - "mobileBehavior": "wrap", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_section" - } - ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" - }, - "pickedProductIds": null, - "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", - "id": "4ee08e142ed046eb99681594f67599f1", - "customFields": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "apiAlias": "dsr_presentation_cms_page" - } + "videoRoomUrl": { + "type": "string", + "default": "" }, - "cmsPage": { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "name": "Default Digital Sales Rooms product listing page", - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "name": "Default Digital Sales Rooms product listing page", - "type": "presentation_product_list", - "entity": null, - "sections": [ + "attendeeRestrictionType": { + "anyOf": [ { - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "default", - "blocks": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": [], - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slots": [ - { - "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "translated": { - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "customFields": [] - }, - "createdAt": "2023-08-03T17:24:09.000+00:00", - "updatedAt": null, - "type": "product-listing", - "slot": "content", - "block": null, - "blockId": "96ea8b9676a5461c9149d205d792ecf2", - "config": { - "filters": { - "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", - "source": "static" - }, - "boxLayout": { - "value": "standard", - "source": "static" - }, - "showSorting": { - "value": true, - "source": "static" - }, - "defaultSorting": { - "value": "", - "source": "static" - }, - "useCustomSorting": { - "value": false, - "source": "static" - }, - "availableSortings": { - "value": [], - "source": "static" - }, - "propertyWhitelist": { - "value": [], - "source": "static" - } - }, - "fieldConfig": null, - "translations": null, - "data": { - "listing": { - "elements": [ - { - "versionId": null, - "translated": [], - "createdAt": null, - "updatedAt": null, - "parentId": null, - "childCount": null, - "taxId": null, - "manufacturerId": null, - "unitId": null, - "active": null, - "displayGroup": null, - "manufacturerNumber": null, - "ean": null, - "sales": null, - "productNumber": null, - "stock": null, - "availableStock": null, - "available": null, - "deliveryTimeId": null, - "deliveryTime": null, - "restockTime": null, - "isCloseout": null, - "purchaseSteps": null, - "maxPurchase": null, - "minPurchase": null, - "purchaseUnit": null, - "referenceUnit": null, - "shippingFree": null, - "markAsTopseller": null, - "weight": null, - "width": null, - "height": null, - "length": null, - "releaseDate": null, - "categoryTree": null, - "streamIds": null, - "optionIds": null, - "propertyIds": null, - "name": null, - "keywords": null, - "description": null, - "metaDescription": null, - "metaTitle": null, - "packUnit": null, - "packUnitPlural": null, - "tax": null, - "manufacturer": null, - "unit": null, - "cover": null, - "parent": null, - "children": null, - "media": null, - "cmsPageId": null, - "cmsPage": null, - "translations": null, - "categories": null, - "properties": null, - "options": null, - "configuratorSettings": null, - "categoriesRo": null, - "coverId": null, - "categoryIds": null, - "productReviews": null, - "ratingAverage": null, - "mainCategories": null, - "seoUrls": null, - "crossSellings": null, - "canonicalProductId": null, - "canonicalProduct": null, - "streams": null, - "downloads": null, - "states": [], - "id": "a32702bb0b1443e3881c3b9a38c09169", - "customFields": null, - "apiAlias": "product" - } - ], - "aggregations": [], - "page": 1, - "limit": null, - "entity": "product", - "total": 0, - "states": [], - "apiAlias": "dal_entity_search_result" - }, - "apiAlias": "cms_product_listing" - }, - "locked": false, - "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "customFields": null, - "apiAlias": "cms_slot" - } - ], - "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", - "position": 0, - "name": null, - "sectionPosition": "main", - "marginTop": "20px", - "marginBottom": "20px", - "marginLeft": "20px", - "marginRight": "20px", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_block" - } - ], - "pageId": "33e88c7994fa4cf79a1265e5105b93b2", - "page": null, - "position": 0, - "sizingMode": "boxed", - "mobileBehavior": "wrap", - "backgroundColor": null, - "backgroundMediaId": null, - "backgroundMedia": null, - "backgroundMediaMode": "cover", - "cssClass": null, - "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", - "visibility": null, - "customFields": null, - "apiAlias": "cms_section" + "type": "string", + "enum": [ + "open", + "customer", + "rules" + ] + }, + { + "type": "null" + } + ] + }, + "productDetailDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "quickviewPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" + } + ] + }, + "productListingDefaultPageId": { + "anyOf": [ + { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + { + "type": "null" } + ] + }, + "broadcastMode": { + "type": "boolean", + "default": false + }, + "viewMode": { + "type": "string", + "enum": [ + "onlyYou", + "presentation", + "videoGrid" ], - "translations": null, - "cssClass": null, - "config": null, - "previewMediaId": null, - "previewMedia": null, - "landingPages": null, - "id": "33e88c7994fa4cf79a1265e5105b93b2", - "customFields": null, - "apiAlias": "cms_page" + "default": "presentation" }, - "category": { - "versionId": null, - "translated": { - "breadcrumb": [] - }, - "createdAt": null, - "updatedAt": null, - "afterCategoryId": null, - "parentId": null, - "mediaId": null, - "name": null, - "breadcrumb": [], - "path": null, - "level": null, - "active": null, - "childCount": null, - "visibleChildCount": 0, - "displayNestedProducts": null, - "parent": null, - "children": null, - "translations": null, - "media": null, - "cmsPageId": null, - "cmsPageIdSwitched": false, - "cmsPage": null, - "linkType": null, - "linkNewTab": null, - "internalLink": null, - "externalLink": null, - "visible": null, - "type": null, - "productAssignmentType": null, - "description": null, - "metaTitle": null, - "metaDescription": null, - "keywords": null, - "seoUrls": null, - "customEntityTypeId": null, - "id": "34f21c5eb6d54a939f10973204aa5f08", - "customFields": null, - "apiAlias": "category" + "allowScreenSharing": { + "type": "boolean", + "default": false }, - "apiAlias": "pwa_page_result" + "extensions": { + "type": "array", + "default": [] + } + } + }, + "CartError": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + } + } } }, "GetAttendeeInsightsResponse": { @@ -60462,109 +52254,130 @@ "currencySymbol": "$" } }, - "CalculatedPrice": { + "GuidePresentationStateResponse": { "type": "object", - "description": "Represents a product along with detailed information required to display a variant selection.", "properties": { - "unitPrice": { - "type": "number" - }, - "quantity": { - "type": "number" - }, - "rawTotal": { - "type": "number" + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" }, - "totalPrice": { - "type": "number" + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" + } + }, + "example": { + "extensions": [], + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "broadcastMode": false, + "extensions": [] }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" - } + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true }, - { - "type": "null" + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "hasJoined": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "hasJoined": false } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] + } + } + }, + "CartPriceQuantity": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_price_quantity" ] }, + "isCalculated": { + "type": "boolean" + }, "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] + "$ref": "#/components/schemas/CartListPrice" }, - "positionPrice": { + "price": { "type": "number" }, - "netPrice": { + "quantity": { "type": "number" }, "regulationPrice": { - "type": "object", "properties": { "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] + "type": "number", + "format": "float" } }, - "nullable": true - }, - "hasRange": { - "type": "boolean" - }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - }, - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] + "type": "object" }, "taxRules": { "type": "array", - "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { @@ -60577,371 +52390,753 @@ } } } + }, + "type": { + "type": "string" } }, "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" + "apiAlias" ] }, - "PresentationCmsPage": { - "allOf": [ - { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - }, - { + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { "type": "object", "properties": { - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } - }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" } } - } - ] - }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" - }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" - }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } } }, - "deliveries": { + "positions": { "type": "array", "items": { - "$ref": "#/components/schemas/CartDelivery" + "$ref": "#/components/schemas/CartDeliveryPosition" } }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", - "type": "array", - "items": { - "type": "object", - "properties": { - "paymentMethodId": { - "type": "string" - }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" - } - } - } + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" }, - "modified": { - "type": "boolean" + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "VideoChatCreateStruct": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "roomUrl": { + "type": "string", + "description": "Url of the video room in daily" }, - "customerComment": { + "roomName": { "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true + "description": "Name of the video room in daily" }, - "affiliateCode": { + "userToken": { "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "description": "Token for the end users to connect to the daily room" }, - "campaignCode": { + "ownerToken": { "type": "string", - "description": "A campaign tracking code", - "nullable": true + "description": "Token for the room owner (guide) to connect to the daily room" } + }, + "example": { + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "dummy user token", + "ownerToken": "dummy owner token", + "roomName": "rSq20mrgwsj4eIXo1u95", + "extensions": [] } }, - "JoinAppointmentResponse": { + "CartDeliveryPosition": { "type": "object", - "description": "Includes all data you will need to attend to a appointment.", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "mercureSubscriberTopics": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } + }, + "identifier": { + "type": "string" + }, + "lineItem": { + "$ref": "#/components/schemas/LineItem" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + } + } + }, + "CalculatedPrice": { + "type": "object", + "description": "Represents a product along with detailed information required to display a variant selection.", + "properties": { + "unitPrice": { + "type": "number" + }, + "quantity": { + "type": "number" + }, + "rawTotal": { + "type": "number" + }, + "totalPrice": { + "type": "number" + }, + "calculatedTaxes": { "type": "array", "items": { - "type": "string", - "description": "mercure topic" - }, - "description": "The topics to which the attendee/guide can subscribe for" - }, - "mercurePublisherTopic": { - "oneOf": [ - { - "type": "string" + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } }, - { - "type": "null" - } - ], - "description": "The topic to which the attendee/guide can send updates" + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } }, - "JWTMercureSubscriberToken": { + "referencePrice": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CartPriceReference" }, { "type": "null" } - ], - "description": "The JWT mercure token to publish updates" + ] }, - "mercureHubPublicUrl": { + "listPrice": { "oneOf": [ { - "type": "string" + "$ref": "#/components/schemas/CartListPrice" }, { "type": "null" } - ], - "description": "The mercure hub url to connect for subscribing and updating" + ] }, - "JWTMercurePublisherToken": { - "oneOf": [ - { - "type": "string" + "positionPrice": { + "type": "number" + }, + "netPrice": { + "type": "number" + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" }, - { - "type": "null" + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] } - ], - "description": "The JWT mercure token to subscribe for updates" + }, + "nullable": true }, - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The appointment id" + "hasRange": { + "type": "boolean" }, - "newContextToken": { + "variantId": { "type": "string", - "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" + "format": "^[0-9a-f]{32}$", + "nullable": true }, - "attendeeId": { + "apiAlias": { "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The created Id for the attendee" + "enum": [ + "calculated_price" + ] }, - "salesChannelId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "The id of the current sales channel" + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" + ] + }, + "BasePresentationSlideData": { + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "salesChannelName": { - "type": "string", - "description": "The name of the current sales channel" + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + } + } + } + }, + "PresentationSlideData": { + "type": "object", + "properties": { + "cmsPage": { + "$ref": "#/components/schemas/CmsPage" }, - "appointmentName": { - "type": "string", - "description": "The name of the appointment" + "extensions": { + "type": "object", + "properties": { + "cmsPageRelation": { + "$ref": "#/components/schemas/PresentationCmsPage" + } + } }, - "presentationGuideMode": { - "type": "string", - "enum": [ - "self", - "guided" - ], - "description": "The type of the appointment" + "product": { + "$ref": "#/components/schemas/Product" }, - "isPreview": { - "type": "boolean", - "description": "To see if it's a preview appointment" + "category": { + "$ref": "#/components/schemas/Category" }, - "attendeeName": { - "oneOf": [ - { - "type": "string" + "configurator": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PropertyGroup" + } + } + }, + "example": { + "extensions": { + "cmsPageRelation": { + "translated": { + "title": null }, - { - "type": "null" - } - ], - "description": "The name of the attendee" - }, - "videoUserId": { - "oneOf": [ - { - "type": "string" + "createdAt": "2023-08-09T11:00:13.160+00:00", + "updatedAt": null, + "presentationId": "506cce706e914c1e8b083f05670d85c4", + "cmsPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "title": null, + "productId": null, + "productStreamId": null, + "position": 2, + "isInstantListing": false, + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ + { + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": null, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" + } + ], + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" }, + "pickedProductIds": null, + "dsrPresentationVersionId": "213769ba28dd4ee788bdb49dc9ce53d2", + "id": "4ee08e142ed046eb99681594f67599f1", + "customFields": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "apiAlias": "dsr_presentation_cms_page" + } + }, + "cmsPage": { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "name": "Default Digital Sales Rooms product listing page", + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "name": "Default Digital Sales Rooms product listing page", + "type": "presentation_product_list", + "entity": null, + "sections": [ { - "type": "null" + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "default", + "blocks": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": [], + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slots": [ + { + "versionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "translated": { + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "customFields": [] + }, + "createdAt": "2023-08-03T17:24:09.000+00:00", + "updatedAt": null, + "type": "product-listing", + "slot": "content", + "block": null, + "blockId": "96ea8b9676a5461c9149d205d792ecf2", + "config": { + "filters": { + "value": "manufacturer-filter,rating-filter,price-filter,shipping-free-filter,property-filter", + "source": "static" + }, + "boxLayout": { + "value": "standard", + "source": "static" + }, + "showSorting": { + "value": true, + "source": "static" + }, + "defaultSorting": { + "value": "", + "source": "static" + }, + "useCustomSorting": { + "value": false, + "source": "static" + }, + "availableSortings": { + "value": [], + "source": "static" + }, + "propertyWhitelist": { + "value": [], + "source": "static" + } + }, + "fieldConfig": null, + "translations": null, + "data": { + "listing": { + "elements": [ + { + "versionId": null, + "translated": [], + "createdAt": null, + "updatedAt": null, + "parentId": null, + "childCount": null, + "taxId": null, + "manufacturerId": null, + "unitId": null, + "active": null, + "displayGroup": null, + "manufacturerNumber": null, + "ean": null, + "sales": null, + "productNumber": null, + "stock": null, + "availableStock": null, + "available": null, + "deliveryTimeId": null, + "deliveryTime": null, + "restockTime": null, + "isCloseout": null, + "purchaseSteps": null, + "maxPurchase": null, + "minPurchase": null, + "purchaseUnit": null, + "referenceUnit": null, + "shippingFree": null, + "markAsTopseller": null, + "weight": null, + "width": null, + "height": null, + "length": null, + "releaseDate": null, + "categoryTree": null, + "streamIds": null, + "optionIds": null, + "propertyIds": null, + "name": null, + "keywords": null, + "description": null, + "metaDescription": null, + "metaTitle": null, + "packUnit": null, + "packUnitPlural": null, + "tax": null, + "manufacturer": null, + "unit": null, + "cover": null, + "parent": null, + "children": null, + "media": null, + "cmsPageId": null, + "cmsPage": null, + "translations": null, + "categories": null, + "properties": null, + "options": null, + "configuratorSettings": null, + "categoriesRo": null, + "coverId": null, + "categoryIds": null, + "productReviews": null, + "ratingAverage": null, + "mainCategories": null, + "seoUrls": null, + "crossSellings": null, + "canonicalProductId": null, + "canonicalProduct": null, + "streams": null, + "downloads": null, + "states": [], + "id": "a32702bb0b1443e3881c3b9a38c09169", + "customFields": null, + "apiAlias": "product" + } + ], + "aggregations": [], + "page": 1, + "limit": null, + "entity": "product", + "total": 0, + "states": [], + "apiAlias": "dal_entity_search_result" + }, + "apiAlias": "cms_product_listing" + }, + "locked": false, + "cmsBlockVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "customFields": null, + "apiAlias": "cms_slot" + } + ], + "sectionId": "2229e1f1208a4b8086baf7aec84f5e2c", + "position": 0, + "name": null, + "sectionPosition": "main", + "marginTop": "20px", + "marginBottom": "20px", + "marginLeft": "20px", + "marginRight": "20px", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsSectionVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_block" + } + ], + "pageId": "33e88c7994fa4cf79a1265e5105b93b2", + "page": null, + "position": 0, + "sizingMode": "boxed", + "mobileBehavior": "wrap", + "backgroundColor": null, + "backgroundMediaId": null, + "backgroundMedia": null, + "backgroundMediaMode": "cover", + "cssClass": null, + "cmsPageVersionId": "0fa91ce3e96a4bc2be4bd9ce752c3425", + "visibility": null, + "customFields": null, + "apiAlias": "cms_section" } ], - "description": "The video user id that attendee could use" - }, - "b2bFeatures": { - "type": "object", - "description": "The b2b features that available for the appointment", - "properties": { - "quoteManagement": { - "type": "boolean", - "description": "To know if the quote management is enabled for current customer" - } - } - } - }, - "example": { - "mercureSubscriberTopics": [ - "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", - "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" - ], - "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", - "JWTMercureSubscriberToken": "jwt token for subscribing to updates", - "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", - "JWTMercurePublisherToken": "jwt token for publishing updates", - "attendeeName": "attendee name", - "videoUserId": null, - "b2bFeatures": { - "feature1": false, - "feature2": true - }, - "id": "2d2c358f1ca04098aacf12873c2eed82", - "newContextToken": "new context token to call the other routes", - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", - "salesChannelName": "Storefront", - "appointmentName": "Test Appointment", - "presentationGuideMode": "guided", - "isPreview": false, - "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" - } - }, - "CartDeliveryInformation": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_information" - ] - }, - "freeDelivery": { - "type": "boolean" - }, - "deliveryTime": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "min": { - "type": "integer" - }, - "max": { - "type": "integer" - }, - "unit": { - "type": "string" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" - ] - } - } - }, - "height": { - "type": "integer" - }, - "length": { - "type": "integer" - }, - "restockTime": { - "type": "integer" - }, - "stock": { - "type": "integer" + "translations": null, + "cssClass": null, + "config": null, + "previewMediaId": null, + "previewMedia": null, + "landingPages": null, + "id": "33e88c7994fa4cf79a1265e5105b93b2", + "customFields": null, + "apiAlias": "cms_page" }, - "weight": { - "type": "integer" + "category": { + "versionId": null, + "translated": { + "breadcrumb": [] + }, + "createdAt": null, + "updatedAt": null, + "afterCategoryId": null, + "parentId": null, + "mediaId": null, + "name": null, + "breadcrumb": [], + "path": null, + "level": null, + "active": null, + "childCount": null, + "visibleChildCount": 0, + "displayNestedProducts": null, + "parent": null, + "children": null, + "translations": null, + "media": null, + "cmsPageId": null, + "cmsPageIdSwitched": false, + "cmsPage": null, + "linkType": null, + "linkNewTab": null, + "internalLink": null, + "externalLink": null, + "visible": null, + "type": null, + "productAssignmentType": null, + "description": null, + "metaTitle": null, + "metaDescription": null, + "keywords": null, + "seoUrls": null, + "customEntityTypeId": null, + "id": "34f21c5eb6d54a939f10973204aa5f08", + "customFields": null, + "apiAlias": "category" }, - "width": { - "type": "integer" - } - }, - "required": [ - "apiAlias" - ] - }, - "CartError": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } - } - } - } - }, - "CartItems": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - } + "apiAlias": "pwa_page_result" } }, "LineItemType": { @@ -61172,584 +53367,299 @@ "type": "string" } } - } - } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" - }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" - } - } - }, - "referencedId": { - "type": "string" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } - }, - "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "StateForAll": { - "type": "object", - "properties": { - "currentGuideProductId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "lastActiveGuideSection": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentSectionId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "currentSlideAlias": { - "type": "integer", - "default": 0 - }, - "currentSlideData": { - "anyOf": [ - { - "$ref": "#/components/schemas/DynamicProductListingPageOpenedPayload" - }, - { - "type": "null" - } - ] - }, - "currentDynamicPage": { - "$ref": "#/components/schemas/DynamicPageOpenedPayload" - }, - "started": { - "type": "boolean", - "default": false - }, - "running": { - "type": "boolean", - "default": false - }, - "ended": { - "type": "boolean", - "default": false - }, - "startedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "endedAt": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "accessibleFrom": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "accessibleTo": { - "anyOf": [ - { - "type": "string", - "format": "date-time" - }, - { - "type": "null" - } - ] - }, - "appointmentMode": { - "type": "string", - "enum": [ - "guided", - "self" - ] - }, - "videoAudioSettings": { - "type": "string", - "enum": [ - "both", - "none", - "audio-only" - ], - "default": "none" - }, - "videoRoomUrl": { - "type": "string", - "default": "" - }, - "attendeeRestrictionType": { - "anyOf": [ - { - "type": "string", - "enum": [ - "open", - "customer", - "rules" - ] - }, - { - "type": "null" - } - ] - }, - "productDetailDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" - } - ] - }, - "quickviewPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - { - "type": "null" + } } + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" ] }, - "productListingDefaultPageId": { - "anyOf": [ - { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" }, - { - "type": "null" + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" } - ] + } }, - "broadcastMode": { - "type": "boolean", - "default": false + "referencedId": { + "type": "string" }, - "viewMode": { - "type": "string", - "enum": [ - "onlyYou", - "presentation", - "videoGrid" - ], - "default": "presentation" + "removable": { + "type": "boolean" }, - "allowScreenSharing": { - "type": "boolean", - "default": false + "stackable": { + "type": "boolean" }, - "extensions": { + "states": { "type": "array", - "default": [] + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } + }, + "type": { + "$ref": "#/components/schemas/LineItemType" + }, + "uniqueIdentifier": { + "type": "string" } - } + }, + "required": [ + "id", + "type" + ] }, - "GuidePresentationStateResponse": { + "AttendeeInsights": { "type": "object", + "description": "Attendee Insights", "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" + }, + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" } }, "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "hasJoined": true - } - }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 } } }, - "StateForGuides": { + "DiscountType": { + "type": "string", + "description": "Type of the discount", + "enum": [ + "percentage", + "absolute" + ] + }, + "AddTempDiscountRequestBody": { "type": "object", + "required": [ + "discountType", + "discountValue", + "appliedItemIds" + ], "properties": { - "clients": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "inactiveClients": { + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + }, + "appliedItemIds": { "type": "array", "items": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "default": [] + "description": "Ids of the items to which the discount should be applied" + } + } + }, + "AddCartDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "guides": { + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + } + } + }, + "JoinAppointmentResponse": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "mercureSubscriberTopics": { "type": "array", "items": { - "type": "string" + "type": "string", + "description": "mercure topic" }, - "default": [] + "description": "The topics to which the attendee/guide can subscribe for" }, - "videoGuideToken": { - "anyOf": [ + "mercurePublisherTopic": { + "oneOf": [ { "type": "string" }, { "type": "null" } - ] - }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "extensions": { - "type": "array", - "default": [] - } - } - }, - "CartPriceReference": { - "type": "object", - "properties": { - "purchaseUnit": { - "type": "number" - }, - "referenceUnit": { - "type": "number" - }, - "unitName": { - "type": "string" - }, - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_reference" - ] + ], + "description": "The topic to which the attendee/guide can send updates" }, - "listPrice": { + "JWTMercureSubscriberToken": { "oneOf": [ { - "$ref": "#/components/schemas/CartListPrice" + "type": "string" }, { "type": "null" } - ] + ], + "description": "The JWT mercure token to publish updates" }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" + "mercureHubPublicUrl": { + "oneOf": [ + { + "type": "string" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] + { + "type": "null" } - }, - "nullable": true - }, - "hasRange": { - "type": "boolean" + ], + "description": "The mercure hub url to connect for subscribing and updating" }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true - } - }, - "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitName" - ] - }, - "CartDelivery": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "JWTMercurePublisherToken": { + "oneOf": [ + { + "type": "string" }, - "latest": { - "type": "string", - "format": "date-time" + { + "type": "null" } - } + ], + "description": "The JWT mercure token to subscribe for updates" }, - "location": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" - }, - "state": { - "$ref": "#/components/schemas/CountryState" - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The appointment id" }, - "positions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } + "newContextToken": { + "type": "string", + "description": "The new context token will be used in the header (sw-context-token) for calling the other routes" }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" + "attendeeId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The created Id for the attendee" }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - }, - "CartListPrice": { - "type": "object", - "description": "", - "properties": { - "discount": { - "type": "number" + "salesChannelId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "The id of the current sales channel" }, - "percentage": { - "type": "number" + "salesChannelName": { + "type": "string", + "description": "The name of the current sales channel" }, - "price": { - "type": "number" + "appointmentName": { + "type": "string", + "description": "The name of the appointment" }, - "apiAlias": { + "presentationGuideMode": { "type": "string", "enum": [ - "cart_list_price" - ] - } - }, - "required": [ - "apiAlias" - ] - }, - "CartDeliveryPosition": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" + "self", + "guided" + ], + "description": "The type of the appointment" + }, + "isPreview": { + "type": "boolean", + "description": "To see if it's a preview appointment" + }, + "attendeeName": { + "oneOf": [ + { + "type": "string" }, - "latest": { - "type": "string", - "format": "date-time" + { + "type": "null" } - } - }, - "identifier": { - "type": "string" + ], + "description": "The name of the attendee" }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "videoUserId": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The video user id that attendee could use" }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "b2bFeatures": { + "type": "object", + "description": "The b2b features that available for the appointment", + "properties": { + "quoteManagement": { + "type": "boolean", + "description": "To know if the quote management is enabled for current customer" + } + } } + }, + "example": { + "mercureSubscriberTopics": [ + "gs-guide-actions-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-client-2d2c358f1ca04098aacf12873c2eed82", + "gs-presentation-state-for-all-2d2c358f1ca04098aacf12873c2eed82" + ], + "mercurePublisherTopic": "gs-client-actions-2d2c358f1ca04098aacf12873c2eed82", + "JWTMercureSubscriberToken": "jwt token for subscribing to updates", + "mercureHubPublicUrl": "http://localhost:8081/.well-known/mercure", + "JWTMercurePublisherToken": "jwt token for publishing updates", + "attendeeName": "attendee name", + "videoUserId": null, + "b2bFeatures": { + "feature1": false, + "feature2": true + }, + "id": "2d2c358f1ca04098aacf12873c2eed82", + "newContextToken": "new context token to call the other routes", + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "salesChannelId": "4a791ec7f9ff46b2ad67ae2f562891d3", + "salesChannelName": "Storefront", + "appointmentName": "Test Appointment", + "presentationGuideMode": "guided", + "isPreview": false, + "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" } } }, @@ -62082,12 +53992,13 @@ "securitySchemes": { "oAuth": { "type": "oauth2", - "description": "Authentication API", + "description": "Authentication using OAuth 2.0", "flows": { "password": { - "tokenUrl": "http://localhost:8000/api/oauth/token", + "tokenUrl": "/api/oauth/token", "scopes": { - "write": "Full write access" + "write": "Full write access", + "admin": "Admin scope for administrative operations" } }, "clientCredentials": { @@ -62348,6 +54259,14 @@ "name": "Main Category", "description": "The endpoint for operations on Main Category" }, + { + "name": "Measurement Display Unit", + "description": "The endpoint for operations on Measurement Display Unit" + }, + { + "name": "Measurement System", + "description": "The endpoint for operations on Measurement System" + }, { "name": "Media", "description": "The endpoint for operations on Media" diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index 6ad9b40..2fd7e85 100644 --- a/SwagDigitalSalesRooms-adminapi.summary.json +++ b/SwagDigitalSalesRooms-adminapi.summary.json @@ -12,6 +12,7 @@ "/_action/dsr/appointment/{appointmentId}/instant-listing", "/_action/dsr/appointment/{appointmentId}/join-as-guide", "/_action/dsr/appointment/{appointmentId}/presentation/state", + "/_action/dsr/appointment/{appointmentId}/shopping-lists/{shoppingListId}", "/_action/dsr/appointment/{appointmentId}/start", "/_action/dsr/appointment/{appointmentId}/video-room", "/_action/dsr/appointment/{appointmentId}/widgets/attendee-insights", @@ -19,41 +20,6 @@ "/_action/dsr/appointment/{appointmentId}/widgets/cart-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/last-seen-statistics", "/_action/dsr/appointment/{appointmentId}/widgets/wishlist-statistics", - "/aggregate/acl-role", - "/aggregate/app", - "/aggregate/app-action-button", - "/aggregate/app-administration-snippet", - "/aggregate/app-cms-block", - "/aggregate/app-flow-action", - "/aggregate/app-flow-event", - "/aggregate/app-payment-method", - "/aggregate/app-script-condition", - "/aggregate/app-shipping-method", - "/aggregate/app-template", - "/aggregate/category", - "/aggregate/cms-block", - "/aggregate/cms-page", - "/aggregate/cms-section", - "/aggregate/cms-slot", - "/aggregate/country", - "/aggregate/country-state", - "/aggregate/currency", - "/aggregate/currency-country-rounding", - "/aggregate/custom-entity", - "/aggregate/custom-field", - "/aggregate/custom-field-set", - "/aggregate/custom-field-set-relation", - "/aggregate/customer", - "/aggregate/customer-address", - "/aggregate/customer-group", - "/aggregate/customer-recovery", - "/aggregate/customer-wishlist", - "/aggregate/customer-wishlist-product", - "/aggregate/delivery-time", - "/aggregate/document", - "/aggregate/document-base-config", - "/aggregate/document-base-config-sales-channel", - "/aggregate/document-type", "/aggregate/dsr-appointment", "/aggregate/dsr-appointment-attendee", "/aggregate/dsr-appointment-request", @@ -63,106 +29,6 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", - "/aggregate/flow", - "/aggregate/flow-sequence", - "/aggregate/flow-template", - "/aggregate/import-export-file", - "/aggregate/import-export-log", - "/aggregate/import-export-profile", - "/aggregate/integration", - "/aggregate/landing-page", - "/aggregate/language", - "/aggregate/locale", - "/aggregate/log-entry", - "/aggregate/mail-header-footer", - "/aggregate/mail-template", - "/aggregate/mail-template-type", - "/aggregate/main-category", - "/aggregate/media", - "/aggregate/media-default-folder", - "/aggregate/media-folder", - "/aggregate/media-folder-configuration", - "/aggregate/media-thumbnail", - "/aggregate/media-thumbnail-size", - "/aggregate/newsletter-recipient", - "/aggregate/notification", - "/aggregate/number-range", - "/aggregate/number-range-sales-channel", - "/aggregate/number-range-state", - "/aggregate/number-range-type", - "/aggregate/order", - "/aggregate/order-address", - "/aggregate/order-customer", - "/aggregate/order-delivery", - "/aggregate/order-delivery-position", - "/aggregate/order-line-item", - "/aggregate/order-line-item-download", - "/aggregate/order-transaction", - "/aggregate/order-transaction-capture", - "/aggregate/order-transaction-capture-refund", - "/aggregate/order-transaction-capture-refund-position", - "/aggregate/payment-method", - "/aggregate/plugin", - "/aggregate/product", - "/aggregate/product-configurator-setting", - "/aggregate/product-cross-selling", - "/aggregate/product-cross-selling-assigned-products", - "/aggregate/product-download", - "/aggregate/product-export", - "/aggregate/product-feature-set", - "/aggregate/product-keyword-dictionary", - "/aggregate/product-manufacturer", - "/aggregate/product-media", - "/aggregate/product-price", - "/aggregate/product-review", - "/aggregate/product-search-config", - "/aggregate/product-search-config-field", - "/aggregate/product-search-keyword", - "/aggregate/product-sorting", - "/aggregate/product-stream", - "/aggregate/product-stream-filter", - "/aggregate/product-visibility", - "/aggregate/promotion", - "/aggregate/promotion-discount", - "/aggregate/promotion-discount-prices", - "/aggregate/promotion-individual-code", - "/aggregate/promotion-sales-channel", - "/aggregate/promotion-setgroup", - "/aggregate/property-group", - "/aggregate/property-group-option", - "/aggregate/rule", - "/aggregate/rule-condition", - "/aggregate/sales-channel", - "/aggregate/sales-channel-analytics", - "/aggregate/sales-channel-domain", - "/aggregate/sales-channel-type", - "/aggregate/salutation", - "/aggregate/scheduled-task", - "/aggregate/script", - "/aggregate/seo-url", - "/aggregate/seo-url-template", - "/aggregate/shipping-method", - "/aggregate/shipping-method-price", - "/aggregate/snippet", - "/aggregate/snippet-set", - "/aggregate/state-machine", - "/aggregate/state-machine-history", - "/aggregate/state-machine-state", - "/aggregate/state-machine-transition", - "/aggregate/system-config", - "/aggregate/tag", - "/aggregate/tax", - "/aggregate/tax-provider", - "/aggregate/tax-rule", - "/aggregate/tax-rule-type", - "/aggregate/theme", - "/aggregate/unit", - "/aggregate/user", - "/aggregate/user-access-key", - "/aggregate/user-config", - "/aggregate/user-recovery", - "/aggregate/webhook", - "/aggregate/webhook-event-log", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -249,6 +115,7 @@ "CmsSectionJsonApi", "CmsSlot", "CmsSlotJsonApi", + "ConsentState", "Country", "CountryJsonApi", "CountryState", @@ -311,7 +178,9 @@ "DsrPresentationCmsPageJsonApi", "DsrPresentationJsonApi", "DynamicPageOpenedPayload", + "DynamicProductListingPageOpenedPayload", "EqualsFilter", + "Excludes", "Filters", "Flow", "FlowJsonApi", @@ -355,6 +224,11 @@ "MailTemplateTypeJsonApi", "MainCategory", "MainCategoryJsonApi", + "MeasurementDisplayUnit", + "MeasurementDisplayUnitJsonApi", + "MeasurementSystem", + "MeasurementSystemJsonApi", + "MeasurementUnits", "Media", "MediaDefaultFolder", "MediaDefaultFolderJsonApi", From f77f5363ea1f269a3994b8045ea83afec61e59de Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Mar 2026 12:00:35 +0200 Subject: [PATCH 56/63] [create-pull-request] automated change (#465) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 3500 +++++++++++++++--- SwagCustomizedProducts-adminapi.summary.json | 7 + 2 files changed, 3082 insertions(+), 425 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index bc63e4b..a86444a 100644 --- a/SwagCustomizedProducts-adminapi.json +++ b/SwagCustomizedProducts-adminapi.json @@ -1,5 +1,5 @@ { - "openapi": "3.0.0", + "openapi": "3.1.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`.", @@ -7,7 +7,7 @@ "name": "MIT", "url": "https://github.com/shopware/shopware/blob/trunk/LICENSE" }, - "version": "6.6.10.11" + "version": "6.7.8.2" }, "servers": [ { @@ -210,6 +210,21 @@ "summary": "Search for the Swag Customized Products Template resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplate", + "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": { @@ -736,6 +751,21 @@ "summary": "Search for the Swag Customized Products Template Configuration resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateConfiguration", + "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": { @@ -1262,6 +1292,21 @@ "summary": "Search for the Swag Customized Products Template Configuration Share resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateConfigurationShare", + "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": { @@ -1788,6 +1833,21 @@ "summary": "Search for the Swag Customized Products Template Exclusion resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusion", + "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": { @@ -2314,6 +2374,21 @@ "summary": "Search for the Swag Customized Products Template Exclusion Condition resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusionCondition", + "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": { @@ -2840,6 +2915,21 @@ "summary": "Search for the Swag Customized Products Template Exclusion Operator resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateExclusionOperator", + "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": { @@ -3366,6 +3456,21 @@ "summary": "Search for the Swag Customized Products Template Option resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOption", + "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": { @@ -3892,6 +3997,21 @@ "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": { @@ -4418,6 +4538,21 @@ "summary": "Search for the Swag Customized Products Template Option Value resources.", "description": "", "operationId": "searchSwagCustomizedProductsTemplateOptionValue", + "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": { @@ -4944,6 +5079,21 @@ "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": { @@ -5645,19 +5795,21 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -5784,19 +5936,21 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the ACL role defined.", "type": "string" }, "description": { + "description": "A short description of the ACL role.", "type": "string" }, "privileges": { "type": "array", "items": { - "type": "object", - "additionalProperties": false + "type": "string" } }, "deletedAt": { + "description": "Time and date when the ACL role was deleted.", "type": "string", "format": "date-time" }, @@ -5888,34 +6042,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -5935,9 +6098,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -5947,12 +6112,16 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, + "contextGatewayUrl": { + "type": "string" + }, "inAppPurchasesGatewayUrl": { "type": "string" }, @@ -5965,6 +6134,12 @@ "selfManaged": { "type": "boolean" }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string" }, @@ -5978,10 +6153,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6393,34 +6570,43 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the app.", "type": "string" }, "path": { + "description": "A relative URL to the app.", "type": "string" }, "author": { + "description": "Creator of the App.", "type": "string" }, "copyright": { + "description": "Legal rights on the created app.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the app is enabled for selection.", "type": "boolean" }, "configurable": { + "description": "When boolean value is `true`, the app is configurable for further customizations.", "type": "boolean" }, "privacy": { + "description": "Privacy-related configuration properties like user data protection, consent mechanisms, or data privacy compliance for an app.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon for the app. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -6440,9 +6626,11 @@ } }, "allowDisable": { + "description": "When boolean value is `true`, then the users have the option to deactivate specific aspects of the app.", "type": "boolean" }, "baseAppUrl": { + "description": "Root URL for an app.", "type": "string" }, "allowedHosts": { @@ -6452,12 +6640,16 @@ } }, "templateLoadPriority": { + "description": "A numerical value to prioritize one of the templates from the list.", "type": "integer", "format": "int64" }, "checkoutGatewayUrl": { "type": "string" }, + "contextGatewayUrl": { + "type": "string" + }, "inAppPurchasesGatewayUrl": { "type": "string" }, @@ -6470,6 +6662,12 @@ "selfManaged": { "type": "boolean" }, + "requestedPrivileges": { + "type": "array", + "items": { + "type": "string" + } + }, "label": { "type": "string" }, @@ -6483,10 +6681,12 @@ "type": "object" }, "integrationId": { + "description": "Unique identity of integration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "aclRoleId": { + "description": "Unique identity of ACL Role.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6594,21 +6794,26 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6681,21 +6886,26 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "view": { + "description": "Indicates whether it is detail page view or listing page view.", "type": "string" }, "url": { + "description": "An url associated with the AppActionButton.", "type": "string" }, "action": { + "description": "Indicates the action or functionality that the button performs when clicked or interacted with.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6821,21 +7031,25 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object" }, "template": { + "description": "Template that defines app CMS block.", "type": "string" }, "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6908,21 +7122,25 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app's CMS block.", "type": "string" }, "block": { "type": "object" }, "template": { + "description": "Template that defines app CMS block.", "type": "string" }, "styles": { + "description": "Parameter that relates to the styles or formatting within CMS block.", "type": "string" }, "label": { "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -6965,10 +7183,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app flow action.", "type": "string" }, "badge": { @@ -6993,7 +7213,7 @@ "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -7001,6 +7221,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -7116,10 +7337,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of app flow action.", "type": "string" }, "badge": { @@ -7144,7 +7367,7 @@ "type": "string" }, "icon": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Icon to identify app flow action. Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -7152,6 +7375,7 @@ "type": "string" }, "url": { + "description": "An URL to app flow action.", "type": "string" }, "delayable": { @@ -7213,10 +7437,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, "aware": { @@ -7322,10 +7548,12 @@ "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the AppFlowEvent.", "type": "string" }, "aware": { @@ -7378,38 +7606,49 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Name of the app.", "type": "string" }, "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7534,38 +7773,49 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Name of the app.", "type": "string" }, "identifier": { + "description": "It is a unique identity of an AppPaymentMethod.", "type": "string" }, "payUrl": { + "description": "A URL sending the pay request.", "type": "string" }, "finalizeUrl": { + "description": "A URL that redirects the user back to the shop.", "type": "string" }, "validateUrl": { + "description": "A validate URL confirms the authenticity of a payment reference when accessed.", "type": "string" }, "captureUrl": { + "description": "A capture URL allows the payments to be processed and completed once validated.", "type": "string" }, "refundUrl": { + "description": "A refund URL is used to initiate the refund process for a purchase.", "type": "string" }, "recurringUrl": { + "description": "A URL to payment to handle recurring orders like subscriptions.", "type": "string" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "originalMediaId": { + "description": "Unique identity of original media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7611,24 +7861,29 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, "script": { + "description": "Internal field.", "type": "string" }, "config": { "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7730,24 +7985,29 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an AppScriptCondition.", "type": "string" }, "name": { "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app script conditions are available for selection.", "type": "boolean" }, "group": { + "description": "Categorizes script conditions within a specific group.", "type": "string" }, "script": { + "description": "Internal field.", "type": "string" }, "config": { "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -7992,15 +8252,19 @@ "pattern": "^[0-9a-f]{32}$" }, "template": { + "description": "Template for an app.", "type": "string" }, "path": { + "description": "A relative URL to the app template.", "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8071,15 +8335,19 @@ "pattern": "^[0-9a-f]{32}$" }, "template": { + "description": "Template for an app.", "type": "string" }, "path": { + "description": "A relative URL to the app template.", "type": "string" }, "active": { + "description": "When boolean value is `true`, defined app templates are available for selection.", "type": "boolean" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8131,6 +8399,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8139,10 +8408,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -8159,11 +8430,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -8173,15 +8446,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -8228,6 +8505,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8236,6 +8514,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8259,6 +8538,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of category.", "properties": { "links": { "type": "object", @@ -8288,6 +8568,7 @@ "type": "object" }, "children": { + "description": "Child categories within this category for hierarchical navigation", "properties": { "links": { "type": "object", @@ -8319,6 +8600,7 @@ "type": "object" }, "media": { + "description": "Category image or banner", "properties": { "links": { "type": "object", @@ -8410,6 +8692,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering categories", "properties": { "links": { "type": "object", @@ -8441,6 +8724,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the category", "properties": { "links": { "type": "object", @@ -8623,6 +8907,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "properties": { "links": { "type": "object", @@ -8685,6 +8970,7 @@ "pattern": "^[0-9a-f]{32}$" }, "afterCategoryId": { + "description": "Unique identity of the category under which the new category is to be created.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8693,10 +8979,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media added to identify category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "displayNestedProducts": { + "description": "Shows nested categories on a product category page.", "type": "boolean" }, "autoIncrement": { @@ -8713,11 +9001,13 @@ "readOnly": true }, "level": { + "description": "An integer value that denotes the level of nesting of a particular category located in an hierarchical category tree.", "type": "integer", "format": "int64", "readOnly": true }, "path": { + "description": "A relative URL to the category.", "type": "string", "readOnly": true }, @@ -8727,15 +9017,19 @@ "readOnly": true }, "type": { + "description": "Type of categories like `page`, `folder`, `link`.", "type": "string" }, "productAssignmentType": { + "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", "type": "string" }, "visible": { + "description": "Displays categories on category page when true.", "type": "boolean" }, "active": { + "description": "When boolean value is `true`, the category is listed for selection.", "type": "boolean" }, "cmsPageIdSwitched": { @@ -8782,6 +9076,7 @@ "type": "string" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8790,6 +9085,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -8811,16 +9107,19 @@ "type": "object" }, "parent": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Unique identity of category." }, "children": { + "description": "Child categories within this category for hierarchical navigation", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Category image or banner" }, "products": { "type": "array", @@ -8835,13 +9134,15 @@ } }, "tags": { + "description": "Tags for organizing and filtering categories", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the category" }, "productStream": { "$ref": "#/components/schemas/ProductStream" @@ -8871,6 +9172,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the category across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -8929,45 +9231,65 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -8985,20 +9307,13 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "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", @@ -9121,45 +9436,65 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsSectionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Order of the block indicated by number like 0, 1, 2,...", "type": "integer", "format": "int64" }, "type": { + "description": "Type of block can be 'image`, `text`, 'product-listing`, `image-two-column`, etc.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Unique name of the CMS Block.", "type": "string" }, "sectionPosition": { + "description": "Position of the section. It can either be `main` or `sidebar`.", "type": "string" }, "marginTop": { + "description": "Defines the margin area on the top of an element.", "type": "string" }, "marginBottom": { + "description": "Defines for the margin area on the bottom of an element.", "type": "string" }, "marginLeft": { + "description": "Defines for the margin area on the left of an element.", "type": "string" }, "marginRight": { + "description": "Defines the margin area on the right of an element.", "type": "string" }, "backgroundColor": { + "description": "Defines the background color of an element.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode accept values `cover`, `auto`, `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "visibility": { @@ -9177,20 +9512,13 @@ "type": "object" }, "sectionId": { + "description": "Unique identity of section.", "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", @@ -9240,12 +9568,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -9257,6 +9588,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9282,6 +9614,7 @@ "relationships": { "properties": { "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "properties": { "links": { "type": "object", @@ -9313,6 +9646,7 @@ "type": "object" }, "previewMedia": { + "description": "Preview image for the CMS page in admin panel and page selection", "properties": { "links": { "type": "object", @@ -9373,6 +9707,7 @@ "type": "object" }, "landingPages": { + "description": "Landing pages using this CMS layout", "properties": { "links": { "type": "object", @@ -9492,12 +9827,15 @@ "type": "string" }, "type": { + "description": "CMS page types can be `landingpage`, `page`, `product_list`, `product_detail`.", "type": "string" }, "entity": { + "description": "This field will be implemented in the future.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "config": { @@ -9509,6 +9847,7 @@ "type": "object" }, "previewMediaId": { + "description": "Unique identity of media to be previewed.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9532,13 +9871,15 @@ "type": "object" }, "sections": { + "description": "Content sections within the CMS page (layout blocks containing slots)", "type": "array", "items": { "$ref": "#/components/schemas/CmsSection" } }, "previewMedia": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Preview image for the CMS page in admin panel and page selection" }, "categories": { "type": "array", @@ -9547,6 +9888,7 @@ } }, "landingPages": { + "description": "Landing pages using this CMS layout", "type": "array", "items": { "$ref": "#/components/schemas/LandingPage" @@ -9585,39 +9927,57 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9638,14 +9998,6 @@ "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", @@ -9768,39 +10120,57 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "versionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "cmsPageVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "position": { + "description": "Position of occurrence of each section denoted by numerical values 0, 1, 2...", "type": "integer", "format": "int64" }, "type": { + "description": "Types of sections can be `sidebar` or `fullwidth`.", "type": "string" }, "locked": { "type": "boolean" }, "name": { + "description": "Name of the CMS section defined.", "type": "string" }, "sizingMode": { + "description": "Sizing mode can be `boxed` or `full_width`.", "type": "string" }, "mobileBehavior": { + "description": "Hides the sidebar on mobile viewports. It can hold values such as 'mobile', 'wrap', any other string or be unset.", "type": "string" }, "backgroundColor": { + "description": "Background color of CMS page.", "type": "string" }, "backgroundMediaId": { + "description": "Unique identity of CMS section's background media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "backgroundMediaMode": { + "description": "Background media mode can be `cover`, `auto` or `contain`.", "type": "string" }, "cssClass": { + "description": "One or more CSS classes added and separated by spaces.", "type": "string" }, "pageId": { + "description": "Unique identity of page where CMS section is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9821,14 +10191,6 @@ "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", @@ -9876,10 +10238,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -9896,13 +10267,7 @@ "readOnly": true }, "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -9975,10 +10340,19 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsBlockVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "fieldConfig": { + "type": "object" + }, "type": { + "description": "It indicates the types of content that can be defined within the slot which includes `image`, `text`, `form`, `product-listing`, `category-navigation`, `product-box`, `buy-box`, `sidebar-filter`, etc.", "type": "string" }, "slot": { + "description": "Key-value pair to configure which element to be shown in which slot.", "type": "string" }, "locked": { @@ -9995,13 +10369,7 @@ "readOnly": true }, "blockId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "fieldConfig": { - "type": "object" - }, - "cmsBlockVersionId": { + "description": "Unique identity of CMS block where slot is defined.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -10045,34 +10413,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -10119,21 +10497,26 @@ "type": "object" }, "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", "type": "boolean" }, "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", "type": "boolean" }, "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", "type": "boolean" }, "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, "isEu": { @@ -10155,6 +10538,7 @@ "relationships": { "properties": { "states": { + "description": "States/provinces/regions within the country", "properties": { "links": { "type": "object", @@ -10395,34 +10779,44 @@ "type": "string" }, "iso": { + "description": "Internationally recognized two-letter country codes. For example, DE, IN, NO, etc.", "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined countries must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country is available for selection in the storefront.", "type": "boolean" }, "shippingAvailable": { + "description": "The shipping availability for a country is enabled when boolean value is `true`.", "type": "boolean" }, "iso3": { + "description": "Internationally recognized three-letter country codes. For example, DEU, IND, NOR, etc.", "type": "string" }, "displayStateInRegistration": { + "description": "The country's state is displayed in the address when boolean value is `true`.", "type": "boolean" }, "forceStateInRegistration": { + "description": "State details in the address are force included when boolean value is `true`.", "type": "boolean" }, "checkVatIdPattern": { + "description": "Verify if VAT ID is valid or not.", "type": "boolean" }, "vatIdRequired": { + "description": "Set to true, if VAT ID is to be made mandatory.", "type": "boolean" }, "vatIdPattern": { + "description": "Unique VAT ID with country code and numbers, for example - GB999 9999", "type": "string" }, "customFields": { @@ -10469,21 +10863,26 @@ "type": "object" }, "postalCodeRequired": { + "description": "The postal code is made mandatory specification in the address, when boolean value is `true`.", "type": "boolean" }, "checkPostalCodePattern": { + "description": "Verify for valid postal code pattern.", "type": "boolean" }, "checkAdvancedPostalCodePattern": { + "description": "Verify for advanced postal code pattern.", "type": "boolean" }, "advancedPostalCodePattern": { + "description": "Wildcard formatted zip codes to allow easy searching in the frontend based on initial constants, for example - 24****, 1856**.", "type": "string" }, "addressFormat": { "type": "object" }, "defaultPostalCodePattern": { + "description": "Default pattern of postal or zip code.", "type": "string" }, "isEu": { @@ -10503,6 +10902,7 @@ "type": "object" }, "states": { + "description": "States/provinces/regions within the country", "type": "array", "items": { "$ref": "#/components/schemas/CountryState" @@ -10566,20 +10966,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -10713,20 +11117,24 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of the country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shortCode": { + "description": "An abbreviation for the country's state.", "type": "string" }, "name": { "type": "string" }, "position": { + "description": "Numerical value that indicates the order in which the defined states must be displayed in the frontend.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the country's state is available for selection in the storefront.", "type": "boolean" }, "customFields": { @@ -10786,13 +11194,16 @@ "pattern": "^[0-9a-f]{32}$" }, "factor": { + "description": "Currency exchange rate.", "type": "number", "format": "float" }, "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, "shortName": { @@ -10802,6 +11213,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -10810,6 +11222,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -11116,13 +11529,16 @@ "pattern": "^[0-9a-f]{32}$" }, "factor": { + "description": "Currency exchange rate.", "type": "number", "format": "float" }, "symbol": { + "description": "A currency symbol is a graphical representation used as shorthand for a currency's name, for example US Dollar - $", "type": "string" }, "isoCode": { + "description": "Standard international three digit code to represent currency. For example, USD.", "type": "string" }, "shortName": { @@ -11132,6 +11548,7 @@ "type": "string" }, "position": { + "description": "The order of the tabs for multiple currencies defined.", "type": "integer", "format": "int64" }, @@ -11140,6 +11557,7 @@ "type": "boolean" }, "taxFreeFrom": { + "description": "The value from which the tax must be exempted.", "type": "number", "format": "float" }, @@ -11494,6 +11912,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -11503,10 +11922,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11519,9 +11940,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -11556,6 +11979,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of the entity.", "type": "string" }, "fields": { @@ -11565,10 +11989,12 @@ "type": "object" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11581,9 +12007,11 @@ "type": "boolean" }, "customFieldsAware": { + "description": "Parameter that indicates the areas in which the custom field is supported.", "type": "boolean" }, "labelProperty": { + "description": "Specifies which property or attribute of the custom entity is used.", "type": "string" }, "deletedAt": { @@ -11621,30 +12049,39 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, + "includeInSearch": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11738,30 +12175,39 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field.", "type": "string" }, "type": { + "description": "Custom field type can be selection, media , etc", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field is enabled for use.", "type": "boolean" }, "customFieldSetId": { + "description": "Unique identity of customFieldSet.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "allowCustomerWrite": { + "description": "When boolean value is `true`, then customers have permission to write data in the custom field.", "type": "boolean" }, "allowCartExpose": { + "description": "When boolean value is `true`, then the custom field's data can be exposed within the shopping cart or order process.", "type": "boolean" }, "storeApiAware": { "type": "boolean" }, + "includeInSearch": { + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -11801,22 +12247,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -11974,22 +12425,27 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Unique name of a custom field set.", "type": "string" }, "config": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the custom field set is enabled for use.", "type": "boolean" }, "global": { + "description": "When set to `true`, the custom field set can be used across all sales channels.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined custom field set to be displayed.", "type": "integer", "format": "int64" }, "appId": { + "description": "Unique identity of an app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -12045,10 +12501,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -12113,10 +12571,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customFieldSetId": { + "description": "Unique identity of a custom field set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "createdAt": { @@ -12152,8 +12612,7 @@ "customerNumber", "firstName", "lastName", - "email", - "defaultPaymentMethodId" + "email" ], "properties": { "id": { @@ -12161,26 +12620,32 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -12190,77 +12655,98 @@ "readOnly": true }, "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for customer recovery.", "type": "string" }, "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", "format": "date-time" }, "birthday": { + "description": "To capture customer's birthday details.", "type": "string" }, "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { + "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true @@ -12269,6 +12755,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -12280,10 +12767,12 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -12295,10 +12784,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -12312,6 +12797,7 @@ "relationships": { "properties": { "group": { + "description": "Customer group determining pricing and permissions", "properties": { "links": { "type": "object", @@ -12370,6 +12856,7 @@ "type": "object" }, "language": { + "description": "Preferred language for customer communication", "properties": { "links": { "type": "object", @@ -12399,6 +12886,7 @@ "type": "object" }, "lastPaymentMethod": { + "description": "Last used payment method by the customer", "properties": { "links": { "type": "object", @@ -12428,6 +12916,7 @@ "type": "object" }, "defaultBillingAddress": { + "description": "Default billing address for the customer", "properties": { "links": { "type": "object", @@ -12457,6 +12946,7 @@ "type": "object" }, "activeBillingAddress": { + "description": "Currently active billing address in the session", "properties": { "links": { "type": "object", @@ -12486,6 +12976,7 @@ "type": "object" }, "defaultShippingAddress": { + "description": "Default shipping address for the customer", "properties": { "links": { "type": "object", @@ -12515,6 +13006,7 @@ "type": "object" }, "activeShippingAddress": { + "description": "Currently active shipping address in the session", "properties": { "links": { "type": "object", @@ -12544,6 +13036,7 @@ "type": "object" }, "salutation": { + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)", "properties": { "links": { "type": "object", @@ -12573,6 +13066,7 @@ "type": "object" }, "addresses": { + "description": "All addresses saved for the customer", "properties": { "links": { "type": "object", @@ -12635,6 +13129,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "properties": { "links": { "type": "object", @@ -12902,35 +13397,6 @@ } }, "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" @@ -12952,8 +13418,7 @@ "customerNumber", "firstName", "lastName", - "email", - "defaultPaymentMethodId" + "email" ], "properties": { "id": { @@ -12961,26 +13426,32 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "lastPaymentMethodId": { + "description": "Unique identity of previous payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultBillingAddressId": { + "description": "Unique identity of default billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultShippingAddressId": { + "description": "Unique identity of default shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -12990,77 +13461,98 @@ "readOnly": true }, "customerNumber": { + "description": "Unique number assigned to identity a customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "email": { + "description": "Email ID of the customer.", "type": "string" }, "title": { + "description": "Titles or honorifics like Mr, Mrs, etc.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "active": { + "description": "To keep the status of the customer active, the boolean value is set to `true`.", "type": "boolean" }, "doubleOptInRegistration": { + "description": "Set to `true` to allow user subscriptions to an email marketing list.", "type": "boolean" }, "doubleOptInEmailSentDate": { + "description": "Date and time when the double opt-in email was sent.", "type": "string", "format": "date-time" }, "doubleOptInConfirmDate": { + "description": "Date and time when the double opt-in email was confirmed.", "type": "string", "format": "date-time" }, "hash": { + "description": "Password hash for customer recovery.", "type": "string" }, "guest": { + "description": "Boolean value is `true` if it is to be a guest account.", "type": "boolean" }, "firstLogin": { + "description": "To capture date and time of customer's first login.", "type": "string", "format": "date-time" }, "lastLogin": { + "description": "To capture date and time of customer's last login.", "type": "string", "format": "date-time" }, "birthday": { + "description": "To capture customer's birthday details.", "type": "string" }, "lastOrderDate": { + "description": "Captures last order date.", "type": "string", "format": "date-time", "readOnly": true }, "orderCount": { + "description": "Captures the number of orders placed.", "type": "integer", "format": "int64", "readOnly": true }, "orderTotalAmount": { + "description": "Sum of total amount to be paid.", "type": "number", "format": "float", "readOnly": true }, "reviewCount": { + "description": "Number of reviews the customer has given.", "type": "integer", "format": "int64", "readOnly": true @@ -13069,6 +13561,7 @@ "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "tagIds": { @@ -13080,10 +13573,12 @@ "readOnly": true }, "requestedGroupId": { + "description": "Unique identity of requested group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "boundSalesChannelId": { + "description": "Unique identity of bonus sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13095,10 +13590,6 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, - "defaultPaymentMethodId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, "createdAt": { "type": "string", "format": "date-time", @@ -13110,33 +13601,42 @@ "readOnly": true }, "group": { - "$ref": "#/components/schemas/CustomerGroup" + "$ref": "#/components/schemas/CustomerGroup", + "description": "Customer group determining pricing and permissions" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Preferred language for customer communication" }, "lastPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Last used payment method by the customer" }, "defaultBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default billing address for the customer" }, "activeBillingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active billing address in the session" }, "defaultShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Default shipping address for the customer" }, "activeShippingAddress": { - "$ref": "#/components/schemas/CustomerAddress" + "$ref": "#/components/schemas/CustomerAddress", + "description": "Currently active shipping address in the session" }, "salutation": { - "$ref": "#/components/schemas/Salutation" + "$ref": "#/components/schemas/Salutation", + "description": "Customer salutation (e.g., Mr., Mrs., Ms.)" }, "addresses": { + "description": "All addresses saved for the customer", "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddress" @@ -13149,6 +13649,7 @@ } }, "tags": { + "description": "Tags assigned to the customer for organization and segmentation", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -13186,9 +13687,6 @@ }, "updatedBy": { "$ref": "#/components/schemas/User" - }, - "defaultPaymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" } }, "type": "object" @@ -13215,52 +13713,67 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, "city": { + "description": "Name of customer's city.", "type": "string" }, "company": { + "description": "Name of customer's company.", "type": "string" }, "street": { + "description": "Name of customer's street.", "type": "string" }, "department": { + "description": "Name of customer's department.", "type": "string" }, "title": { + "description": "Titles given to customer like Dr. , Prof., etc", "type": "string" }, "phoneNumber": { + "description": "Customer's phone number.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional customer's address information.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional customer's address information.", "type": "string" }, "hash": { @@ -13423,52 +13936,67 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of country's state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "zipcode": { + "description": "Postal or zip code of customer's address.", "type": "string" }, "city": { + "description": "Name of customer's city.", "type": "string" }, "company": { + "description": "Name of customer's company.", "type": "string" }, "street": { + "description": "Name of customer's street.", "type": "string" }, "department": { + "description": "Name of customer's department.", "type": "string" }, "title": { + "description": "Titles given to customer like Dr. , Prof., etc", "type": "string" }, "phoneNumber": { + "description": "Customer's phone number.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional customer's address information.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional customer's address information.", "type": "string" }, "hash": { @@ -13523,12 +14051,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -13674,12 +14204,14 @@ "type": "string" }, "displayGross": { + "description": "If boolean value is `true` gross value is displayed else, net value will be displayed to the customer.", "type": "boolean" }, "customFields": { "type": "object" }, "registrationActive": { + "description": "To enable the registration of partner customer group.", "type": "boolean" }, "registrationTitle": { @@ -13779,9 +14311,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13847,9 +14381,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for customer's account recovery.", "type": "string" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -13915,10 +14451,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14047,10 +14585,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14100,6 +14640,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14108,6 +14649,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14202,6 +14744,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14210,6 +14753,7 @@ "pattern": "^[0-9a-f]{32}$" }, "wishlistId": { + "description": "Unique identity of the wishlist.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -14255,14 +14799,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -14371,14 +14918,17 @@ "type": "string" }, "min": { + "description": "Minimum delivery time taken.", "type": "integer", "format": "int64" }, "max": { + "description": "Maximum delivery time taken.", "type": "integer", "format": "int64" }, "unit": { + "description": "Unit in which the delivery time is defined. For example, days or hours.", "type": "string" }, "customFields": { @@ -14424,8 +14974,7 @@ "documentTypeId", "orderId", "config", - "deepLinkCode", - "fileType" + "deepLinkCode" ], "properties": { "id": { @@ -14474,9 +15023,6 @@ "customFields": { "type": "object" }, - "fileType": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -14680,8 +15226,7 @@ "documentTypeId", "orderId", "config", - "deepLinkCode", - "fileType" + "deepLinkCode" ], "properties": { "id": { @@ -14730,9 +15275,6 @@ "customFields": { "type": "object" }, - "fileType": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -14785,26 +15327,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the document.", "type": "string" }, "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", "type": "string" }, "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, "documentNumber": { + "description": "Unique number associated with every document.", "type": "string" }, "config": { @@ -14855,6 +15404,7 @@ "type": "object" }, "logo": { + "description": "Logo in the document at the top-right corner.", "properties": { "links": { "type": "object", @@ -14935,26 +15485,33 @@ "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of the document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "logoId": { + "description": "Unique identity of the company logo.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the document.", "type": "string" }, "filenamePrefix": { + "description": "A prefix name added to the file name separated by an underscore.", "type": "string" }, "filenameSuffix": { + "description": "A suffix name added to the file name separated by an underscore.", "type": "string" }, "global": { + "description": "When set to `true`, the document can be used across all sales channels.", "type": "boolean" }, "documentNumber": { + "description": "Unique number associated with every document.", "type": "string" }, "config": { @@ -14977,7 +15534,8 @@ "$ref": "#/components/schemas/DocumentType" }, "logo": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Logo in the document at the top-right corner." }, "salesChannels": { "type": "array", @@ -15005,14 +15563,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15135,14 +15696,17 @@ "pattern": "^[0-9a-f]{32}$" }, "documentBaseConfigId": { + "description": "Unique identity of document's base config.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "documentTypeId": { + "description": "Unique identity of document type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15189,6 +15753,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -15326,6 +15891,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of document type.", "type": "string" }, "createdAt": { @@ -15383,29 +15949,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15502,29 +16075,36 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow.", "type": "string" }, "eventName": { + "description": "Name of the event.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the flows from the list.", "type": "integer", "format": "int64" }, "invalid": { + "description": "When the boolean value is `true`, the flow is no more available for usage.", "type": "boolean", "readOnly": true }, "active": { + "description": "When boolean value is `true`, the flow is available for selection.", "type": "boolean" }, "description": { + "description": "A short description of the defined flow.", "type": "string" }, "customFields": { "type": "object" }, "appFlowEventId": { + "description": "Unique identity of app flow event.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -15567,24 +16147,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -15673,6 +16258,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of flow sequence.", "properties": { "links": { "type": "object", @@ -15781,24 +16367,29 @@ "pattern": "^[0-9a-f]{32}$" }, "flowId": { + "description": "Unique identity of flow.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action in the flow sequence.", "type": "string" }, "config": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined flow sequence is to be displayed.", "type": "integer", "format": "int64" }, "displayGroup": { + "description": "The group to which the flow sequence is visible.", "type": "integer", "format": "int64" }, @@ -15833,7 +16424,8 @@ "$ref": "#/components/schemas/Rule" }, "parent": { - "$ref": "#/components/schemas/FlowSequence" + "$ref": "#/components/schemas/FlowSequence", + "description": "Unique identity of flow sequence." }, "children": { "type": "array", @@ -15864,6 +16456,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -15896,6 +16489,7 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the flow template.", "type": "string" }, "config": { @@ -15933,20 +16527,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -16012,20 +16611,25 @@ "pattern": "^[0-9a-f]{32}$" }, "originalName": { + "description": "Original name of the import-export file.", "type": "string" }, "path": { + "description": "A relative URL to the import-export file.", "type": "string" }, "expireDate": { + "description": "Date and time of import-export file expiry.", "type": "string", "format": "date-time" }, "size": { + "description": "Size of the import-export file.", "type": "integer", "format": "int64" }, "accessToken": { + "description": "Secret key to access import-export file.", "type": "string" }, "createdAt": { @@ -16355,6 +16959,7 @@ { "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", @@ -16366,25 +16971,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -16396,12 +17009,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -16460,6 +17067,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "label", "sourceEntity", "fileType", @@ -16471,25 +17079,33 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "technicalName": { + "type": "string" + }, "label": { "type": "string" }, "type": { + "description": "Import-export type can be orders, customers, categories.", "type": "string" }, "systemDefault": { + "description": "When boolean value is true `true`, then its a system default profile.", "type": "boolean" }, "sourceEntity": { "type": "string" }, "fileType": { + "description": "Type of file like PDF.", "type": "string" }, "delimiter": { + "description": "Characters used as the delimiter for the specific profile, aiding in proper data parsing during import-export operations.", "type": "string" }, "enclosure": { + "description": "Specifies the enclosure character used to wrap or enclose data fields, especially when those fields contain special characters or delimiters.", "type": "string" }, "mapping": { @@ -16501,12 +17117,6 @@ "config": { "type": "object" }, - "technicalName": { - "type": "string" - }, - "name": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -16548,25 +17158,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -16647,6 +17263,37 @@ }, "type": "object" }, + "stateMachineHistoryEntries": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/integration/1115b855bb2a508bc2ca0609cc2d0f65/stateMachineHistoryEntries" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "state_machine_history" + }, + "id": { + "type": "string", + "example": "c78c7ea361b7def0876b75bd1bd37879" + } + } + } + } + }, + "type": "object" + }, "aclRoles": { "properties": { "links": { @@ -16700,25 +17347,31 @@ "pattern": "^[0-9a-f]{32}$" }, "label": { + "description": "Label given to Integration.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key required for secure communication.", "type": "string" }, "lastUsageAt": { + "description": "Date and time when teh integration was last used.", "type": "string", "format": "date-time" }, "admin": { + "description": "When boolean value is `true`, it indicates this is a administrative integration that requires elevated permissions.", "type": "boolean" }, "customFields": { "type": "object" }, "deletedAt": { + "description": "Date and time when the integration was deleted.", "type": "string", "format": "date-time" }, @@ -16771,6 +17424,12 @@ "app": { "$ref": "#/components/schemas/App" }, + "stateMachineHistoryEntries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StateMachineHistory" + } + }, "aclRoles": { "type": "array", "items": { @@ -16908,6 +17567,7 @@ "type": "object" }, "cmsPage": { + "description": "CMS page layout for the landing page", "properties": { "links": { "type": "object", @@ -16968,6 +17628,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "properties": { "links": { "type": "object", @@ -17074,7 +17735,8 @@ } }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "CMS page layout for the landing page" }, "salesChannels": { "type": "array", @@ -17083,6 +17745,7 @@ } }, "seoUrls": { + "description": "SEO-friendly URLs for the landing page across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -17177,16 +17840,22 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -17203,6 +17872,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of language.", "properties": { "links": { "type": "object", @@ -17232,6 +17902,7 @@ "type": "object" }, "locale": { + "description": "Locale defining regional settings (date, time, number formats)", "properties": { "links": { "type": "object", @@ -17261,6 +17932,7 @@ "type": "object" }, "translationCode": { + "description": "Locale used for translating content", "properties": { "links": { "type": "object", @@ -17290,6 +17962,7 @@ "type": "object" }, "children": { + "description": "Child languages inheriting from this parent language", "properties": { "links": { "type": "object", @@ -17653,16 +18326,22 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationCodeId": { + "description": "Unique identity of translation code.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the language.", "type": "string" }, + "active": { + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -17677,15 +18356,19 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Unique identity of language." }, "locale": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale defining regional settings (date, time, number formats)" }, "translationCode": { - "$ref": "#/components/schemas/Locale" + "$ref": "#/components/schemas/Locale", + "description": "Locale used for translating content" }, "children": { + "description": "Child languages inheriting from this parent language", "type": "array", "items": { "$ref": "#/components/schemas/Language" @@ -17770,6 +18453,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -17880,6 +18564,7 @@ "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Code given to the locale. For example: en-CA.", "type": "string" }, "name": { @@ -17935,9 +18620,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -17976,9 +18663,11 @@ "pattern": "^[0-9a-f]{32}$" }, "message": { + "description": "Indicates text or content of a log entry.", "type": "string" }, "level": { + "description": "It indicates the level or severity of the log entry. For example: BUG, ERROR, etc.", "type": "integer", "format": "int64" }, @@ -18399,6 +19088,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -18480,6 +19170,7 @@ "type": "string" }, "technicalName": { + "description": "Technical name of mail template.", "type": "string" }, "availableEntities": { @@ -18532,6 +19223,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18540,6 +19232,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18548,6 +19241,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18672,6 +19366,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18680,6 +19375,7 @@ "pattern": "^[0-9a-f]{32}$" }, "categoryId": { + "description": "Unique identity of the category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18688,6 +19384,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -18713,6 +19410,289 @@ }, "type": "object" }, + "MeasurementDisplayUnitJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "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": { + "measurementSystem": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-display-unit/6e9d57f5c7acc720b0168c16387bbc61/measurementSystem" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_system" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "c0484ac171c930ce54e78cd2e0d80e5a" + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementDisplayUnit": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "measurementSystemId", + "default", + "type", + "shortName", + "factor", + "precision" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "measurementSystemId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "default": { + "type": "boolean" + }, + "type": { + "type": "string" + }, + "shortName": { + "type": "string" + }, + "factor": { + "type": "number", + "format": "float" + }, + "precision": { + "type": "integer", + "format": "int64" + }, + "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" + }, + "measurementSystem": { + "$ref": "#/components/schemas/MeasurementSystem" + } + }, + "type": "object" + }, + "MeasurementSystemJsonApi": { + "description": "Added since version: 6.7.1.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "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": { + "units": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/measurement-system/67b401daf737cc26c1bbe7e50b9d9acb/units" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "measurement_display_unit" + }, + "id": { + "type": "string", + "example": "b98b3dfbd27e710e6c3ceeae58770b52" + } + } + } + } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "MeasurementSystem": { + "description": "Added since version: 6.7.1.0", + "required": [ + "id", + "technicalName" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "technicalName": { + "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" + }, + "units": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MeasurementDisplayUnit" + } + } + }, + "type": "object" + }, "MediaJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -18729,29 +19709,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -18785,6 +19771,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -18938,6 +19925,7 @@ "type": "object" }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "properties": { "links": { "type": "object", @@ -19553,6 +20541,37 @@ }, "type": "object" }, + "a11yDocuments": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/a11yDocuments" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "example": "f6c460e0d75110fa1ec7529fe364dbb5" + } + } + } + } + }, + "type": "object" + }, "appPaymentMethods": { "properties": { "links": { @@ -19634,29 +20653,35 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of the user", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaFolderId": { + "description": "Unique identity of the media folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mimeType": { + "description": "A string sent along with a file indicating the type of the file. For example: image/jpeg.", "type": "string" }, "fileExtension": { - "type": "string", - "readOnly": true + "description": "Type of file indication. For example: jpeg, png.", + "type": "string" }, "uploadedAt": { + "description": "Date and time at which media was added.", "type": "string", "format": "date-time", "readOnly": true }, "fileName": { + "description": "Name of the media file uploaded.", "type": "string" }, "fileSize": { + "description": "Size of the file media file uploaded.", "type": "integer", "format": "int64", "readOnly": true @@ -19690,6 +20715,7 @@ "type": "boolean" }, "private": { + "description": "When `true`, the media display is kept private.", "type": "boolean" }, "customFields": { @@ -19816,6 +20842,7 @@ } }, "thumbnails": { + "description": "Generated thumbnail images in various sizes", "type": "array", "items": { "$ref": "#/components/schemas/MediaThumbnail" @@ -19929,6 +20956,12 @@ "$ref": "#/components/schemas/Document" } }, + "a11yDocuments": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Document" + } + }, "appPaymentMethods": { "type": "array", "items": { @@ -19961,6 +20994,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -20027,6 +21061,7 @@ "pattern": "^[0-9a-f]{32}$" }, "entity": { + "description": "Indicates in which particular entity.", "type": "string" }, "customFields": { @@ -20066,13 +21101,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20086,10 +21124,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -20108,6 +21148,7 @@ "relationships": { "properties": { "parent": { + "description": "Unique identity of media folder.", "properties": { "links": { "type": "object", @@ -20277,13 +21318,16 @@ "pattern": "^[0-9a-f]{32}$" }, "useParentConfiguration": { + "description": "When boolean value is `true`, the folder inherits the configuration settings of its parent folder.", "type": "boolean" }, "configurationId": { + "description": "Unique identity of configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "defaultFolderId": { + "description": "Unique identity of default folder.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -20297,10 +21341,12 @@ "readOnly": true }, "path": { + "description": "A relative URL to the media folder.", "type": "string", "readOnly": true }, "name": { + "description": "Name of media folder.", "type": "string" }, "customFields": { @@ -20317,7 +21363,8 @@ "readOnly": true }, "parent": { - "$ref": "#/components/schemas/MediaFolder" + "$ref": "#/components/schemas/MediaFolder", + "description": "Unique identity of media folder." }, "children": { "type": "array", @@ -20356,16 +21403,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -20467,16 +21518,20 @@ "pattern": "^[0-9a-f]{32}$" }, "createThumbnails": { + "description": "When boolean value is `true`, it enables thumbnail creation automatically.", "type": "boolean" }, "keepAspectRatio": { + "description": "When boolean value is `true`, the system maintains the aspect ratio of media files when generating.", "type": "boolean" }, "thumbnailQuality": { + "description": "Parameter that controls the balance between image quality and size when creating thumbnail images.", "type": "integer", "format": "int64" }, "private": { + "description": "When boolean value is `true`, the folder contents are restricted from public access.", "type": "boolean" }, "noAssociation": { @@ -20585,21 +21640,28 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -20648,6 +21710,35 @@ } }, "type": "object" + }, + "mediaThumbnailSize": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail/3863c110ff436b51dbc09a6ea14c56e0/mediaThumbnailSize" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail_size" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "0d0b8659a3a47e9d7e1481961f127fd0" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -20671,21 +21762,28 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaThumbnailSizeId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64", "readOnly": true }, "url": { - "description": "Runtime field, cannot be used as part of the criteria.", + "description": "Public url of media thumbnail. Runtime field, cannot be used as part of the criteria.", "type": "string" }, "path": { @@ -20706,6 +21804,9 @@ }, "media": { "$ref": "#/components/schemas/Media" + }, + "mediaThumbnailSize": { + "$ref": "#/components/schemas/MediaThumbnailSize" } }, "type": "object" @@ -20728,10 +21829,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -20780,6 +21883,37 @@ } }, "type": "object" + }, + "mediaThumbnails": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media-thumbnail-size/122652279edf3cc398ca024851b6f53f/mediaThumbnails" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "media_thumbnail" + }, + "id": { + "type": "string", + "example": "76ebc340ac8f9754c760c3ec742d2407" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -20802,10 +21936,12 @@ "pattern": "^[0-9a-f]{32}$" }, "width": { + "description": "Width of the thumbnail.", "type": "integer", "format": "int64" }, "height": { + "description": "Height of the thumbnail.", "type": "integer", "format": "int64" }, @@ -20827,6 +21963,12 @@ "items": { "$ref": "#/components/schemas/MediaFolderConfiguration" } + }, + "mediaThumbnails": { + "type": "array", + "items": { + "$ref": "#/components/schemas/MediaThumbnail" + } } }, "type": "object" @@ -20852,48 +21994,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21051,48 +22206,61 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email of the recipient.", "type": "string" }, "title": { + "description": "Title of the recipient's newsletter.", "type": "string" }, "firstName": { + "description": "First name of the recipient.", "type": "string" }, "lastName": { + "description": "Last name of the recipient.", "type": "string" }, "zipCode": { + "description": "Zipcode of the recipient's address.", "type": "string" }, "city": { + "description": "City of the recipient.", "type": "string" }, "street": { + "description": "Street of the recipient.", "type": "string" }, "status": { + "description": "When status is set, the NewsletterRecipient is made visible.", "type": "string" }, "hash": { + "description": "Password hash for account recovery.", "type": "string" }, "customFields": { "type": "object" }, "confirmedAt": { + "description": "Date and time when the Newsletter was received.", "type": "string", "format": "date-time" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21170,12 +22338,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -21186,10 +22357,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21284,12 +22457,15 @@ "pattern": "^[0-9a-f]{32}$" }, "status": { + "description": "When status is set, the Notification is made visible.", "type": "string" }, "message": { + "description": "Indicates text or content of a notification message.", "type": "string" }, "adminOnly": { + "description": "Parameter within a notification configuration that determines whether a notification is intended for administrators only.", "type": "boolean" }, "requiredPrivileges": { @@ -21300,10 +22476,12 @@ } }, "createdByIntegrationId": { + "description": "Unique identity of createdByIntegration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "createdByUserId": { + "description": "Unique identity of createdByUser.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21347,10 +22525,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -21360,9 +22540,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -21497,10 +22679,12 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "global": { + "description": "When set to `true`, the defined number range is used across all sales channels.", "type": "boolean" }, "name": { @@ -21510,9 +22694,11 @@ "type": "string" }, "pattern": { + "description": "Custom formatting in order to include for example, the date in the number range.", "type": "string" }, "start": { + "description": "If the start number were 12345, the following patterns would give the following numbers: Order{n}-{date}: Order12345-2019-05-23, Order{n}-{date_d.m.Y}: Order12345-23.05.2019", "type": "integer", "format": "int64" }, @@ -21565,14 +22751,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21696,14 +22885,17 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number rage.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of Sales channels.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "numberRangeTypeId": { + "description": "Unique identity of number rage type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21747,6 +22939,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21816,6 +23009,7 @@ "pattern": "^[0-9a-f]{32}$" }, "numberRangeId": { + "description": "Unique identity of number range.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -21857,12 +23051,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -21966,12 +23162,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Name of the number range type.", "type": "string" }, "typeName": { "type": "string" }, "global": { + "description": "When set to `true`, the defined number range type is used across all sales channels.", "type": "boolean" }, "customFields": { @@ -22039,9 +23237,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22049,23 +23249,44 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -22107,21 +23328,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -22183,33 +23408,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22223,10 +23459,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22285,6 +23523,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current order state (e.g., open, in_progress, completed, cancelled)", "properties": { "links": { "type": "object", @@ -22313,7 +23552,68 @@ }, "type": "object" }, + "primaryOrderDelivery": { + "description": "Primary delivery information for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderDelivery" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_delivery" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fdeeebdae32b4dfa39d3f4372d0554e9" + } + } + } + }, + "type": "object" + }, + "primaryOrderTransaction": { + "description": "Primary payment transaction for the order", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order/a240fa27925a635b08dc28c9e4f9216d/primaryOrderTransaction" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order_transaction" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "bbaa9e50388c524d97853a4fc4476b0e" + } + } + } + }, + "type": "object" + }, "orderCustomer": { + "description": "Customer information associated with the order", "properties": { "links": { "type": "object", @@ -22343,6 +23643,7 @@ "type": "object" }, "currency": { + "description": "Currency used for the order", "properties": { "links": { "type": "object", @@ -22372,6 +23673,7 @@ "type": "object" }, "language": { + "description": "Language used when placing the order", "properties": { "links": { "type": "object", @@ -22430,6 +23732,7 @@ "type": "object" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "properties": { "links": { "type": "object", @@ -22461,6 +23764,7 @@ "type": "object" }, "billingAddress": { + "description": "Billing address for the order", "properties": { "links": { "type": "object", @@ -22490,6 +23794,7 @@ "type": "object" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "properties": { "links": { "type": "object", @@ -22521,6 +23826,7 @@ "type": "object" }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "properties": { "links": { "type": "object", @@ -22552,6 +23858,7 @@ "type": "object" }, "transactions": { + "description": "Payment transactions for the order", "properties": { "links": { "type": "object", @@ -22583,6 +23890,7 @@ "type": "object" }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "properties": { "links": { "type": "object", @@ -22614,6 +23922,7 @@ "type": "object" }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "properties": { "links": { "type": "object", @@ -22739,9 +24048,11 @@ "readOnly": true }, "orderNumber": { + "description": "Unique number associated with every order.", "type": "string" }, "billingAddressId": { + "description": "Unique identity of the billing address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22749,23 +24060,44 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "primaryOrderDeliveryId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderDeliveryVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "primaryOrderTransactionVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, "currencyId": { + "description": "Unique identity of the currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderDateTime": { + "description": "Timestamp when the order was placed.", "type": "string", "format": "date-time" }, "orderDate": { + "description": "Date when the order was placed.", "type": "string", "readOnly": true }, @@ -22807,21 +24139,25 @@ "type": "object" }, "amountTotal": { + "description": "Gross price of the order.", "type": "number", "format": "float", "readOnly": true }, "amountNet": { + "description": "Net price of the order.", "type": "number", "format": "float", "readOnly": true }, "positionPrice": { + "description": "Price of each line item in the cart multiplied by its quantity excluding charges like shipping cost, rules, taxes etc.", "type": "number", "format": "float", "readOnly": true }, "taxStatus": { + "description": "TaxStatus takes `Free`, `Net` or `Gross` as values.", "type": "string", "readOnly": true }, @@ -22883,33 +24219,44 @@ "type": "object" }, "shippingTotal": { + "description": "Total shipping cost of the ordered product.", "type": "number", "format": "float", "readOnly": true }, "currencyFactor": { + "description": "Rate at which currency is exchanged.", "type": "number", "format": "float" }, "deepLinkCode": { + "description": "It is a generated special code linked to email. It is used to access orders placed by guest customers.", "type": "string" }, "affiliateCode": { + "description": "An affiliate code is an identification option with which website operators can mark outgoing links.", "type": "string" }, "campaignCode": { + "description": "A campaign code is the globally unique identifier for a campaign.", "type": "string" }, "customerComment": { + "description": "Comments given by comments.", + "type": "string" + }, + "internalComment": { "type": "string" }, "source": { + "description": "Source of orders either via normal order placement or subscriptions.", "type": "string" }, "taxCalculationType": { "type": "string" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22923,10 +24270,12 @@ "type": "object" }, "createdById": { + "description": "Unique identity of createdBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "updatedById": { + "description": "Unique identity of updatedBy.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -22983,54 +24332,73 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current order state (e.g., open, in_progress, completed, cancelled)" + }, + "primaryOrderDelivery": { + "$ref": "#/components/schemas/OrderDelivery", + "description": "Primary delivery information for the order" + }, + "primaryOrderTransaction": { + "$ref": "#/components/schemas/OrderTransaction", + "description": "Primary payment transaction for the order" }, "orderCustomer": { - "$ref": "#/components/schemas/OrderCustomer" + "$ref": "#/components/schemas/OrderCustomer", + "description": "Customer information associated with the order" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Currency used for the order" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Language used when placing the order" }, "salesChannel": { "$ref": "#/components/schemas/SalesChannel" }, "addresses": { + "description": "All addresses associated with the order (billing and shipping)", "type": "array", "items": { "$ref": "#/components/schemas/OrderAddress" } }, "billingAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Billing address for the order" }, "deliveries": { + "description": "Delivery information including shipping address and tracking", "type": "array", "items": { "$ref": "#/components/schemas/OrderDelivery" } }, "lineItems": { + "description": "Order line items (products, discounts, fees)", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItem" } }, "transactions": { + "description": "Payment transactions for the order", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransaction" } }, "documents": { + "description": "Generated documents (invoices, delivery notes, credit notes)", "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "tags": { + "description": "Tags assigned to the order for organization and filtering", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -23071,14 +24439,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23087,43 +24458,52 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "street": { + "description": "Street address", "type": "string" }, "zipcode": { + "description": "Zip code of the country.", "type": "string" }, "city": { + "description": "Name of the city.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "department": { + "description": "Name of the department.", "type": "string" }, "title": { - "type": "string" - }, - "vatId": { + "description": "Title name given to customer like DR. , Prof., etc.", "type": "string" }, "phoneNumber": { + "description": "Phone number of the customer.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional address input if necessary.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional address input if necessary.", "type": "string" }, "hash": { @@ -23133,6 +24513,11 @@ "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -23321,14 +24706,17 @@ "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryStateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23337,43 +24725,52 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "street": { + "description": "Street address", "type": "string" }, "zipcode": { + "description": "Zip code of the country.", "type": "string" }, "city": { + "description": "Name of the city.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "department": { + "description": "Name of the department.", "type": "string" }, "title": { - "type": "string" - }, - "vatId": { + "description": "Title name given to customer like DR. , Prof., etc.", "type": "string" }, "phoneNumber": { + "description": "Phone number of the customer.", "type": "string" }, "additionalAddressLine1": { + "description": "Additional address input if necessary.", "type": "string" }, "additionalAddressLine2": { + "description": "Additional address input if necessary.", "type": "string" }, "hash": { @@ -23383,6 +24780,11 @@ "customFields": { "type": "object" }, + "vatId": { + "description": "Unique identity of VAT.", + "type": "string", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -23438,10 +24840,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23450,22 +24854,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -23475,12 +24885,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -23609,10 +25021,12 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23621,22 +25035,28 @@ "pattern": "^[0-9a-f]{32}$" }, "email": { + "description": "Email address of the customer.", "type": "string" }, "salutationId": { + "description": "Unique identity of salutation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "firstName": { + "description": "First name of the customer.", "type": "string" }, "lastName": { + "description": "Last name of the customer.", "type": "string" }, "company": { + "description": "Name of the company.", "type": "string" }, "title": { + "description": "Title name given to the customer like Dr, prof. etc.", "type": "string" }, "vatIds": { @@ -23646,12 +25066,14 @@ } }, "customerNumber": { + "description": "Unique number assigned to the customer.", "type": "string" }, "customFields": { "type": "object" }, "remoteAddress": { + "description": "Anonymous IP address of the customer for last session.", "type": "string" }, "createdAt": { @@ -23702,6 +25124,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23710,6 +25133,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23718,10 +25142,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23732,10 +25158,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -23812,6 +25240,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)", "properties": { "links": { "type": "object", @@ -23870,6 +25299,7 @@ "type": "object" }, "shippingOrderAddress": { + "description": "Shipping address for this delivery", "properties": { "links": { "type": "object", @@ -23899,6 +25329,7 @@ "type": "object" }, "shippingMethod": { + "description": "Shipping method used for this delivery", "properties": { "links": { "type": "object", @@ -23928,6 +25359,7 @@ "type": "object" }, "positions": { + "description": "Line items included in this delivery", "properties": { "links": { "type": "object", @@ -23957,6 +25389,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-delivery/ec47a00e89a14dee454b699af8831df4/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -23987,6 +25448,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -23995,6 +25457,7 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingOrderAddressId": { + "description": "Unique identity of order's shipping address.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24003,10 +25466,12 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24017,10 +25482,12 @@ } }, "shippingDateEarliest": { + "description": "Date and time of earliest delivery of products.", "type": "string", "format": "date-time" }, "shippingDateLatest": { + "description": "Date and time of latest delivery of products.", "type": "string", "format": "date-time" }, @@ -24095,22 +25562,29 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current delivery state (e.g., open, shipped, delivered, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "shippingOrderAddress": { - "$ref": "#/components/schemas/OrderAddress" + "$ref": "#/components/schemas/OrderAddress", + "description": "Shipping address for this delivery" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Shipping method used for this delivery" }, "positions": { + "description": "Line items included in this delivery", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -24137,6 +25611,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24145,6 +25620,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24210,14 +25686,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -24319,6 +25798,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderDeliveryId": { + "description": "Unique identity of order delivery.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24327,6 +25807,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of line items in an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24392,14 +25873,17 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "quantity": { + "description": "Number of items of each product.", "type": "integer", "format": "int64" }, @@ -24438,9 +25922,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -24452,6 +25936,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24460,6 +25945,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24468,6 +25954,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24480,44 +25967,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -24579,22 +26069,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -24608,6 +26109,7 @@ "relationships": { "properties": { "cover": { + "description": "Line item image or thumbnail", "properties": { "links": { "type": "object", @@ -24666,6 +26168,7 @@ "type": "object" }, "product": { + "description": "Referenced product if this is a product line item", "properties": { "links": { "type": "object", @@ -24724,6 +26227,7 @@ "type": "object" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "properties": { "links": { "type": "object", @@ -24786,6 +26290,7 @@ "type": "object" }, "downloads": { + "description": "Digital downloads associated with this line item", "properties": { "links": { "type": "object", @@ -24892,9 +26397,9 @@ "identifier", "quantity", "label", - "states", "price", - "children" + "children", + "states" ], "properties": { "id": { @@ -24906,6 +26411,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24914,6 +26420,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24922,6 +26429,7 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -24934,44 +26442,47 @@ "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of cover image.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "It is a unique identity of an item in cart before its converted to an order.", "type": "string" }, "referencedId": { + "description": "Unique identity of type of entity.", "type": "string" }, "quantity": { + "description": "Number of items of product.", "type": "integer", "format": "int64" }, "label": { + "description": "It is a typical product name given to the line item.", "type": "string" }, "payload": { "type": "object" }, "good": { + "description": "When set to true, it indicates the line item is physical else it is virtual.", "type": "boolean" }, "removable": { + "description": "Allows the line item to be removable from the cart when set to true.", "type": "boolean" }, "stackable": { + "description": "Allows to change the quantity of the line item when set to true.", "type": "boolean" }, "position": { + "description": "Position of line items placed in an order.", "type": "integer", "format": "int64" }, - "states": { - "type": "array", - "items": { - "type": "string" - } - }, "price": { "required": [ "unitPrice", @@ -25033,22 +26544,33 @@ "type": "object" }, "unitPrice": { + "description": "Price of product per item (where, quantity=1).", "type": "number", "format": "float" }, "totalPrice": { + "description": "Cost of product based on quantity.", "type": "number", "format": "float" }, "description": { + "description": "Description of line items in an order.", "type": "string" }, "type": { + "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", "type": "string" }, "customFields": { "type": "object" }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -25060,18 +26582,21 @@ "readOnly": true }, "cover": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Line item image or thumbnail" }, "order": { "$ref": "#/components/schemas/Order" }, "product": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Referenced product if this is a product line item" }, "promotion": { "$ref": "#/components/schemas/Promotion" }, "orderDeliveryPositions": { + "description": "Delivery positions for this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderDeliveryPosition" @@ -25084,6 +26609,7 @@ } }, "downloads": { + "description": "Digital downloads associated with this line item", "type": "array", "items": { "$ref": "#/components/schemas/OrderLineItemDownload" @@ -25125,6 +26651,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25133,14 +26660,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -25243,6 +26773,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of Order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25251,14 +26782,17 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of downloaded digital products displayed in the storefront by mentioning numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "accessGranted": { + "description": "When boolean value is `true`, the digital product is allowed to download.", "type": "boolean" }, "customFields": { @@ -25339,6 +26873,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25347,6 +26882,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25411,6 +26947,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25430,6 +26967,7 @@ "relationships": { "properties": { "stateMachineState": { + "description": "Current payment transaction state (e.g., open, paid, cancelled)", "properties": { "links": { "type": "object", @@ -25488,6 +27026,7 @@ "type": "object" }, "paymentMethod": { + "description": "Payment method used for this transaction", "properties": { "links": { "type": "object", @@ -25517,6 +27056,7 @@ "type": "object" }, "captures": { + "description": "Payment captures for this transaction", "properties": { "links": { "type": "object", @@ -25546,6 +27086,35 @@ } }, "type": "object" + }, + "primaryOrder": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/order-transaction/117c998b69fea8e51bd46a905f8cdbeb/primaryOrder" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "order" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "f3654baea1bb37cbbd3b86e9793c3766" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -25574,6 +27143,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderId": { + "description": "Unique identity of an order.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25582,6 +27152,7 @@ "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25646,6 +27217,7 @@ "type": "object" }, "stateId": { + "description": "Unique identity of state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25663,19 +27235,25 @@ "readOnly": true }, "stateMachineState": { - "$ref": "#/components/schemas/StateMachineState" + "$ref": "#/components/schemas/StateMachineState", + "description": "Current payment transaction state (e.g., open, paid, cancelled)" }, "order": { "$ref": "#/components/schemas/Order" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Payment method used for this transaction" }, "captures": { + "description": "Payment captures for this transaction", "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionCapture" } + }, + "primaryOrder": { + "$ref": "#/components/schemas/Order" } }, "type": "object" @@ -25703,6 +27281,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25711,10 +27290,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -25904,6 +27485,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderTransactionId": { + "description": "Unique identity of order transaction.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -25912,10 +27494,12 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "amount": { @@ -26026,6 +27610,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26034,13 +27619,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -26230,6 +27818,7 @@ "pattern": "^[0-9a-f]{32}$" }, "captureId": { + "description": "Unique identity of order transaction capture.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26238,13 +27827,16 @@ "pattern": "^[0-9a-f]{32}$" }, "stateId": { + "description": "Unique identity of order state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "amount": { @@ -26355,6 +27947,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26363,6 +27956,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26371,12 +27965,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -26536,6 +28133,7 @@ "pattern": "^[0-9a-f]{32}$" }, "refundId": { + "description": "Unique identity of order transaction capture refund.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26544,6 +28142,7 @@ "pattern": "^[0-9a-f]{32}$" }, "orderLineItemId": { + "description": "Unique identity of order line item.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26552,12 +28151,15 @@ "pattern": "^[0-9a-f]{32}$" }, "externalReference": { + "description": "External payment provider token.", "type": "string" }, "reason": { + "description": "Reason for refunding the amount for an order.", "type": "string" }, "quantity": { + "description": "Quantity of line item to be refunded.", "type": "integer", "format": "int64" }, @@ -26649,6 +28251,7 @@ { "required": [ "id", + "technicalName", "name" ], "properties": { @@ -26657,10 +28260,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -26674,23 +28279,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -26699,38 +28309,13 @@ "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 + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -26747,6 +28332,7 @@ "relationships": { "properties": { "media": { + "description": "Payment method logo or icon image", "properties": { "links": { "type": "object", @@ -26998,6 +28584,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "name" ], "properties": { @@ -27006,10 +28593,12 @@ "pattern": "^[0-9a-f]{32}$" }, "pluginId": { + "description": "Unique identity of plugin.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "handlerIdentifier": { + "description": "Internal field that contains system identifier details for payment methods like Paypal.", "type": "string" }, "name": { @@ -27023,23 +28612,28 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined payment methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "active": { + "description": "When boolean value is `true`, the payment methods are available for selection in the storefront.", "type": "boolean" }, "afterOrderEnabled": { + "description": "When set to true, customers are redirected to the payment options page to choose a new payment method on order failure.", "type": "boolean" }, "customFields": { "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27048,38 +28642,13 @@ "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 + "technicalName": { + "type": "string" }, "shortName": { "description": "Runtime field, cannot be used as part of the criteria.", "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -27094,7 +28663,8 @@ "type": "object" }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Payment method logo or icon image" }, "availabilityRule": { "$ref": "#/components/schemas/Rule" @@ -27153,46 +28723,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -27286,46 +28869,59 @@ "pattern": "^[0-9a-f]{32}$" }, "baseClass": { + "description": "Name of the new class that extends from Shopware's abstract Plugin class.", "type": "string" }, "name": { + "description": "Unique name of the plugin.", "type": "string" }, "composerName": { + "description": "Name of the composer package name.", "type": "string" }, "autoload": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the plugin is available.", "type": "boolean" }, "managedByComposer": { + "description": "A property to check whether it is installed via composer or not.", "type": "boolean" }, "path": { + "description": "A relative URL to the plugin.", "type": "string" }, "author": { + "description": "Creator of the plugin.", "type": "string" }, "copyright": { + "description": "Legal rights on the created plugin.", "type": "string" }, "license": { + "description": "Software license's like MIT, etc.", "type": "string" }, "version": { + "description": "Version of the plugin.", "type": "string" }, "upgradeVersion": { + "description": "Update version available for upgrading plugins.", "type": "string" }, "installedAt": { + "description": "Date and time when the plugin was installed.", "type": "string", "format": "date-time" }, "upgradedAt": { + "description": "Date and time when the plugin was upgraded.", "type": "string", "format": "date-time" }, @@ -27404,6 +29000,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27412,14 +29009,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27428,14 +29028,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27444,6 +29047,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -27458,9 +29062,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -27470,21 +29076,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "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", "format": "int64" }, @@ -27495,6 +29106,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -27505,32 +29117,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -27540,29 +29160,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -27621,20 +29248,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -27669,6 +29291,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -27719,6 +29353,7 @@ "relationships": { "properties": { "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "properties": { "links": { "type": "object", @@ -27750,6 +29385,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of the product.", "properties": { "links": { "type": "object", @@ -27779,6 +29415,7 @@ "type": "object" }, "children": { + "description": "Product variants that inherit from this parent product", "properties": { "links": { "type": "object", @@ -27810,6 +29447,7 @@ "type": "object" }, "deliveryTime": { + "description": "Estimated delivery time for the product", "properties": { "links": { "type": "object", @@ -27839,6 +29477,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration (rate and calculation rules)", "properties": { "links": { "type": "object", @@ -27868,6 +29507,7 @@ "type": "object" }, "manufacturer": { + "description": "Product manufacturer or brand information", "properties": { "links": { "type": "object", @@ -27897,6 +29537,7 @@ "type": "object" }, "unit": { + "description": "Product unit of measure (e.g., piece, liter, kg)", "properties": { "links": { "type": "object", @@ -27926,6 +29567,7 @@ "type": "object" }, "cover": { + "description": "Main product image displayed in listings and detail pages", "properties": { "links": { "type": "object", @@ -27984,6 +29626,7 @@ "type": "object" }, "cmsPage": { + "description": "Custom CMS page layout for the product detail page", "properties": { "links": { "type": "object", @@ -28013,6 +29656,7 @@ "type": "object" }, "canonicalProduct": { + "description": "Canonical product reference for variant consolidation and SEO purposes", "properties": { "links": { "type": "object", @@ -28073,6 +29717,7 @@ "type": "object" }, "media": { + "description": "Product images and media gallery", "properties": { "links": { "type": "object", @@ -28104,6 +29749,7 @@ "type": "object" }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "properties": { "links": { "type": "object", @@ -28166,6 +29812,7 @@ "type": "object" }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "properties": { "links": { "type": "object", @@ -28259,6 +29906,7 @@ "type": "object" }, "productReviews": { + "description": "Customer reviews and ratings for the product", "properties": { "links": { "type": "object", @@ -28290,6 +29938,7 @@ "type": "object" }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "properties": { "links": { "type": "object", @@ -28321,6 +29970,7 @@ "type": "object" }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "properties": { "links": { "type": "object", @@ -28414,6 +30064,7 @@ "type": "object" }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "properties": { "links": { "type": "object", @@ -28445,6 +30096,7 @@ "type": "object" }, "properties": { + "description": "Product properties and characteristics for filtering", "properties": { "links": { "type": "object", @@ -28476,6 +30128,7 @@ "type": "object" }, "categories": { + "description": "Categories this product is assigned to", "properties": { "links": { "type": "object", @@ -28507,6 +30160,7 @@ "type": "object" }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "properties": { "links": { "type": "object", @@ -28538,6 +30192,7 @@ "type": "object" }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "properties": { "links": { "type": "object", @@ -28569,6 +30224,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing and filtering products", "properties": { "links": { "type": "object", @@ -28666,6 +30322,7 @@ "pattern": "^[0-9a-f]{32}$" }, "manufacturerId": { + "description": "Unique identity of the manufacturer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28674,14 +30331,17 @@ "pattern": "^[0-9a-f]{32}$" }, "unitId": { + "description": "Unique identity of the unit.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "coverId": { + "description": "Unique identity of a ProductMedia item used as product cover.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28690,14 +30350,17 @@ "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of delivery time.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "featureSetId": { + "description": "Unique identity of feature set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "canonicalProductId": { + "description": "Unique identity of canonical product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28706,6 +30369,7 @@ "pattern": "^[0-9a-f]{32}$" }, "cmsPageId": { + "description": "Unique identity of CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -28720,9 +30384,11 @@ } }, "productNumber": { + "description": "Unique number assigned to individual products. Define rules for automatic assignment of every product creation as per your number range.", "type": "string" }, "restockTime": { + "description": "The restock time in days indicates how long it will take until a sold out item is back in stock.", "type": "integer", "format": "int64" }, @@ -28732,21 +30398,26 @@ "readOnly": true }, "active": { + "description": "When boolean value is `true`, the products are available for selection in the storefront for purchase.", "type": "boolean" }, "available": { + "description": "Indicates weather the product is available or not.", "type": "boolean", "readOnly": true }, "isCloseout": { + "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", "format": "int64" }, @@ -28757,6 +30428,7 @@ } }, "displayGroup": { + "description": "Runtime field, cannot be used as part of the criteria.", "type": "string", "readOnly": true }, @@ -28767,32 +30439,40 @@ "type": "object" }, "manufacturerNumber": { + "description": "Unique number that describes the manufacturer.", "type": "string" }, "ean": { + "description": "Indicates EAN of the product.", "type": "string" }, "purchaseSteps": { + "description": "Specifies the scales in which the item is to be offered. For example, a scale of 2 means that your customers can purchase 2, 4, 6 products, etc., but not 1, 3 or 5.", "type": "integer", "format": "int64" }, "maxPurchase": { + "description": "Maximum number of items that can be purchased.", "type": "integer", "format": "int64" }, "minPurchase": { + "description": "Minimum number of items that can be purchased.", "type": "integer", "format": "int64" }, "purchaseUnit": { + "description": "Quantity of the item purchased. For example, 500ml, 2kg, etc.", "type": "number", "format": "float" }, "referenceUnit": { + "description": "Price of purchased item calculated as per the reference unit. Say, you bought 500ml of milk and the price is calculated in reference to 1000ml.", "type": "number", "format": "float" }, "shippingFree": { + "description": "Indicates weather the shipping price is free or not.", "type": "boolean" }, "purchasePrices": { @@ -28802,29 +30482,36 @@ } }, "markAsTopseller": { + "description": "Indicates weather the product is top seller or not.", "type": "boolean" }, "weight": { + "description": "The weight of the product.", "type": "number", "format": "float" }, "width": { + "description": "The width of the product.", "type": "number", "format": "float" }, "height": { + "description": "The height of the product.", "type": "number", "format": "float" }, "length": { + "description": "The length of the product.", "type": "number", "format": "float" }, "releaseDate": { + "description": "The release date of a product or product model. This can be used to distinguish the exact variant of a product.", "type": "string", "format": "date-time" }, "ratingAverage": { + "description": "Average of all the ratings.", "type": "number", "format": "float", "readOnly": true @@ -28883,20 +30570,15 @@ "readOnly": true }, "customFieldSetSelectionActive": { + "description": "When boolean value is `true`, the customFieldSetSelection for products gets enabled.", "type": "boolean" }, "sales": { + "description": "Frequency of the product sales.", "type": "integer", "format": "int64", "readOnly": true }, - "states": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true - }, "metaDescription": { "type": "string" }, @@ -28931,6 +30613,18 @@ "additionalProperties": false } }, + "type": { + "description": "The type of the product, e.g., physical or digital.", + "type": "string" + }, + "states": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -28979,43 +30673,53 @@ "type": "object" }, "downloads": { + "description": "Downloadable files associated with the product (e.g., manuals, digital content)", "type": "array", "items": { "$ref": "#/components/schemas/ProductDownload" } }, "parent": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Unique identity of the product." }, "children": { + "description": "Product variants that inherit from this parent product", "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time for the product" }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration (rate and calculation rules)" }, "manufacturer": { - "$ref": "#/components/schemas/ProductManufacturer" + "$ref": "#/components/schemas/ProductManufacturer", + "description": "Product manufacturer or brand information" }, "unit": { - "$ref": "#/components/schemas/Unit" + "$ref": "#/components/schemas/Unit", + "description": "Product unit of measure (e.g., piece, liter, kg)" }, "cover": { - "$ref": "#/components/schemas/ProductMedia" + "$ref": "#/components/schemas/ProductMedia", + "description": "Main product image displayed in listings and detail pages" }, "featureSet": { "$ref": "#/components/schemas/ProductFeatureSet" }, "cmsPage": { - "$ref": "#/components/schemas/CmsPage" + "$ref": "#/components/schemas/CmsPage", + "description": "Custom CMS page layout for the product detail page" }, "canonicalProduct": { - "$ref": "#/components/schemas/Product" + "$ref": "#/components/schemas/Product", + "description": "Canonical product reference for variant consolidation and SEO purposes" }, "prices": { "type": "array", @@ -29024,12 +30728,14 @@ } }, "media": { + "description": "Product images and media gallery", "type": "array", "items": { "$ref": "#/components/schemas/ProductMedia" } }, "crossSellings": { + "description": "Cross-selling configurations (related products, accessories, similar items)", "type": "array", "items": { "$ref": "#/components/schemas/ProductCrossSelling" @@ -29042,6 +30748,7 @@ } }, "configuratorSettings": { + "description": "Variant configurator settings defining available options for product variants", "type": "array", "items": { "$ref": "#/components/schemas/ProductConfiguratorSetting" @@ -29060,18 +30767,21 @@ } }, "productReviews": { + "description": "Customer reviews and ratings for the product", "type": "array", "items": { "$ref": "#/components/schemas/ProductReview" } }, "mainCategories": { + "description": "Primary category assignments per sales channel for SEO and navigation", "type": "array", "items": { "$ref": "#/components/schemas/MainCategory" } }, "seoUrls": { + "description": "SEO-friendly URLs for the product across different sales channels", "type": "array", "items": { "$ref": "#/components/schemas/SeoUrl" @@ -29090,36 +30800,42 @@ } }, "options": { + "description": "Product variant options (e.g., size, color) that define different variants", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "properties": { + "description": "Product properties and characteristics for filtering", "type": "array", "items": { "$ref": "#/components/schemas/PropertyGroupOption" } }, "categories": { + "description": "Categories this product is assigned to", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "streams": { + "description": "Dynamic product streams this product belongs to based on defined filters", "type": "array", "items": { "$ref": "#/components/schemas/ProductStream" } }, "categoriesRo": { + "description": "Read-only category tree including all parent categories for optimized queries", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "tags": { + "description": "Tags for organizing and filtering products", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -29228,6 +30944,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29236,10 +30953,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29247,6 +30966,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -29377,6 +31097,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29385,10 +31106,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "optionId": { + "description": "Unique identity of option.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29396,6 +31119,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined product configuration settings in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -29445,26 +31169,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29473,6 +31204,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29604,26 +31336,33 @@ "type": "string" }, "position": { + "description": "The order of the tabs of your defined cross-selling actions in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, "sortBy": { + "description": "To sort the display of products by name, price or publication (descending, ascending) date.", "type": "string" }, "sortDirection": { + "description": "To sort the display of products by ascending or descending order.", "type": "string" }, "type": { + "description": "Type of product assignment for cross-selling. It can either be Dynamic product group or Manual assignment.", "type": "string" }, "active": { + "description": "When set to active, the cross-selling feature is enabled.", "type": "boolean" }, "limit": { + "description": "The maximum number of products to be displayed in cross-selling on the item detail page of your item.", "type": "integer", "format": "int64" }, "productId": { + "description": "Unique identity of product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29632,6 +31371,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29681,10 +31421,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29693,6 +31435,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -29787,10 +31530,12 @@ "pattern": "^[0-9a-f]{32}$" }, "crossSellingId": { + "description": "Unique identity of Product CrossSelling.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29799,6 +31544,7 @@ "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the tabs of your defined product cross-selling in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -29875,6 +31621,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29883,10 +31630,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -29988,6 +31737,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -29996,10 +31746,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order in which the digital products are downloaded, like 1,2,3, etc.to adjust their order of display.", "type": "integer", "format": "int64" }, @@ -30052,64 +31804,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -30299,64 +32069,82 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream .", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "storefrontSalesChannelId": { + "description": "Unique identity of storefront's Sales Channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of salesChannel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelDomainId": { + "description": "Unique identity of sales Channel Domain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fileName": { + "description": "Name of the file.", "type": "string" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "encoding": { + "description": "Type of encoding like UTF-8 or ASCII.", "type": "string" }, "fileFormat": { + "description": "Type of file formats or extensions like CSV or JSON.", "type": "string" }, "includeVariants": { + "description": "Toggling the product export settings to determine whether or not to include the variants.", "type": "boolean" }, "generateByCronjob": { + "description": "To determine whether the product exports are generated by cron jobs or live.", "type": "boolean" }, "generatedAt": { + "description": "Date and time when the product exports was last generated.", "type": "string", "format": "date-time" }, "interval": { + "description": "The frequency interval when the product exports are generated like every 5 min, 1 hour, etc.", "type": "integer", "format": "int64" }, "headerTemplate": { + "description": "Property to specify the custom content displayed for the header section.", "type": "string" }, "bodyTemplate": { + "description": "Property to specify the custom content displayed for the body section.", "type": "string" }, "footerTemplate": { + "description": "Property to specify the custom content displayed for the footer section.", "type": "string" }, "pausedSchedule": { + "description": "ProductExport generation is paused.", "type": "boolean" }, "isRunning": { + "description": "ProductExport is right now generating or not.", "type": "boolean" }, "createdAt": { @@ -30526,13 +32314,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "relationships": { @@ -30587,13 +32378,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "reversed": { + "description": "The keywords are revered for the search.", "type": "string" }, "language": { @@ -30623,6 +32417,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30737,6 +32532,7 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30799,6 +32595,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30807,10 +32604,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -30943,6 +32742,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -30951,10 +32751,12 @@ "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of the media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "position": { + "description": "The order of the images to be displayed for a product.", "type": "integer", "format": "int64" }, @@ -31042,6 +32844,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31050,6 +32853,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31060,10 +32864,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -31167,6 +32973,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31175,6 +32982,7 @@ "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of the rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31185,10 +32993,12 @@ } }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "integer", "format": "int64" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "integer", "format": "int64" }, @@ -31267,6 +33077,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31275,37 +33086,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -31463,6 +33284,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31471,37 +33293,47 @@ "pattern": "^[0-9a-f]{32}$" }, "customerId": { + "description": "Unique identity of the customer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of the language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "externalUser": { + "description": "External user name.", "type": "string" }, "externalEmail": { + "description": "External user email address.", "type": "string" }, "title": { + "description": "Title of product review.", "type": "string" }, "content": { + "description": "Short description or subject of the project review.", "type": "string" }, "points": { + "description": "A floating point number given to rate a product.", "type": "number", "format": "float" }, "status": { + "description": "When status is set, the rating is made visible.", "type": "boolean" }, "comment": { + "description": "Detailed review about the product.", "type": "string" }, "customFields": { @@ -31549,13 +33381,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -31657,13 +33492,16 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "andLogic": { + "description": "Product search configuration with add logic.", "type": "boolean" }, "minSearchLength": { + "description": "Minimum number of characters used for product search.", "type": "integer", "format": "int64" }, @@ -31713,23 +33551,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -31824,23 +33668,29 @@ "pattern": "^[0-9a-f]{32}$" }, "searchConfigId": { + "description": "Unique identity of Search Configuration.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customFieldId": { + "description": "Unique identity of custom field.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "field": { + "description": "Configuration of search field.", "type": "string" }, "tokenize": { + "description": "To decide whether the text within the field should undergo tokenization, which involves splitting it into smaller chunks.", "type": "boolean" }, "searchable": { + "description": "To configure whether the field can be used for searching.", "type": "boolean" }, "ranking": { + "description": "Search ranking.", "type": "integer", "format": "int64" }, @@ -31887,10 +33737,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -31899,9 +33751,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -32002,10 +33856,12 @@ "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of Product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32014,9 +33870,11 @@ "pattern": "^[0-9a-f]{32}$" }, "keyword": { + "description": "The keywords that help to search the product.", "type": "string" }, "ranking": { + "description": "Search ranking.", "type": "number", "format": "float" }, @@ -32167,6 +34025,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -32179,6 +34038,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -32342,6 +34205,7 @@ "readOnly": true }, "invalid": { + "description": "When the boolean value is `true`, the ProductStream is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -32354,6 +34218,10 @@ "customFields": { "type": "object" }, + "internal": { + "description": "When the boolean value is `true` indicating that it is for internal use only and will not appear in product stream listings.", + "type": "boolean" + }, "createdAt": { "type": "string", "format": "date-time", @@ -32412,6 +34280,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32420,21 +34289,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -32483,6 +34357,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of product stream filter.", "properties": { "links": { "type": "object", @@ -32563,6 +34438,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productStreamId": { + "description": "Unique identity of product stream.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32571,21 +34447,26 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Type is either `static` or `stream`.", "type": "string" }, "field": { + "description": "Filter by field.", "type": "string" }, "operator": { + "description": "Filter by operator like >, ==, < , >=, etc.", "type": "string" }, "value": { + "description": "Filter by ProductStreamFilter value.", "type": "string" }, "parameters": { "type": "object" }, "position": { + "description": "The order of the tabs of your defined product stream filter to be displayed.", "type": "integer", "format": "int64" }, @@ -32606,7 +34487,8 @@ "$ref": "#/components/schemas/ProductStream" }, "parent": { - "$ref": "#/components/schemas/ProductStreamFilter" + "$ref": "#/components/schemas/ProductStreamFilter", + "description": "Unique identity of product stream filter." }, "queries": { "type": "array", @@ -32700,6 +34582,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32708,10 +34591,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -32807,6 +34692,7 @@ "pattern": "^[0-9a-f]{32}$" }, "productId": { + "description": "Unique identity of the product.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -32815,10 +34701,12 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of the sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "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" }, @@ -32861,53 +34749,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -33243,53 +35146,68 @@ "type": "string" }, "active": { + "description": "When boolean value is `true`, the promotions are available for selection in the storefront for purchase.", "type": "boolean" }, "validFrom": { + "description": "Date and time from when the promotion code gets valid.", "type": "string", "format": "date-time" }, "validUntil": { + "description": "Date and time until when the promotion code is valid.", "type": "string", "format": "date-time" }, "maxRedemptionsGlobal": { + "description": "The frequency at which the voucher can be redeemed worldwide.", "type": "integer", "format": "int64" }, "maxRedemptionsPerCustomer": { + "description": "The frequency at which the voucher can be redeemed worldwide per customer.", "type": "integer", "format": "int64" }, "priority": { + "description": "A numerical value to prioritize one of the promotions from the list.", "type": "integer", "format": "int64" }, "exclusive": { + "description": "Parameter to exclude the promotion codes on certain products", "type": "boolean" }, "code": { + "description": "Promotion code.", "type": "string" }, "useCodes": { + "description": "A boolean value that indicates whether the promotion uses code or not.", "type": "boolean" }, "useIndividualCodes": { + "description": "Indicates either an individual code or generic code for all users.", "type": "boolean" }, "individualCodePattern": { + "description": "Promotion code pattern.", "type": "string" }, "useSetGroups": { + "description": "Combine promotions. Promotions that are to be used only on certain products and rest not considered.", "type": "boolean" }, "customerRestriction": { + "description": "Indicates who cannot a use the code.", "type": "boolean" }, "preventCombination": { + "description": "Indicates which combination of codes are allowed.", "type": "boolean" }, "orderCount": { + "description": "The number of times the promotion was used.", "type": "integer", "format": "int64", "readOnly": true @@ -33426,36 +35344,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -33584,36 +35512,46 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scope": { + "description": "Cart or shipping cost.", "type": "string" }, "type": { + "description": "Discount is either `absolute` or `percentage`.", "type": "string" }, "value": { + "description": "To filter by PromotionDiscount value.", "type": "number", "format": "float" }, "considerAdvancedRules": { + "description": "When boolean value is `true`, the promotion discount is applied along with advanced rules.", "type": "boolean" }, "maxValue": { + "description": "Discount in terms of absolute value.", "type": "number", "format": "float" }, "sorterKey": { + "description": "Price from `low to high` or `high to low` to sort the product accordingly.", "type": "string" }, "applierKey": { + "description": "Internal field.", "type": "string" }, "usageKey": { + "description": "Internal field.", "type": "string" }, "pickerKey": { + "description": "Internal field.", "type": "string" }, "createdAt": { @@ -33663,14 +35601,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -33766,14 +35707,17 @@ "pattern": "^[0-9a-f]{32}$" }, "discountId": { + "description": "Unique identity of discount.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "price": { + "description": "Price of the discount.", "type": "number", "format": "float" }, @@ -33842,10 +35786,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -33913,10 +35859,12 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "code": { + "description": "Promotion code.", "type": "string" }, "payload": { @@ -34041,14 +35989,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -34144,14 +36095,17 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "priority": { + "description": "A numerical value to prioritize one of the promotion saleschannels from the list.", "type": "integer", "format": "int64" }, @@ -34194,16 +36148,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -34302,16 +36260,20 @@ "pattern": "^[0-9a-f]{32}$" }, "promotionId": { + "description": "Unique identity of promotion.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "packagerKey": { + "description": "Internal field.", "type": "string" }, "sorterKey": { + "description": "Internal field.", "type": "string" }, "value": { + "description": "To filter by PromotionSetgroup value.", "type": "number", "format": "float" }, @@ -34388,15 +36350,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -34478,15 +36444,19 @@ "type": "string" }, "displayType": { + "description": "Property groups can be displayed in the form of text, image, dropdown or color.", "type": "string" }, "sortingType": { + "description": "Sorting the property group by name or position.", "type": "string" }, "filterable": { + "description": "When set to true, the property will be displayed in the product filter of product lists.", "type": "boolean" }, "visibleOnProductDetailPage": { + "description": "When set to true, the property groups are displayed on product detail page.", "type": "boolean" }, "position": { @@ -34536,6 +36506,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34547,12 +36518,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -34743,6 +36720,7 @@ "pattern": "^[0-9a-f]{32}$" }, "groupId": { + "description": "Unique identity of property group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -34754,12 +36732,18 @@ "format": "int64" }, "colorHexCode": { + "description": "Property group options can be displayed in the form of color. For example: #98e3f5ff.", "type": "string" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "combinable": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean" + }, "customFields": { "type": "object" }, @@ -34821,16 +36805,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -35382,16 +37370,20 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the rule defined.", "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the rules from the list.", "type": "integer", "format": "int64" }, "description": { + "description": "Description of the rule.", "type": "string" }, "invalid": { + "description": "When the boolean value is `true`, the rule is no more available for usage.", "type": "boolean", "readOnly": true }, @@ -35591,13 +37583,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35609,6 +37604,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -35686,6 +37682,7 @@ "type": "object" }, "parent": { + "description": "Unique identity of rule condition.", "properties": { "links": { "type": "object", @@ -35766,13 +37763,16 @@ "pattern": "^[0-9a-f]{32}$" }, "type": { + "description": "Different rule types.", "type": "string" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "scriptId": { + "description": "Unique identity of script.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35784,6 +37784,7 @@ "type": "object" }, "position": { + "description": "The order of the tabs of your defined rule setting configurations in the Administration by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -35807,7 +37808,8 @@ "$ref": "#/components/schemas/AppScriptCondition" }, "parent": { - "$ref": "#/components/schemas/RuleCondition" + "$ref": "#/components/schemas/RuleCondition", + "description": "Unique identity of rule condition." }, "children": { "type": "array", @@ -35873,38 +37875,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35913,10 +37924,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35925,6 +37938,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -35933,35 +37947,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -35983,6 +38008,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -36244,6 +38270,7 @@ "type": "object" }, "language": { + "description": "Default language for the sales channel", "properties": { "links": { "type": "object", @@ -36302,6 +38329,7 @@ "type": "object" }, "currency": { + "description": "Default currency for the sales channel", "properties": { "links": { "type": "object", @@ -36331,6 +38359,7 @@ "type": "object" }, "paymentMethod": { + "description": "Default payment method for the sales channel", "properties": { "links": { "type": "object", @@ -36360,6 +38389,7 @@ "type": "object" }, "shippingMethod": { + "description": "Default shipping method for the sales channel", "properties": { "links": { "type": "object", @@ -36389,6 +38419,7 @@ "type": "object" }, "country": { + "description": "Default country for the sales channel", "properties": { "links": { "type": "object", @@ -36509,6 +38540,7 @@ "type": "object" }, "domains": { + "description": "Domain URLs configured for the sales channel", "properties": { "links": { "type": "object", @@ -36571,6 +38603,7 @@ "type": "object" }, "navigationCategory": { + "description": "Root category for navigation menu", "properties": { "links": { "type": "object", @@ -36600,6 +38633,7 @@ "type": "object" }, "footerCategory": { + "description": "Root category for footer navigation", "properties": { "links": { "type": "object", @@ -36629,6 +38663,7 @@ "type": "object" }, "serviceCategory": { + "description": "Root category for service pages", "properties": { "links": { "type": "object", @@ -37208,38 +39243,47 @@ "pattern": "^[0-9a-f]{32}$" }, "typeId": { + "description": "Unique identity of type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "customerGroupId": { + "description": "Unique identity of customer group.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "paymentMethodId": { + "description": "Unique identity of payment method used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "analyticsId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryId": { + "description": "Unique identity of navigation category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37248,10 +39292,12 @@ "pattern": "^[0-9a-f]{32}$" }, "navigationCategoryDepth": { + "description": "It determines the number of levels of subcategories in the storefront category menu.", "type": "integer", "format": "int64" }, "footerCategoryId": { + "description": "Unique identity of footer category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37260,6 +39306,7 @@ "pattern": "^[0-9a-f]{32}$" }, "serviceCategoryId": { + "description": "Unique identity of service category.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37268,35 +39315,46 @@ "pattern": "^[0-9a-f]{32}$" }, "mailHeaderFooterId": { + "description": "Unique identity of mail header and footer.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "hreflangDefaultDomainId": { + "description": "Unique identity of hreflangDefaultDomain.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "name": { "type": "string" }, "shortName": { + "description": "A short name for sales channel.", "type": "string" }, "taxCalculationType": { + "description": "Tax calculation types are `horizontal` and `vertical`.", "type": "string" }, "accessKey": { + "description": "Access key to store api.", "type": "string" }, "configuration": { "type": "object" }, "active": { + "description": "When boolean value is `true`, the sales channel is enabled.", "type": "boolean" }, "hreflangActive": { + "description": "When set to true, the sales channel pages are available in different languages.", "type": "boolean" }, "maintenance": { + "description": "When `true`, it indicates that the sales channel is undergoing maintenance, and shopping is temporarily unavailable during this period.", "type": "boolean" }, "maintenanceIpWhitelist": { @@ -37318,6 +39376,7 @@ "readOnly": true }, "homeCmsPageId": { + "description": "Unique identity of home CMS page.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -37426,22 +39485,27 @@ "$ref": "#/components/schemas/SalesChannelType" }, "language": { - "$ref": "#/components/schemas/Language" + "$ref": "#/components/schemas/Language", + "description": "Default language for the sales channel" }, "customerGroup": { "$ref": "#/components/schemas/CustomerGroup" }, "currency": { - "$ref": "#/components/schemas/Currency" + "$ref": "#/components/schemas/Currency", + "description": "Default currency for the sales channel" }, "paymentMethod": { - "$ref": "#/components/schemas/PaymentMethod" + "$ref": "#/components/schemas/PaymentMethod", + "description": "Default payment method for the sales channel" }, "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" + "$ref": "#/components/schemas/ShippingMethod", + "description": "Default shipping method for the sales channel" }, "country": { - "$ref": "#/components/schemas/Country" + "$ref": "#/components/schemas/Country", + "description": "Default country for the sales channel" }, "orders": { "type": "array", @@ -37459,6 +39523,7 @@ "$ref": "#/components/schemas/CmsPage" }, "domains": { + "description": "Domain URLs configured for the sales channel", "type": "array", "items": { "$ref": "#/components/schemas/SalesChannelDomain" @@ -37471,13 +39536,16 @@ } }, "navigationCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for navigation menu" }, "footerCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for footer navigation" }, "serviceCategory": { - "$ref": "#/components/schemas/Category" + "$ref": "#/components/schemas/Category", + "description": "Root category for service pages" }, "productVisibilities": { "type": "array", @@ -37591,15 +39659,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Unique identity for tracking.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the sales channel analytics are enabled.", "type": "boolean" }, "trackOrders": { + "description": "When boolean value is `true`, it enables Google Analytics to track orders.", "type": "boolean" }, "anonymizeIp": { + "description": "Unique identity of anonymize.", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "When boolean value is `true`, it enables Google Analytics to track offcanvas cart.", "type": "boolean" }, "createdAt": { @@ -37652,9 +39728,14 @@ ] }, "SalesChannelAnalytics": { - "description": "Added since version: 6.2.0.0", + "description": "Sales channel analytics configuration", "required": [ - "id" + "id", + "active", + "trackOrders", + "anonymizeIp", + "trackOffcanvasCart", + "createdAt" ], "properties": { "id": { @@ -37662,15 +39743,23 @@ "pattern": "^[0-9a-f]{32}$" }, "trackingId": { + "description": "Google Analytics tracking ID (e.g., UA-XXXXX-Y or G-XXXXXXXX)", "type": "string" }, "active": { + "description": "Whether Google Analytics tracking is enabled", "type": "boolean" }, "trackOrders": { + "description": "Track order completions in Google Analytics", "type": "boolean" }, "anonymizeIp": { + "description": "Anonymize visitor IP addresses for GDPR compliance", + "type": "boolean" + }, + "trackOffcanvasCart": { + "description": "Track off-canvas cart interactions in Google Analytics", "type": "boolean" }, "createdAt": { @@ -37679,7 +39768,10 @@ "readOnly": true }, "updatedAt": { - "type": "string", + "type": [ + "string", + "null" + ], "format": "date-time", "readOnly": true }, @@ -37766,25 +39858,34 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -38002,25 +40103,34 @@ "pattern": "^[0-9a-f]{32}$" }, "url": { + "description": "URL of the sales channel domain.", "type": "string" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language used.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "currencyId": { + "description": "Unique identity of currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "snippetSetId": { + "description": "Unique identity of snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "measurementUnits": { + "$ref": "#/components/schemas/MeasurementUnits" + }, "hreflangUseOnlyLocale": { + "description": "This is used to toggle the language configurations, say between DE and DE-DE for instance.", "type": "boolean" }, "customFields": { @@ -38161,9 +40271,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -38253,9 +40365,11 @@ "pattern": "^[0-9a-f]{32}$" }, "coverUrl": { + "description": "A url for the sales channel type.", "type": "string" }, "iconName": { + "description": "An icon for sales channel type.", "type": "string" }, "screenshotUrls": { @@ -38320,6 +40434,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -38523,6 +40638,7 @@ "pattern": "^[0-9a-f]{32}$" }, "salutationKey": { + "description": "Technical name given to salutation. For example: mr", "type": "string" }, "displayName": { @@ -38601,27 +40717,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -38656,27 +40779,34 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of the scheduled task.", "type": "string" }, "scheduledTaskClass": { + "description": "Unique identity of scheduled task.", "type": "string" }, "runInterval": { + "description": "The frequency interval at which the scheduled task must run like 5 min, 1 hours , etc", "type": "integer", "format": "int64" }, "defaultRunInterval": { + "description": "Default run interval setting.", "type": "integer", "format": "int64" }, "status": { + "description": "When status is set, the ScheduledTask is made visible.", "type": "string" }, "lastExecutionTime": { + "description": "Time when the scheduled task was last executed.", "type": "string", "format": "date-time" }, "nextExecutionTime": { + "description": "Time when the scheduled task will execute next.", "type": "string", "format": "date-time" }, @@ -38713,15 +40843,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -38792,15 +40926,19 @@ "pattern": "^[0-9a-f]{32}$" }, "script": { + "description": "Internal field.", "type": "string" }, "hook": { + "description": "Internal field.", "type": "string" }, "name": { + "description": "Internal field.", "type": "string" }, "active": { + "description": "Internal field.", "type": "boolean" }, "appId": { @@ -38844,33 +40982,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -38978,33 +41125,42 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "languageId": { + "description": "Unique identity of language.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "foreignKey": { + "description": "The key that references to product or category entity ID.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "routeName": { + "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", "type": "string" }, "pathInfo": { + "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", "type": "string" }, "seoPathInfo": { + "description": "Seo path to product. For example: \\\\\"Pepper-white-ground-pearl/SW10098\\\\\"", "type": "string" }, "isCanonical": { + "description": "When set to true, search redirects to the main URL.", "type": "boolean" }, "isModified": { + "description": "When boolean value is `true`, the seo url is changed.", "type": "boolean" }, "isDeleted": { + "description": "When set to true, the URL is deleted and cannot be used any more but it is still available on table and can be restored later.", "type": "boolean" }, "error": { @@ -39055,19 +41211,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -39135,19 +41296,24 @@ "pattern": "^[0-9a-f]{32}$" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "routeName": { + "description": "Name of the route.", "type": "string" }, "template": { + "description": "Template to generate an URL.", "type": "string" }, "isValid": { + "description": "Created SEO URL template can be made usable by setting `isValid` to true.", "type": "boolean" }, "customFields": { @@ -39178,6 +41344,7 @@ { "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -39189,10 +41356,15 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -39200,21 +41372,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39224,9 +41401,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -39243,6 +41417,7 @@ "relationships": { "properties": { "deliveryTime": { + "description": "Estimated delivery time information", "properties": { "links": { "type": "object", @@ -39272,6 +41447,7 @@ "type": "object" }, "availabilityRule": { + "description": "Rule defining when this shipping method is available", "properties": { "links": { "type": "object", @@ -39301,6 +41477,7 @@ "type": "object" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "properties": { "links": { "type": "object", @@ -39332,6 +41509,7 @@ "type": "object" }, "media": { + "description": "Shipping method logo or carrier image", "properties": { "links": { "type": "object", @@ -39361,6 +41539,7 @@ "type": "object" }, "tags": { + "description": "Tags for organizing shipping methods", "properties": { "links": { "type": "object", @@ -39485,6 +41664,7 @@ "type": "object" }, "tax": { + "description": "Tax configuration for shipping costs", "properties": { "links": { "type": "object", @@ -39554,6 +41734,7 @@ "description": "Added since version: 6.0.0.0", "required": [ "id", + "technicalName", "deliveryTimeId", "name" ], @@ -39565,10 +41746,15 @@ "name": { "type": "string" }, + "technicalName": { + "type": "string" + }, "active": { + "description": "When boolean value is `true`, the shipping methods are available for selection in the storefront.", "type": "boolean" }, "position": { + "description": "The order of the tabs of your defined shipping methods in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -39576,21 +41762,26 @@ "type": "object" }, "availabilityRuleId": { + "description": "Unique identity of availability rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "mediaId": { + "description": "Unique identity of media.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "deliveryTimeId": { + "description": "Unique identity of deliveryTime.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxType": { + "description": "Refers `Free`, `Net` or `Gross` type of taxes.", "type": "string" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -39600,9 +41791,6 @@ "trackingUrl": { "type": "string" }, - "technicalName": { - "type": "string" - }, "createdAt": { "type": "string", "format": "date-time", @@ -39617,21 +41805,26 @@ "type": "object" }, "deliveryTime": { - "$ref": "#/components/schemas/DeliveryTime" + "$ref": "#/components/schemas/DeliveryTime", + "description": "Estimated delivery time information" }, "availabilityRule": { - "$ref": "#/components/schemas/Rule" + "$ref": "#/components/schemas/Rule", + "description": "Rule defining when this shipping method is available" }, "prices": { + "description": "Shipping prices based on weight, volume, or cart value", "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodPrice" } }, "media": { - "$ref": "#/components/schemas/Media" + "$ref": "#/components/schemas/Media", + "description": "Shipping method logo or carrier image" }, "tags": { + "description": "Tags for organizing shipping methods", "type": "array", "items": { "$ref": "#/components/schemas/Tag" @@ -39656,7 +41849,8 @@ } }, "tax": { - "$ref": "#/components/schemas/Tax" + "$ref": "#/components/schemas/Tax", + "description": "Tax configuration for shipping costs" }, "appShippingMethod": { "$ref": "#/components/schemas/AppShippingMethod" @@ -39681,26 +41875,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -39832,26 +42032,32 @@ "pattern": "^[0-9a-f]{32}$" }, "shippingMethodId": { + "description": "Unique identity of shipping method.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "ruleId": { + "description": "Unique identity of rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "calculation": { + "description": "Shipping price calculated based on quantity, price, weight or volume of items.", "type": "integer", "format": "int64" }, "calculationRuleId": { + "description": "Unique identity of rule calculation.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "quantityStart": { + "description": "Starting range of quantity of an item.", "type": "number", "format": "float" }, "quantityEnd": { + "description": "Ending range of quantity of an item.", "type": "number", "format": "float" }, @@ -39934,16 +42140,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -40013,16 +42223,20 @@ "pattern": "^[0-9a-f]{32}$" }, "setId": { + "description": "Unique identity od snippet set.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "translationKey": { + "description": "Reference to the snippet in the template.", "type": "string" }, "value": { + "description": "Value of the key.", "type": "string" }, "author": { + "description": "Creator of the Snippet", "type": "string" }, "customFields": { @@ -40063,12 +42277,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -40170,12 +42386,14 @@ "pattern": "^[0-9a-f]{32}$" }, "name": { + "description": "Name of snippet set.", "type": "string" }, "baseFile": { "type": "string" }, "iso": { + "description": "ISO nomenclature used to classify languages.", "type": "string" }, "customFields": { @@ -40224,6 +42442,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -40365,6 +42584,7 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of state machine.", "type": "string" }, "name": { @@ -40433,35 +42653,50 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "integrationId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -40589,6 +42824,35 @@ } }, "type": "object" + }, + "integration": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/state-machine-history/2981354377022484094791c3f19ffec8/integration" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "integration" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "776ea3bf11df5829827f7afb43c37174" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -40615,35 +42879,50 @@ "pattern": "^[0-9a-f]{32}$" }, "referencedId": { + "description": "Unique identity of reference.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "referencedVersionId": { + "description": "Unique identity of reference's version.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "entityName": { + "description": "Name of the entity.", "type": "string" }, "fromStateId": { + "description": "Unique identity of fromState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of toState.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "transitionActionName": { + "description": "Unique name of transition action.", "type": "string" }, "userId": { + "description": "Unique identity of user.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "integrationId": { "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "internalComment": { + "type": "string" + }, "createdAt": { "type": "string", "format": "date-time", @@ -40665,6 +42944,9 @@ }, "user": { "$ref": "#/components/schemas/User" + }, + "integration": { + "$ref": "#/components/schemas/Integration" } }, "type": "object" @@ -40688,12 +42970,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41045,12 +43329,14 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Technical name of StateMachineState.", "type": "string" }, "name": { "type": "string" }, "stateMachineId": { + "description": "Unique identity of StateMachine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41150,17 +43436,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -41289,17 +43579,21 @@ "pattern": "^[0-9a-f]{32}$" }, "actionName": { + "description": "Unique name of the action.", "type": "string" }, "stateMachineId": { + "description": "Unique identity of state machine.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "fromStateId": { + "description": "Unique identity of from state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "toStateId": { + "description": "Unique identity of to state.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43548,6 +45842,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -43559,6 +45854,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -43624,6 +45920,7 @@ "pattern": "^[0-9a-f]{32}$" }, "configurationKey": { + "description": "Config key for shop configurations.", "type": "string" }, "configurationValue": { @@ -43635,6 +45932,7 @@ "type": "object" }, "salesChannelId": { + "description": "Unique identity of sales channel.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44071,14 +46369,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -44278,14 +46578,16 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax.", "type": "number", "format": "float" }, "name": { + "description": "Name defined for a Tax.", "type": "string" }, "position": { - "description": "Added since version: 6.4.0.0.", + "description": "The order of the tabs of your defined taxes in the storefront by entering numerical values like 1,2,3, etc. Added since version: 6.4.0.0.", "type": "integer", "format": "int64" }, @@ -44409,26 +46711,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44530,26 +46838,32 @@ "pattern": "^[0-9a-f]{32}$" }, "identifier": { + "description": "Unique identity of tax provider.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the tax providers are available for selection in the storefront.", "type": "boolean" }, "name": { "type": "string" }, "priority": { + "description": "A numerical value to prioritize one of the tax providers from the list.", "type": "integer", "format": "int64" }, "processUrl": { + "description": "External URL makes request to get tax info.", "type": "string" }, "availabilityRuleId": { + "description": "Unique identity of availability Rule.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "appId": { + "description": "Unique identity of app.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -44598,14 +46912,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -44631,10 +46948,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -44760,14 +47079,17 @@ "pattern": "^[0-9a-f]{32}$" }, "taxRuleTypeId": { + "description": "Unique identity of tax rule type.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "countryId": { + "description": "Unique identity of country.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "taxRate": { + "description": "Rate of tax defined for a tax rule.", "type": "number", "format": "float" }, @@ -44793,10 +47115,12 @@ "type": "object" }, "taxId": { + "description": "Unique identity of tax.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "activeFrom": { + "description": "Date and time when the tax rule is enabled.", "type": "string", "format": "date-time" }, @@ -44841,10 +47165,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -44919,10 +47245,12 @@ "pattern": "^[0-9a-f]{32}$" }, "technicalName": { + "description": "Unique name of tax rule type.", "type": "string", "readOnly": true }, "position": { + "description": "The order of the tabs of your defined tax rules to be displayed in the storefront by entering numerical values like 1,2,3, etc.", "type": "integer", "format": "int64" }, @@ -45474,41 +47802,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -45981,41 +48320,52 @@ "pattern": "^[0-9a-f]{32}$" }, "localeId": { + "description": "Unique identity of locale.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "username": { + "description": "Username of the user.", "type": "string" }, "firstName": { + "description": "First name of the user.", "type": "string" }, "lastName": { + "description": "Last name of the user.", "type": "string" }, "title": { + "description": "Title of the user.", "type": "string" }, "email": { + "description": "Email of the user.", "type": "string" }, "active": { + "description": "When boolean value is `true`, the user is enabled.", "type": "boolean" }, "admin": { + "description": "Parameter that indicates if the user is an admin.", "type": "boolean" }, "lastUpdatedPasswordAt": { + "description": "Parameter that indicates when the password was last updated by the user.", "type": "string", "format": "date-time" }, "timeZone": { + "description": "Time configuration in the user's profile.", "type": "string" }, "customFields": { "type": "object" }, "avatarId": { + "description": "Unique identity of the avatar.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46156,16 +48506,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -46235,16 +48589,20 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "accessKey": { + "description": "Access key to admin api.", "type": "string" }, "secretAccessKey": { + "description": "Secret key to admin api.", "type": "string" }, "lastUsageAt": { + "description": "Parameter that indicates when the access key was last accessed.", "type": "string", "format": "date-time" }, @@ -46285,10 +48643,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -46356,10 +48716,12 @@ "pattern": "^[0-9a-f]{32}$" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "key": { + "description": "Unique key for every userconfig.", "type": "string" }, "value": { @@ -46399,9 +48761,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46467,9 +48831,11 @@ "pattern": "^[0-9a-f]{32}$" }, "hash": { + "description": "Password hash for user recovery.", "type": "string" }, "userId": { + "description": "Unique identity of user.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, @@ -46653,26 +49019,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -46682,13 +49055,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -46727,26 +49103,33 @@ "pattern": "^[0-9a-f]{32}$" }, "appName": { + "description": "Unique name of app.", "type": "string" }, "webhookName": { + "description": "Unique name of webhook.", "type": "string" }, "eventName": { + "description": "Unique name of event.", "type": "string" }, "deliveryStatus": { + "description": "Parameter that records \\\\\"success or failed\\\\\" status of the event.", "type": "string" }, "timestamp": { + "description": "Time at which the event occurred.", "type": "integer", "format": "int64" }, "processingTime": { + "description": "Time the event took to process.", "type": "integer", "format": "int64" }, "appVersion": { + "description": "Version of teh app.", "type": "string" }, "requestContent": { @@ -46756,13 +49139,16 @@ "type": "object" }, "responseStatusCode": { + "description": "HTTP status codes that are typically generated to provide informational (1xx), successful (2xx), redirection (3xx), client error (4xx), or server error (5xx) responses.", "type": "integer", "format": "int64" }, "responseReasonPhrase": { + "description": "Parameter that stores the reason phrase or message associated with the response received from a webhook event.", "type": "string" }, "url": { + "description": "A URL for the webhook event log.", "type": "string" }, "onlyLiveVersion": { @@ -46784,118 +49170,213 @@ }, "type": "object" }, - "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" - } - } - } - } - }, - "Price": { + "infoConfigResponse": { "type": "object", - "description": "Price object", "properties": { - "currencyId": { + "version": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" + "description": "Shopware version." }, - "net": { - "description": "", - "type": "number" + "shopId": { + "type": "string", + "description": "Unique shop identifier." }, - "linked": { - "description": "", - "type": "boolean" + "versionRevision": { + "type": "string", + "description": "Shopware version revision (build hash/revision)." }, - "listPrice": { - "description": "", + "adminWorker": { "type": "object", + "description": "Admin worker feature flags and transport configuration.", "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enableAdminWorker": { + "type": "boolean", + "description": "Whether the admin background worker is enabled." }, - "gross": { - "description": "", - "type": "number" + "enableQueueStatsWorker": { + "type": "boolean", + "description": "Whether the queue statistics worker is enabled. Deprecated: This property will be removed in v6.8.0. The increment-based message queue statistics are deprecated.", + "deprecated": true }, - "net": { - "description": "", - "type": "number" + "enableNotificationWorker": { + "type": "boolean", + "description": "Whether the notification worker is enabled." }, - "linked": { - "description": "", - "type": "boolean" + "transports": { + "type": "array", + "description": "Configured Symfony Messenger transports used by the admin workers.", + "items": { + "type": "string" + } } }, - "required": [ - "gross", - "net" - ] + "additionalProperties": false }, - "regulationPrice": { - "description": "", + "bundles": { + "type": "object", + "description": "Active extension assets (plugins & apps) keyed by technical name.", + "additionalProperties": { + "oneOf": [ + { + "type": "object", + "description": "Plugin bundle asset descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "plugin" + ] + }, + "css": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a CSS asset." + } + }, + "js": { + "type": "array", + "items": { + "type": "string", + "description": "URL to a JS asset." + } + }, + "baseUrl": { + "type": [ + "string", + "null" + ], + "description": "Base URL to a (micro frontend) admin entry point, if provided." + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "description": "App bundle descriptor.", + "properties": { + "type": { + "type": "string", + "enum": [ + "app" + ] + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "integrationId": { + "type": "string", + "description": "Lowercase hex integration id." + }, + "baseUrl": { + "type": "string" + }, + "version": { + "type": "string" + }, + "permissions": { + "type": "object", + "description": "Grouped privileges: key = privilege scope, value = list of entities.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "css": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional CSS assets if provided." + }, + "js": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional JS assets if provided." + } + }, + "required": [ + "type", + "name", + "active", + "integrationId", + "baseUrl", + "version", + "permissions" + ], + "additionalProperties": false + } + ] + } + }, + "settings": { "type": "object", + "description": "Selected environment and feature settings consumed by the administration.", "properties": { - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "enableUrlFeature": { + "type": "boolean", + "description": "State of the URL upload feature." }, - "gross": { - "description": "", - "type": "number" + "appUrlReachable": { + "type": "boolean", + "description": "Whether configured APP_URL is externally reachable." }, - "net": { - "description": "", - "type": "number" + "appsRequireAppUrl": { + "type": "boolean", + "description": "True if at least one installed app requires a reachable APP_URL." }, - "linked": { - "description": "", - "type": "boolean" + "private_allowed_extensions": { + "type": "array", + "description": "Whitelisted file extensions for private filesystem uploads.", + "items": { + "type": "string" + } + }, + "enableHtmlSanitizer": { + "type": "boolean", + "description": "Whether HTML sanitizer is enabled." + }, + "enableStagingMode": { + "type": "boolean", + "description": "Whether staging mode banner is enabled." + }, + "disableExtensionManagement": { + "type": "boolean", + "description": "True if runtime extension management is disabled." } }, - "required": [ - "gross", - "net" - ] + "additionalProperties": false + }, + "inAppPurchases": { + "type": "array", + "description": "In-app purchase meta data (structure may vary).", + "items": { + "type": "object", + "description": "Purchase entry.", + "additionalProperties": true + } } }, "required": [ - "currencyId", - "gross", - "net" - ] + "version", + "shopId", + "versionRevision", + "adminWorker", + "bundles", + "settings", + "inAppPurchases" + ], + "additionalProperties": false }, "flowBuilderActionsResponse": { "type": "array", @@ -46923,6 +49404,50 @@ } } }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", "type": "string", @@ -46995,7 +49520,7 @@ "administration" ] }, - "scopes": { + "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "username": { @@ -47009,7 +49534,7 @@ }, "required": [ "client_id", - "scopes", + "scope", "username", "password" ] @@ -47031,7 +49556,7 @@ "administration" ] }, - "scopes": { + "scope": { "$ref": "#/components/schemas/OAuthScopes" }, "refresh_token": { @@ -47041,12 +49566,46 @@ }, "required": [ "client_id", - "scopes", + "scope", "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)", @@ -47164,11 +49723,24 @@ }, "includes": { "$ref": "#/components/schemas/Includes" + }, + "excludes": { + "$ref": "#/components/schemas/Excludes" } } }, "Includes": { - "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "description": "Specify the fields that should be returned for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Fields will not be included, if they are also specified in the excludes. Note that the include fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "Excludes": { + "description": "Specify the fields that should be excluded from the response for the given entities. Object key needs to be the entity name, and the list of fields needs to be the value. Note that the exclude fields will only be stripped on the API-Level, consider using the `fields` parameter for performance reasons.", "type": "object", "additionalProperties": { "type": "array", @@ -47740,65 +50312,134 @@ "field" ] }, - "infoConfigResponse": { + "Price": { "type": "object", + "description": "Price object", "properties": { - "version": { + "currencyId": { "type": "string", - "description": "The Shopware version." + "pattern": "^[0-9a-f]{32}$" }, - "versionRevision": { - "type": "string", - "description": "The Shopware version revision." + "gross": { + "description": "", + "type": "number" }, - "adminWorker": { + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", "type": "object", - "description": "Information about the admin worker.", "properties": { - "enableAdminWorker": { - "type": "boolean", - "description": "State of the admin worker." + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "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." - } - } + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } + }, + "required": [ + "gross", + "net", + "linked" + ] }, - "settings": { + "regulationPrice": { + "description": "", "type": "object", "properties": { - "enableUrlFeature": { - "type": "boolean", - "description": "State of the `urlFeature` setting." + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } + }, + "required": [ + "gross", + "net", + "linked" + ] + } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] + }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" } } } @@ -48132,12 +50773,13 @@ "securitySchemes": { "oAuth": { "type": "oauth2", - "description": "Authentication API", + "description": "Authentication using OAuth 2.0", "flows": { "password": { - "tokenUrl": "http://localhost:8000/api/oauth/token", + "tokenUrl": "/api/oauth/token", "scopes": { - "write": "Full write access" + "write": "Full write access", + "admin": "Admin scope for administrative operations" } }, "clientCredentials": { @@ -48362,6 +51004,14 @@ "name": "Main Category", "description": "The endpoint for operations on Main Category" }, + { + "name": "Measurement Display Unit", + "description": "The endpoint for operations on Measurement Display Unit" + }, + { + "name": "Measurement System", + "description": "The endpoint for operations on Measurement System" + }, { "name": "Media", "description": "The endpoint for operations on Media" diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index d2017c5..6b55267 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -84,6 +84,7 @@ "CmsSectionJsonApi", "CmsSlot", "CmsSlotJsonApi", + "ConsentState", "Country", "CountryJsonApi", "CountryState", @@ -126,6 +127,7 @@ "DocumentType", "DocumentTypeJsonApi", "EqualsFilter", + "Excludes", "Filters", "Flow", "FlowJsonApi", @@ -162,6 +164,11 @@ "MailTemplateTypeJsonApi", "MainCategory", "MainCategoryJsonApi", + "MeasurementDisplayUnit", + "MeasurementDisplayUnitJsonApi", + "MeasurementSystem", + "MeasurementSystemJsonApi", + "MeasurementUnits", "Media", "MediaDefaultFolder", "MediaDefaultFolderJsonApi", From bc84b0d57523ed0b7e378cf89276d94040ce2765 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 31 Mar 2026 12:05:16 +0200 Subject: [PATCH 57/63] [create-pull-request] automated change (#467) Co-authored-by: shopwareBot --- adminapi.json | 3744 ++++++++++++++++++++++++------------------------- 1 file changed, 1872 insertions(+), 1872 deletions(-) diff --git a/adminapi.json b/adminapi.json index b7430c9..99c839f 100644 --- a/adminapi.json +++ b/adminapi.json @@ -74132,6 +74132,66 @@ } } }, + "/_action/number-range/reserve/{type}/{saleschannel}": { + "get": { + "tags": [ + "Document Management" + ], + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", + "parameters": [ + { + "name": "type", + "in": "path", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "saleschannel", + "in": "path", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "preview", + "in": "query", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", + "required": false, + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "The generated number", + "content": { + "application/json": { + "schema": { + "properties": { + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "400": { + "description": "Number range not found" + } + } + } + }, "/_action/index": { "post": { "tags": [ @@ -74165,19 +74225,19 @@ } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "orderDeliveryId", + "name": "orderTransactionId", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Identifier of the order transaction.", "required": true, "schema": { "type": "string", @@ -74187,7 +74247,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -74201,7 +74261,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be send to the customer." + "description": "Controls if a mail should be sent to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -74220,7 +74280,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, @@ -74236,422 +74296,157 @@ }, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/oauth/token": { - "post": { + "/_action/cache": { + "delete": { "tags": [ - "Authorization & Authentication" + "System Operations" ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" - } - ] - } - } - } - }, + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Authorized successfully.", - "content": { - "application/json": { - "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], - "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/oauth/sso/config": { - "get": { + "/_action/cache-delayed": { + "delete": { "tags": [ - "Experimental", - "SSO Login configuration" + "System Operations" ], - "summary": "Experimental: Loads SSO login configuration.", - "description": "Experimental: Loads the SSO login configuration to configure the forward to the Shopware SSO login page.", - "responses": { - "200": { - "description": "Experimental: Returns the configuration for the SSO login page forward.", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "useDefault": { - "description": "Experimental: Indicates which login is used. Default or SSO.", - "type": "boolean" - }, - "url": { - "description": "Experimental: Contains the return url for the Shopware SSO login.", - "type": "string" - } - } - } - } + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", + "parameters": [ + { + "name": "refreshOpenSearch", + "in": "query", + "required": false, + "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", + "schema": { + "type": "boolean", + "default": false } } - }, - "operationId": "loadSsoLoginConfig" + ], + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } } }, - "/oauth/sso/code": { + "/_info/flow-actions.json": { "get": { "tags": [ - "Experimental", - "SSO Login callback" + "System Info & Health Check" ], - "summary": "Experimental: Callback for SSO login", - "description": "Experimental: Logs in the user into the Shopware shop and forwards to the admin", + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", "responses": { "200": { - "description": "Authorisation process continues", + "description": "Returns a list of action for flow builder.", "content": { "application/json": { "schema": { - "type": "object" + "$ref": "#/components/schemas/flowBuilderActionsResponse" } } } - }, - "302": { - "description": "Experimental: Forwards to the Shopware admin" - } - }, - "operationId": "callBackWithCode" - } - }, - "/oauth/sso/auth": { - "get": { - "tags": [ - "Experimental", - "SSO Login forward" - ], - "summary": "Experimental: Redirect to SSO login", - "description": "Experimental: Creates a redirection to the SSO login page", - "operationId": "ssoAuth", - "responses": { - "302": { - "description": "Experimental: Forwards to SSO login Page" } } } }, - "/_info/is-sso": { - "get": { - "tags": [ - "Experimental", - "Is SSO environment" - ], - "summary": "Experimental: Is SSO environment", - "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", - "operationId": "isSso", - "responses": { - "200": { - "description": "Experimental: Returns if it is a SSO environment or not" - } - } - } - }, - "/_action/sso/invite-user": { + "/_action/index-products": { "post": { "tags": [ - "Experimental", - "Invite a new SSO user" + "System Operations" ], - "summary": "Experimental: Invite a new SSO user", - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", - "operationId": "inviteUser", + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", "responses": { - "200": { - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" + "204": { + "description": "Returns an empty response indicating that the message dispatched." } } } }, - "/_info/message-stats.json": { + "/_info/queue.json": { "get": { - "summary": "Get statistics message queue", - "description": "Get statistics for recently processed messages in the message queue", - "operationId": "getMessageStats", "tags": [ "System Info & Health Check" ], + "summary": "Get message queue statistics (deprecated)", + "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", + "operationId": "queue", + "deprecated": true, "responses": { "200": { - "description": "Statistics received", + "description": "Message queue statistics returned.", "content": { "application/json": { "schema": { - "type": "object", - "required": [ - "enabled" - ], - "properties": { - "enabled": { - "type": "boolean", - "description": "Whether message queue statistics are enabled in configuration" - }, - "stats": { - "type": [ - "object", - "null" - ], - "properties": { - "totalMessagesProcessed": { - "type": "integer" - }, - "processedSince": { - "type": "string", - "format": "date-time" - }, - "averageTimeInQueue": { - "type": "number", - "format": "float" - }, - "messageTypeStats": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "count": { - "type": "integer" - } - } - } - } + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Fully qualified class name of the message." + }, + "size": { + "type": "integer", + "description": "Number of pending messages of this type." } - } - } - } - } - } - } - } - } - }, - "/consents": { - "get": { - "tags": [ - "Consent Management", - "Experimental" - ], - "summary": "List all consents for current user", - "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "fetchConsents", - "responses": { - "200": { - "description": "List of consents with their status", - "content": { - "application/json": { - "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ConsentState" - }, - "example": { - "product_analytics": { - "name": "product_analytics", - "scopeName": "admin_user", - "identifier": "userId-12345", - "status": "accepted", - "actor": "userId-12345", - "updatedAt": "2024-01-15T10:20:30Z" }, - "backend_data": { - "name": "backend_data", - "scopeName": "system", - "identifier": "system", - "status": "requested", - "actor": null, - "updatedAt": null - } - } - } - } - } - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" - } - } - } - }, - "/consents/accept": { - "post": { - "tags": [ - "Consent Management", - "Experimental" - ], - "summary": "Accept a consent", - "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "acceptConsent", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "consent": { - "type": "string", - "description": "The name of the consent to accept" + "required": [ + "name", + "size" + ] } }, - "required": [ - "consent" - ], - "example": { - "consent": "product_analytics" - } - } - } - } - }, - "responses": { - "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentState" - } - } - } - }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" - } - } - } - }, - "/consents/revoke": { - "post": { - "tags": [ - "Consent Management", - "Experimental" - ], - "summary": "Revoke a consent", - "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "revokeConsent", - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "consent": { - "type": "string", - "description": "The name of the consent to accept" + "example": [ + { + "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", + "size": 150 + }, + { + "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", + "size": 25 } - }, - "required": [ - "consent" - ], - "example": { - "consent": "product_analytics" - } - } - } - } - }, - "responses": { - "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentState" - } + ] } } - }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/cache_info": { + "/_info/version": { "get": { "tags": [ - "System Operations" + "System Info & Health Check" ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "Information about the cache state.", + "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { "properties": { - "environment": { - "description": "The active environment.", - "type": "string" - }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" - }, - "cacheAdapter": { - "description": "The active cache adapter.", + "version": { + "description": "The Shopware version.", "type": "string" } }, @@ -74851,275 +74646,129 @@ } } }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", + "/_action/container_cache": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "endpoints" - ], - "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } - } - } - } - } - } - } - } - } - }, - "/_info/health-check": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", - "responses": { - "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" + "204": { + "description": "Returns a no content response indicating that the container cache is cleared." } } } }, - "/_info/system-health-check": { + "/_action/document/{documentId}/{deepLinkCode}": { "get": { "tags": [ - "System Info & Health Check" + "Document Management" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", "parameters": [ { - "name": "verbose", + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", "in": "query", - "required": false, + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", "schema": { "type": "boolean", "default": false - }, - "description": "Include detailed information in the response" + } } ], "responses": { "200": { - "description": "Returns the system health check results", + "description": "The document.", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } + "type": "string", + "format": "binary" } } } - }, - "500": { - "description": "Application is not working properly" } } } }, - "/_action/mail-template/send": { + "/_action/document/{documentId}/upload": { "post": { "tags": [ - "Mail Operations" + "Document Management" + ], + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, + "schema": { + "type": "string" + } + } ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", "requestBody": { - "required": true, "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, "application/json": { "schema": { "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" + "url" ], "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "url": { + "description": "The url of the document that will be downloaded.", "type": "string" - }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } } }, "type": "object" @@ -75129,14 +74778,19 @@ }, "responses": { "200": { - "description": "The mail was sent successful", + "description": "Document uploaded successful", "content": { "application/json": { "schema": { "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", + "type": "string" } }, "type": "object" @@ -75147,91 +74801,49 @@ } } }, - "/_action/mail-template/validate": { + "/_action/indexing": { "post": { "tags": [ - "Mail Operations" + "System Operations" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "200": { + "description": "Returns an empty response indicating that the indexing process started." } } } }, - "/_action/mail-template/build": { + "/_action/indexing/{indexer}": { "post": { "tags": [ - "Mail Operations" + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", + "parameters": [ + { + "name": "indexer", + "in": "path", + "description": "Name of the indexer to iterate.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", - "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" - }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" - } - }, - "type": "object" + "offset": { + "description": "The offset for the iteration.", + "type": "integer" } }, "type": "object" @@ -75241,11 +74853,21 @@ }, "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "Returns information about the iteration.", "content": { "application/json": { "schema": { - "type": "string" + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" } } } @@ -75286,220 +74908,164 @@ } } }, - "/_info/openapi3.json": { + "/_action/cache_info": { "get": { "tags": [ - "System Info & Health Check" - ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] - } - } + "System Operations" ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "Information about the cache state.", + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", + "type": "string" + } + }, + "type": "object" + } + } + } } } } }, - "/_info/events.json": { + "/consents": { "get": { "tags": [ - "System Info & Health Check" + "Consent Management", + "Experimental" ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", + "summary": "List all consents for current user", + "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "fetchConsents", "responses": { "200": { - "description": "Returns a list of about the business events.", + "description": "List of consents with their status", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/businessEventsResponse" + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ConsentState" + }, + "example": { + "product_analytics": { + "name": "product_analytics", + "scopeName": "admin_user", + "identifier": "userId-12345", + "status": "accepted", + "actor": "userId-12345", + "updatedAt": "2024-01-15T10:20:30Z" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "requested", + "actor": null, + "updatedAt": null + } + } } } } + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/index-products": { + "/consents/accept": { "post": { "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." - } - } - } - }, - "/_action/container_cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." - } - } - } - }, - "/_action/message-queue/consume": { - "post": { - "tags": [ - "System Operations" + "Consent Management", + "Experimental" ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", + "summary": "Accept a consent", + "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "acceptConsent", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "receiver" - ], + "type": "object", "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" + "consent": { + "type": "string", + "description": "The name of the consent to accept" } }, - "type": "object" + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } } } } }, "responses": { "200": { - "description": "Returns information about handled messages", + "description": "Consent status changed successfully. Returns the updated consent status.", "content": { "application/json": { "schema": { - "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" - } - }, - "type": "object" + "$ref": "#/components/schemas/ConsentState" } } } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/sync": { + "/consents/revoke": { "post": { "tags": [ - "Bulk Operations" - ], - "summary": "Bulk edit entities", - "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", - "operationId": "sync", - "parameters": [ - { - "name": "fail-on-error", - "in": "header", - "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", - "schema": { - "type": "boolean", - "default": true - } - }, - { - "name": "indexing-behavior", - "in": "header", - "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", - "schema": { - "type": "string", - "enum": [ - "use-queue-indexing", - "disable-indexing" - ] - } - } + "Consent Management", + "Experimental" ], + "summary": "Revoke a consent", + "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "revokeConsent", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "type": "array", - "items": { - "required": [ - "action", - "entity", - "payload" - ], - "properties": { - "action": { - "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", - "type": "string", - "enum": [ - "upsert", - "delete" - ] - }, - "entity": { - "description": "The entity that should be processed with the payload.", - "type": "string", - "example": "product" - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object" - } - }, - "criteria": { - "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", - "type": "array", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/SimpleFilter" - }, - { - "$ref": "#/components/schemas/EqualsFilter" - }, - { - "$ref": "#/components/schemas/MultiNotFilter" - }, - { - "$ref": "#/components/schemas/RangeFilter" - } - ] - } - } - }, - "type": "object" + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" } } } @@ -75507,28 +75073,20 @@ }, "responses": { "200": { - "description": "Returns a sync result containing information about the updated entities", + "description": "Consent status changed successfully. Returns the updated consent status.", "content": { "application/json": { "schema": { - "properties": { - "data": { - "description": "Object with information about updated entities", - "type": "object" - }, - "notFound": { - "description": "Object with information about not found entities", - "type": "object" - }, - "deleted": { - "description": "Object with information about deleted entities", - "type": "object" - } - }, - "type": "object" + "$ref": "#/components/schemas/ConsentState" } } } + }, + "404": { + "description": "Bad request - Consent not found or consent property was empty" + }, + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } @@ -75879,135 +75437,782 @@ } } }, - "/_action/document/{documentId}/{deepLinkCode}": { - "get": { + "/_action/order/{orderId}/order-address": { + "post": { "tags": [ - "Document Management" + "Order address" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", "parameters": [ { - "name": "documentId", + "name": "orderId", "in": "path", - "description": "Identifier of the document to be downloaded.", + "description": "Identifier of the order.", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{32}$" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "description": "The ID of the delivery (optional)", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } + } + } + } }, + "required": true + }, + "responses": { + "204": { + "description": "Returns a no content response indicating that the update has been made." + } + } + } + }, + "/app-system/privileges/requested": { + "get": { + "tags": [ + "App System" + ], + "summary": "Get requested privileges for all apps", + "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", + "operationId": "getRequestedPrivileges", + "security": [ { - "name": "deepLinkCode", + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing requested privileges.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "example": { + "privileges": { + "SwagAnalytics": [ + "customer:read", + "order:read" + ], + "SwagExample": [ + "product:write" + ] + } + } + } + } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + } + } + } + }, + "/app-system/{appName}/privileges/accepted": { + "get": { + "tags": [ + "App System" + ], + "summary": "Get accepted privileges for an app", + "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", + "operationId": "getAcceptedPrivileges", + "parameters": [ + { + "name": "appName", "in": "path", - "description": "A unique hash code which was generated when the document was created.", "required": true, "schema": { "type": "string" } - }, + } + ], + "security": [ { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } + "oAuth": [ + "admin" + ] } ], "responses": { "200": { - "description": "The document.", + "description": "A JSON object containing accepted privileges.", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } + } + } + }, + "example": { + "privileges": { + "customer:read": true, + "order:read": true + } } } } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." } } } }, - "/_action/document/{documentId}/upload": { - "post": { + "/app-system/{appName}/privileges": { + "patch": { "tags": [ - "Document Management" + "App System" ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", + "summary": "Accept or revoke privileges for an app", + "description": "Accepts or revokes specified privileges for the given app.", + "operationId": "managePrivileges", "parameters": [ { - "name": "documentId", + "name": "appName", "in": "path", - "description": "Identifier of the document the new file should be added to.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "accept": { + "type": "array", + "items": { + "type": "string" + } + }, + "revoke": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "example": { + "accept": [ + "customer:read", + "order:read" + ], + "revoke": [ + "product:write" + ] + } + } + } + }, + "responses": { + "204": { + "description": "Returns no content if privileges were managed successfully." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." }, + "404": { + "description": "App not found." + } + }, + "security": [ { - "name": "fileName", - "in": "query", - "description": "Name of the uploaded file.", - "required": true, + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/_action/app-system/secret/rotate": { + "post": { + "tags": [ + "App System" + ], + "summary": "Initiate secret rotation for the calling app", + "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", + "operationId": "appSecretRotation", + "responses": { + "202": { + "description": "Returns \"Accepted\" when secret rotation was scheduled." + }, + "400": { + "description": "Malformed request, e.g. when requested with non app integration source." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." + } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] + } + }, + "/_action/sync": { + "post": { + "tags": [ + "Bulk Operations" + ], + "summary": "Bulk edit entities", + "description": "Starts a sync process for the list of provided actions. This can be upserts and deletes on different entities to an asynchronous process in the background. You can control the behaviour with the `indexing-behavior` header.", + "operationId": "sync", + "parameters": [ + { + "name": "fail-on-error", + "in": "header", + "description": "To continue upcoming actions on errors, set the `fail-on-error` header to `false`.", "schema": { - "type": "string" + "type": "boolean", + "default": true } }, { - "name": "extension", - "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", - "required": true, + "name": "indexing-behavior", + "in": "header", + "description": "Controls the indexing behavior.\n - `disable-indexing`: Data indexing is completely disabled", "schema": { - "type": "string" + "type": "string", + "enum": [ + "use-queue-indexing", + "disable-indexing" + ] + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "required": [ + "action", + "entity", + "payload" + ], + "properties": { + "action": { + "description": "The action indicates what should happen with the provided payload.\n * `upsert`: The Sync API does not differ between create and update operations,\n but always performs an upsert operation. During an upsert, the system checks whether the entity already exists in the\n system and updates it if an identifier has been passed, otherwise a new entity is created with this identifier.\n * `delete`: Deletes entities with the provided identifiers", + "type": "string", + "enum": [ + "upsert", + "delete" + ] + }, + "entity": { + "description": "The entity that should be processed with the payload.", + "type": "string", + "example": "product" + }, + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", + "type": "array", + "items": { + "type": "object" + } + }, + "criteria": { + "description": "Only for delete operations: Instead of providing IDs in the payload, the filter by which should be deleted can be provided directly.", + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/components/schemas/SimpleFilter" + }, + { + "$ref": "#/components/schemas/EqualsFilter" + }, + { + "$ref": "#/components/schemas/MultiNotFilter" + }, + { + "$ref": "#/components/schemas/RangeFilter" + } + ] + } + } + }, + "type": "object" + } + } + } + } + }, + "responses": { + "200": { + "description": "Returns a sync result containing information about the updated entities", + "content": { + "application/json": { + "schema": { + "properties": { + "data": { + "description": "Object with information about updated entities", + "type": "object" + }, + "notFound": { + "description": "Object with information about not found entities", + "type": "object" + }, + "deleted": { + "description": "Object with information about deleted entities", + "type": "object" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/oauth/sso/config": { + "get": { + "tags": [ + "Authorization & Authentication", + "SSO Login configuration" + ], + "summary": "Loads configuration for the admin login", + "description": "Loads the configuration for the admin login. This configuration is used to load and configure the default or Single Sign On (SSO) login for the admin.", + "operationId": "loadSsoLoginConfig", + "responses": { + "200": { + "description": "Config loaded successfully.", + "content": { + "application/json": { + "schema": { + "properties": { + "useDefault": { + "description": "Experimental: Indicates which login is used. Default or SSO.", + "type": "boolean" + }, + "url": { + "description": "Experimental: Contains the return url for the Shopware SSO login.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/oauth/sso/code": { + "get": { + "tags": [ + "Authorization & Authentication", + "SSO Login callback" + ], + "summary": "Callback function. Fetch an authorization code", + "description": "Fetch an authorization code log in the user.", + "operationId": "callBackWithCode", + "responses": { + "302": { + "description": "Experimental: Forwards to the Shopware admin" + }, + "200": { + "description": "Authorisation process continues", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } + } + }, + "/oauth/sso/auth": { + "get": { + "tags": [ + "Experimental", + "SSO Login forward" + ], + "summary": "Experimental: Redirect to SSO login", + "description": "Experimental: Creates a redirection to the SSO login page", + "operationId": "ssoAuth", + "responses": { + "302": { + "description": "Experimental: Forwards to SSO login Page" + } + } + } + }, + "/_info/is-sso": { + "get": { + "tags": [ + "Experimental", + "Is SSO environment" + ], + "summary": "Experimental: Is SSO environment", + "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", + "operationId": "isSso", + "responses": { + "200": { + "description": "Experimental: Returns if it is a SSO environment or not" + } + } + } + }, + "/_action/sso/invite-user": { + "post": { + "tags": [ + "Experimental", + "Invite a new SSO user" + ], + "summary": "Experimental: Invite a new SSO user", + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", + "operationId": "inviteUser", + "responses": { + "200": { + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" + } + } + } + }, + "/_info/message-stats.json": { + "get": { + "summary": "Get statistics message queue", + "description": "Get statistics for recently processed messages in the message queue", + "operationId": "getMessageStats", + "tags": [ + "System Info & Health Check" + ], + "responses": { + "200": { + "description": "Statistics received", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether message queue statistics are enabled in configuration" + }, + "stats": { + "type": [ + "object", + "null" + ], + "properties": { + "totalMessagesProcessed": { + "type": "integer" + }, + "processedSince": { + "type": "string", + "format": "date-time" + }, + "averageTimeInQueue": { + "type": "number", + "format": "float" + }, + "messageTypeStats": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "count": { + "type": "integer" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "/_info/events.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", + "responses": { + "200": { + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } + } + } + } + }, + "/_action/scheduled-task/run": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", + "responses": { + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/scheduled-task/min-run-interval": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", + "responses": { + "200": { + "description": "Returns the minimum interval.", + "content": { + "application/json": { + "schema": { + "properties": { + "minRunInterval": { + "description": "Minimal interval in seconds.", + "type": "string" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", + "tags": [ + "System Info & Health Check" + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { + "type": "object", + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "type": "string" + } + } + } + } + } + } + } } } + } + } + }, + "/oauth/token": { + "post": { + "tags": [ + "Authorization & Authentication" ], + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", "requestBody": { + "required": true, "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, "application/json": { "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" + }, + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" } - }, - "type": "object" + ] } } } }, "responses": { "200": { - "description": "Document uploaded successful", + "description": "Authorized successfully.", "content": { "application/json": { "schema": { + "required": [ + "token_type", + "expires_in", + "access_token" + ], "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "token_type": { + "description": "Type of the token.", + "type": "string" }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", "type": "string" } }, @@ -76015,65 +76220,26 @@ } } } + }, + "400": { + "$ref": "#/components/responses/400" } } } }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", - "parameters": [ - { - "name": "refreshOpenSearch", - "in": "query", - "required": false, - "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", "parameters": [ { - "name": "orderTransactionId", + "name": "orderDeliveryId", "in": "path", - "description": "Identifier of the order transaction.", + "description": "Identifier of the order delivery.", "required": true, "schema": { "type": "string", @@ -76083,7 +76249,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", "required": true, "schema": { "type": "string" @@ -76097,7 +76263,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be sent to the customer." + "description": "Controls if a mail should be send to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -76116,7 +76282,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, @@ -76132,69 +76298,31 @@ }, "responses": { "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" - } - } - } - }, - "/_action/cleanup": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cleanup finished." - } - } - } - }, - "/_action/indexing": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", - "responses": { - "200": { - "description": "Returns an empty response indicating that the indexing process started." + "description": "Todo: Use ref of `state_machine_transition` here" } } } }, - "/_action/indexing/{indexer}": { + "/_action/message-queue/consume": { "post": { "tags": [ "System Operations" ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", - "parameters": [ - { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "required": [ + "receiver" + ], "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" } }, "type": "object" @@ -76204,17 +76332,13 @@ }, "responses": { "200": { - "description": "Returns information about the iteration.", + "description": "Returns information about handled messages", "content": { "application/json": { "schema": { "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", + "handledMessages": { + "description": "The number of messages processed.", "type": "integer" } }, @@ -76226,211 +76350,331 @@ } } }, - "/_action/state-machine/{entityName}/{entityId}/state": { + "/_info/health-check": { "get": { "tags": [ - "State Machine" + "System Info & Health Check" ], - "summary": "Get available transitions for an entity", - "description": "Retrieves the available state transitions for the specified entity.", - "operationId": "getEntityState", - "parameters": [ - { - "name": "entityName", - "in": "path", - "description": "Name of the entity.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "entityId", - "in": "path", - "description": "Identifier of the entity.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "summary": "Check that the Application is running", + "operationId": "healthCheck", + "responses": { + "200": { + "description": "Returns empty response" }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_info/system-health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ { - "name": "stateFieldName", + "name": "verbose", "in": "query", - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", "required": false, "schema": { - "type": "string", - "default": "stateId" - } + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" } ], "responses": { "200": { - "description": "Available transitions for the current state.", + "description": "Returns the system health check results", "content": { "application/json": { "schema": { "type": "object", "properties": { - "transitions": { + "checks": { "type": "array", "items": { "type": "object", "properties": { "name": { - "type": "string", - "description": "The name of the transition." - }, - "technicalName": { - "type": "string", - "description": "The technical name of the transition." + "type": "string" }, - "actionName": { - "type": "string", - "description": "The action name of the transition." + "healthy": { + "type": "boolean" }, - "fromStateName": { - "type": "string", - "description": "The technical name of the state the transition starts from." + "status": { + "type": "string" }, - "toStateName": { - "type": "string", - "description": "The technical name of the state the transition goes to." + "message": { + "type": "string" }, - "url": { - "type": "string", - "description": "The URL to trigger the transition." + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } } - }, - "required": [ - "name", - "technicalName", - "actionName", - "fromStateName", - "toStateName", - "url" - ] + } } } - }, - "required": [ - "transitions" - ] + } } } } }, - "400": { - "description": "Unable to read the entity or entity field." - }, - "403": { - "description": "Forbidden. Missing privileges to access the entity." + "500": { + "description": "Application is not working properly" } } } }, - "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { + "/_proxy/generate-imitate-customer-token": { "post": { "tags": [ - "State Machine" + "Customer impersonation" ], - "summary": "Transition an entity to a new state", - "description": "Changes the entity state by applying the given transition.", - "operationId": "transitionEntityState", - "parameters": [ - { - "name": "entityName", - "in": "path", - "description": "Name of the entity.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "entityId", - "in": "path", - "description": "Identifier of the entity.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`.", - "required": true, - "schema": { - "type": "string" + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" + }, + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } } - }, - { - "name": "stateFieldName", - "in": "query", - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "required": false, - "schema": { - "type": "string", - "default": "stateId" + } + }, + "responses": { + "200": { + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } } } + } + } + }, + "/_action/mail-template/send": { + "post": { + "tags": [ + "Mail Operations" ], + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", "requestBody": { - "description": "Optional internal comment for the state transition.", + "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], "properties": { - "internalComment": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", "type": "string", - "description": "An optional internal comment that will be saved with the state transition." + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } } - } + }, + "type": "object" } } } }, "responses": { "200": { - "description": "State transition applied successfully." - }, - "400": { - "description": "Unable to read the entity or entity field, or invalid transition." - }, - "403": { - "description": "Forbidden. Missing privileges to access the entity." + "description": "The mail was sent successful", + "content": { + "application/json": { + "schema": { + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" + } + }, + "type": "object" + } + } + } } } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/mail-template/validate": { "post": { "tags": [ - "Customer impersonation" + "Mail Operations" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ - "customerId", - "salesChannelId" + "contentHtml", + "contentPlain" ], "properties": { - "customerId": { - "description": "ID of the customer", + "contentHtml": { + "description": "The content of the mail in HTML format.", "type": "string" }, - "salesChannelId": { - "description": "ID of the sales channel", + "contentPlain": { + "description": "The content of the mail as plain text.", "type": "string" } }, @@ -76440,74 +76684,72 @@ } }, "responses": { - "200": { - "description": "The generated customer impersonation token.", - "content": { - "application/json": { - "schema": { - "properties": { - "token": { - "description": "The generated customer impersonation token", - "type": "string" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, - "/_action/scheduled-task/run": { + "/_action/mail-template/build": { "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", - "responses": { - "200": { - "description": "Returns a success message indicating a successful run.", - "content": { - "application/json": { - "schema": { - "properties": { - "message": { - "description": "Success message", - "type": "string" - } + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "mailTemplateType", + "mailTemplate" + ], + "properties": { + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" }, - "type": "object" - } + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" + } + }, + "type": "object" } } } - } - } - }, - "/_action/scheduled-task/min-run-interval": { - "get": { - "tags": [ - "System Operations" - ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + }, "responses": { "200": { - "description": "Returns the minimum interval.", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, - "type": "object" + "type": "string" } } } @@ -76689,495 +76931,139 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "key" - ], - "properties": { - "key": { - "type": "string", - "description": "The key to decrement in the pool." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successfully decremented the value", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - key parameter missing or cluster parameter missing" - } - } - } - }, - "/_action/reset-increment/{pool}": { - "post": { - "tags": [ - "Increment Storage" - ], - "summary": "Reset increment values in pool", - "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", - "operationId": "resetIncrementValues", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to reset.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the reset operation.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successfully reset the increment values", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "success": { - "type": "boolean", - "example": true - } - } - } - } - } - }, - "400": { - "description": "Bad request - cluster parameter missing" - } - } - } - }, - "/_action/delete-increment/{pool}": { - "delete": { - "tags": [ - "Increment Storage" - ], - "summary": "Delete increment keys from pool", - "description": "Deletes specific increment keys from the specified pool.", - "operationId": "deleteIncrementKeys", - "parameters": [ - { - "name": "pool", - "in": "path", - "description": "The name of the increment pool to delete keys from.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "cluster", - "in": "query", - "description": "Cluster identifier for the delete operation.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "keys" - ], - "properties": { - "keys": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of keys to delete from the pool." - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Successfully deleted the increment keys" - }, - "400": { - "description": "Bad request - invalid keys parameter or cluster parameter missing" - } - } - } - }, - "/_action/order/{orderId}/order-address": { - "post": { - "tags": [ - "Order address" - ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", - "parameters": [ - { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "description": "The ID of the delivery (optional)", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" - } - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." - } - } - } - }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { - "tags": [ - "Document Management" - ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "description": "Number range not found" - } - } - } - }, - "/_info/version": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" - } - }, - "type": "object" - } - } - } - } - } - } - }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Health Check" + } ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "key" + ], + "properties": { + "key": { + "type": "string", + "description": "The key to decrement in the pool." + } } } } } - } - } - }, - "/app-system/privileges/requested": { - "get": { - "tags": [ - "App System" - ], - "summary": "Get requested privileges for all apps", - "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", - "operationId": "getRequestedPrivileges", - "security": [ - { - "oAuth": [ - "admin" - ] - } - ], + }, "responses": { "200": { - "description": "A JSON object containing requested privileges.", + "description": "Successfully decremented the value", "content": { "application/json": { "schema": { "type": "object", "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - } + "success": { + "type": "boolean", + "example": true } } - }, - "example": { - "privileges": { - "SwagAnalytics": [ - "customer:read", - "order:read" - ], - "SwagExample": [ - "product:write" - ] - } } } } }, "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." + "description": "Bad request - key parameter missing or cluster parameter missing" } } } }, - "/app-system/{appName}/privileges/accepted": { - "get": { + "/_action/reset-increment/{pool}": { + "post": { "tags": [ - "App System" + "Increment Storage" ], - "summary": "Get accepted privileges for an app", - "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", - "operationId": "getAcceptedPrivileges", + "summary": "Reset increment values in pool", + "description": "Resets increment values in the specified pool. Can reset all values or a specific key if provided.", + "operationId": "resetIncrementValues", "parameters": [ { - "name": "appName", + "name": "pool", "in": "path", + "description": "The name of the increment pool to reset.", "required": true, "schema": { "type": "string" } - } - ], - "security": [ + }, { - "oAuth": [ - "admin" - ] + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the reset operation.", + "required": true, + "schema": { + "type": "string" + } } ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Optional specific key to reset. If not provided, all values in the pool will be reset." + } + } + } + } + } + }, "responses": { "200": { - "description": "A JSON object containing accepted privileges.", + "description": "Successfully reset the increment values", "content": { "application/json": { "schema": { "type": "object", "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "boolean" - } + "success": { + "type": "boolean", + "example": true } } - }, - "example": { - "privileges": { - "customer:read": true, - "order:read": true - } } } } }, "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." + "description": "Bad request - cluster parameter missing" } } } }, - "/app-system/{appName}/privileges": { - "patch": { + "/_action/delete-increment/{pool}": { + "delete": { "tags": [ - "App System" + "Increment Storage" ], - "summary": "Accept or revoke privileges for an app", - "description": "Accepts or revokes specified privileges for the given app.", - "operationId": "managePrivileges", + "summary": "Delete increment keys from pool", + "description": "Deletes specific increment keys from the specified pool.", + "operationId": "deleteIncrementKeys", "parameters": [ { - "name": "appName", + "name": "pool", "in": "path", + "description": "The name of the increment pool to delete keys from.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "cluster", + "in": "query", + "description": "Cluster identifier for the delete operation.", "required": true, "schema": { "type": "string" @@ -77190,139 +77076,43 @@ "application/json": { "schema": { "type": "object", + "required": [ + "keys" + ], "properties": { - "accept": { - "type": "array", - "items": { - "type": "string" - } - }, - "revoke": { + "keys": { "type": "array", "items": { "type": "string" - } + }, + "description": "Array of keys to delete from the pool." } } - }, - "example": { - "accept": [ - "customer:read", - "order:read" - ], - "revoke": [ - "product:write" - ] } } } }, "responses": { "204": { - "description": "Returns no content if privileges were managed successfully." - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] - } - ] - } - }, - "/_action/app-system/secret/rotate": { - "post": { - "tags": [ - "App System" - ], - "summary": "Initiate secret rotation for the calling app", - "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", - "operationId": "appSecretRotation", - "responses": { - "202": { - "description": "Returns \"Accepted\" when secret rotation was scheduled." + "description": "Successfully deleted the increment keys" }, "400": { - "description": "Malformed request, e.g. when requested with non app integration source." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] + "description": "Bad request - invalid keys parameter or cluster parameter missing" } - ] + } } }, - "/_info/queue.json": { - "get": { + "/_action/cleanup": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Get message queue statistics (deprecated)", - "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", - "operationId": "queue", - "deprecated": true, + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", "responses": { - "200": { - "description": "Message queue statistics returned.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Fully qualified class name of the message." - }, - "size": { - "type": "integer", - "description": "Number of pending messages of this type." - } - }, - "required": [ - "name", - "size" - ] - } - }, - "example": [ - { - "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", - "size": 150 - }, - { - "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", - "size": 25 - } - ] - } - } + "204": { + "description": "Returns a no content response indicating that the cleanup finished." } } } @@ -77434,6 +77224,216 @@ } } }, + "/_action/state-machine/{entityName}/{entityId}/state": { + "get": { + "tags": [ + "State Machine" + ], + "summary": "Get available transitions for an entity", + "description": "Retrieves the available state transitions for the specified entity.", + "operationId": "getEntityState", + "parameters": [ + { + "name": "entityName", + "in": "path", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } + } + ], + "responses": { + "200": { + "description": "Available transitions for the current state.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "transitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the transition." + }, + "technicalName": { + "type": "string", + "description": "The technical name of the transition." + }, + "actionName": { + "type": "string", + "description": "The action name of the transition." + }, + "fromStateName": { + "type": "string", + "description": "The technical name of the state the transition starts from." + }, + "toStateName": { + "type": "string", + "description": "The technical name of the state the transition goes to." + }, + "url": { + "type": "string", + "description": "The URL to trigger the transition." + } + }, + "required": [ + "name", + "technicalName", + "actionName", + "fromStateName", + "toStateName", + "url" + ] + } + } + }, + "required": [ + "transitions" + ] + } + } + } + }, + "400": { + "description": "Unable to read the entity or entity field." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." + } + } + } + }, + "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { + "post": { + "tags": [ + "State Machine" + ], + "summary": "Transition an entity to a new state", + "description": "Changes the entity state by applying the given transition.", + "operationId": "transitionEntityState", + "parameters": [ + { + "name": "entityName", + "in": "path", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } + } + ], + "requestBody": { + "description": "Optional internal comment for the state transition.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "internalComment": { + "type": "string", + "description": "An optional internal comment that will be saved with the state transition." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "State transition applied successfully." + }, + "400": { + "description": "Unable to read the entity or entity field, or invalid transition." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." + } + } + } + }, + "/_info/openapi3.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/OpenApi3" + } + } + } + }, "/_action/theme/{themeId}": { "patch": { "tags": [ @@ -120259,87 +120259,75 @@ ], "additionalProperties": false }, - "Price": { + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "MeasurementUnits": { "type": "object", - "description": "Price object", + "description": "Configuration of the measurement system", "properties": { - "currencyId": { + "system": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." }, - "listPrice": { - "description": "", + "units": { "type": "object", + "description": "Units used in the measurement system.", "properties": { - "currencyId": { + "length": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." }, - "linked": { - "description": "", - "type": "boolean" - } - }, - "required": [ - "gross", - "net", - "linked" - ] - }, - "regulationPrice": { - "description": "", - "type": "object", - "properties": { - "currencyId": { + "weight": { "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "gross": { - "description": "", - "type": "number" - }, - "net": { - "description": "", - "type": "number" - }, - "linked": { - "description": "", - "type": "boolean" + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." } - }, - "required": [ - "gross", - "net", - "linked" - ] + } } - }, - "required": [ - "currencyId", - "gross", - "net", - "linked" - ] + } }, "OAuthScopes": { "description": "OAuth scopes that should be requested.", @@ -120465,28 +120453,36 @@ } ] }, - "flowBuilderActionsResponse": { + "businessEventsResponse": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", - "description": "Name of the flow action" + "description": "Unique name of the businessEventsResponse." }, - "requirements": { + "class": { + "type": "string", + "description": "Class name of business event." + }, + "data": { + "type": "object", + "description": "Internal field." + }, + "aware": { "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", + "description": "Parameter that indicates the areas in which the business event is supported.", "items": { "type": "string" } }, "extensions": { "type": "array", + "description": "Internal field.", "items": { "type": "string" - }, - "description": "Extensions data of event" + } } } } @@ -121211,83 +121207,87 @@ "field" ] }, - "MeasurementUnits": { + "Price": { "type": "object", - "description": "Configuration of the measurement system", + "description": "Price object", "properties": { - "system": { + "currencyId": { "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + "pattern": "^[0-9a-f]{32}$" }, - "units": { + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" + }, + "listPrice": { + "description": "", "type": "object", - "description": "Units used in the measurement system.", "properties": { - "length": { + "currencyId": { "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." + "pattern": "^[0-9a-f]{32}$" }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } - } - } - } - }, - "businessEventsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Unique name of the businessEventsResponse." }, - "class": { - "type": "string", - "description": "Class name of business event." - }, - "data": { - "type": "object", - "description": "Internal field." - }, - "aware": { - "type": "array", - "description": "Parameter that indicates the areas in which the business event is supported.", - "items": { - "type": "string" + "required": [ + "gross", + "net", + "linked" + ] + }, + "regulationPrice": { + "description": "", + "type": "object", + "properties": { + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "gross": { + "description": "", + "type": "number" + }, + "net": { + "description": "", + "type": "number" + }, + "linked": { + "description": "", + "type": "boolean" } }, - "extensions": { - "type": "array", - "description": "Internal field.", - "items": { - "type": "string" - } - } + "required": [ + "gross", + "net", + "linked" + ] } - } + }, + "required": [ + "currencyId", + "gross", + "net", + "linked" + ] }, "ConsentState": { "type": "object", From 1921a02d337f2c024fe844a0037013b8ec8fff7b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 09:32:10 +0200 Subject: [PATCH 58/63] [create-pull-request] automated change (#479) Co-authored-by: shopwareBot --- adminapi.json | 4571 +++++++++++++++++++++++------------------ adminapi.summary.json | 10 + 2 files changed, 2602 insertions(+), 1979 deletions(-) diff --git a/adminapi.json b/adminapi.json index 99c839f..5c70bb4 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.8.2" + "version": "6.7.9.0" }, "servers": [ { @@ -74132,85 +74132,26 @@ } } }, - "/_action/number-range/reserve/{type}/{saleschannel}": { - "get": { - "tags": [ - "Document Management" - ], - "summary": "Reserve or preview a number-range / document number.", - "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", - "operationId": "numberRangeReserve", - "parameters": [ - { - "name": "type", - "in": "path", - "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "saleschannel", - "in": "path", - "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "preview", - "in": "query", - "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", - "required": false, - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "The generated number", - "content": { - "application/json": { - "schema": { - "properties": { - "number": { - "description": "The generated (or previewed) document number.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, - "400": { - "description": "Number range not found" - } - } - } - }, - "/_action/index": { + "/_action/validation/email": { "post": { "tags": [ - "System Operations" + "Email support validation" ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "index", + "summary": "Email support.", + "description": "Checks a given email string.", + "operationId": "supportsEmail", "requestBody": { + "required": true, "content": { "application/json": { "schema": { + "required": [ + "email" + ], "properties": { - "skip": { - "description": "Array of indexers/updaters to be skipped.", - "type": "array", - "items": { - "type": "string" - } + "email": { + "description": "The email to be verified.", + "type": "string" } }, "type": "object" @@ -74220,144 +74161,56 @@ }, "responses": { "204": { - "description": "Returns a no content response indicating that the indexing progress startet." - } - } - } - }, - "/_action/order_transaction/{orderTransactionId}/state/{transition}": { - "post": { - "tags": [ - "Order Management" - ], - "summary": "Transition an order transaction to a new state", - "description": "Changes the order transaction state and informs the customer via email if configured.", - "operationId": "orderTransactionStateTransition", - "parameters": [ - { - "name": "orderTransactionId", - "in": "path", - "description": "Identifier of the order transaction.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } + "description": "Email is supported" }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": false, - "content": { - "application/json": { - "schema": { - "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", + "content": { + "application/json": { + "schema": { + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" } }, - "stateFieldName": { - "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - }, - "internalComment": { - "description": "An optional internal comment that will be saved with the state transition.", - "type": "string" - } + "type": "object" }, - "type": "object" + "example": { + "errors": [ + { + "code": "0", + "status": "400", + "title": "Unprocessable Content", + "detail": "This value should not be blank." + } + ] + } } } - } - }, - "responses": { - "200": { - "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" - } - } - } - }, - "/_action/cache": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear caches", - "description": "The cache is immediately cleared synchronously for all used adapters.", - "operationId": "clearCache", - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_action/cache-delayed": { - "delete": { - "tags": [ - "System Operations" - ], - "summary": "Clear all invalidated caches", - "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", - "operationId": "clearCacheDelayed", - "parameters": [ - { - "name": "refreshOpenSearch", - "in": "query", - "required": false, - "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", - "schema": { - "type": "boolean", - "default": false - } - } - ], - "responses": { - "204": { - "description": "Returns a no content response indicating that the cache has been cleared." - } - } - } - }, - "/_info/flow-actions.json": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get actions for flow builder", - "description": "Get a list of action for flow builder.", - "operationId": "flow-actions", - "responses": { - "200": { - "description": "Returns a list of action for flow builder.", + }, + "422": { + "description": "Email address is not supported.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/flowBuilderActionsResponse" + "properties": { + "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." + } + ] } } } @@ -74365,92 +74218,107 @@ } } }, - "/_action/index-products": { - "post": { - "tags": [ - "System Operations" - ], - "summary": "Send product indexing message", - "description": "Dispatches a product indexing message to the message bus, with the provided ids", - "operationId": "productIndexing", - "responses": { - "204": { - "description": "Returns an empty response indicating that the message dispatched." - } - } - } - }, - "/_info/queue.json": { + "/_info/config": { "get": { "tags": [ "System Info & Health Check" ], - "summary": "Get message queue statistics (deprecated)", - "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", - "operationId": "queue", - "deprecated": true, + "summary": "Get public runtime config & feature metadata", + "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", + "operationId": "config", "responses": { "200": { - "description": "Message queue statistics returned.", + "description": "Public runtime configuration & feature metadata returned.", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Fully qualified class name of the message." - }, - "size": { - "type": "integer", - "description": "Number of pending messages of this type." - } - }, - "required": [ - "name", - "size" - ] - } + "$ref": "#/components/schemas/infoConfigResponse" }, - "example": [ - { - "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", - "size": 150 + "example": { + "version": "6.7.2.0", + "shopId": "NoiU8PfJtu7NBY8M", + "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", + "adminWorker": { + "enableAdminWorker": true, + "enableNotificationWorker": true, + "transports": [ + "async", + "low_priority" + ] }, - { - "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", - "size": 25 - } - ] - } - } - } - } - } - }, - "/_info/version": { - "get": { - "tags": [ - "System Info & Health Check" - ], - "summary": "Get the Shopware version", - "description": "Get the version of the Shopware instance", - "operationId": "infoShopwareVersion", - "responses": { - "200": { - "description": "Returns the version of the Shopware instance.", - "content": { - "application/json": { - "schema": { - "properties": { - "version": { - "description": "The Shopware version.", - "type": "string" + "bundles": { + "Administration": { + "css": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" + ], + "js": [ + "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" + ], + "baseUrl": null, + "type": "plugin" + }, + "Storefront": { + "css": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" + ], + "js": [ + "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" + ], + "baseUrl": null, + "type": "plugin" } }, - "type": "object" + "settings": { + "enableUrlFeature": true, + "appUrlReachable": true, + "appsRequireAppUrl": false, + "firstMigrationDate": "2025-01-01T12:00:00.000Z", + "private_allowed_extensions": [ + "jpg", + "jpeg", + "png", + "webp", + "avif", + "gif", + "svg", + "bmp", + "tiff", + "tif", + "eps", + "webm", + "mkv", + "flv", + "ogv", + "ogg", + "mov", + "mp4", + "avi", + "wmv", + "pdf", + "aac", + "mp3", + "wav", + "flac", + "oga", + "wma", + "txt", + "doc", + "docx", + "ico", + "glb", + "zip", + "rar", + "csv", + "xls", + "xlsx", + "html", + "xml" + ], + "enableHtmlSanitizer": true, + "enableStagingMode": false, + "disableExtensionManagement": false + }, + "inAppPurchases": [] } } } @@ -74458,141 +74326,143 @@ } } }, - "/_action/order/document/download": { - "post": { + "/app-system/privileges/requested": { + "get": { "tags": [ - "Document Management" + "App System" ], - "summary": "Download a documents", - "description": "Download a multiple documents in one pdf file.", - "operationId": "downloadDocuments", - "requestBody": { - "description": "documentIds", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - } - } + "summary": "Get requested privileges for all apps", + "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", + "operationId": "getRequestedPrivileges", + "security": [ + { + "oAuth": [ + "admin" + ] } - }, + ], "responses": { "200": { - "description": "The documents.", + "description": "A JSON object containing requested privileges.", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "properties": { + "privileges": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "example": { + "privileges": { + "SwagAnalytics": [ + "customer:read", + "order:read" + ], + "SwagExample": [ + "product:write" + ] + } } } } + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." } } } }, - "/_action/order/document/{documentTypeName}/create": { - "post": { + "/app-system/{appName}/privileges/accepted": { + "get": { "tags": [ - "Document Management" + "App System" ], - "summary": "Create documents for orders", - "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", - "operationId": "createDocuments", + "summary": "Get accepted privileges for an app", + "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", + "operationId": "getAcceptedPrivileges", "parameters": [ { - "name": "documentTypeName", + "name": "appName", "in": "path", - "description": "The type of document to create", "required": true, "schema": { "type": "string" } } ], - "requestBody": { - "description": "test", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { + "security": [ + { + "oAuth": [ + "admin" + ] + } + ], + "responses": { + "200": { + "description": "A JSON object containing accepted privileges.", + "content": { + "application/json": { + "schema": { "type": "object", - "required": [ - "orderId", - "type" - ], "properties": { - "orderId": { - "description": "Identifier of the order.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "type": { - "description": "Type of the document to be generated.", - "type": "string" - }, - "fileType": { - "description": "Type of document file to be generated.", - "type": "string", - "default": "pdf" - }, - "static": { - "description": "Indicate if the document should be static or not.", - "type": "boolean", - "default": false - }, - "referencedDocumentId": { - "description": "Identifier of the reverenced document.", - "type": "string", - "default": "null", - "pattern": "^[0-9a-f]{32}$" - }, - "config": { - "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", - "type": "object" + "privileges": { + "type": "object", + "additionalProperties": { + "type": "boolean" + } } } + }, + "example": { + "privileges": { + "customer:read": true, + "order:read": true + } } } } - } - }, - "responses": { - "200": { - "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." } } } }, - "/_action/order/{orderId}/state/{transition}": { - "post": { + "/app-system/{appName}/privileges": { + "patch": { "tags": [ - "Order Management" + "App System" ], - "summary": "Transition an order to a new state", - "description": "Changes the order state and informs the customer via email if configured.", - "operationId": "orderStateTransition", + "summary": "Accept or revoke privileges for an app", + "description": "Accepts or revokes specified privileges for the given app.", + "operationId": "managePrivileges", "parameters": [ { - "name": "orderId", - "in": "path", - "description": "Identifier of the order.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - { - "name": "transition", + "name": "appName", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -74600,113 +74470,194 @@ } ], "requestBody": { - "required": false, + "required": true, "content": { "application/json": { "schema": { + "type": "object", "properties": { - "sendMail": { - "description": "Controls if a mail should be sent to the customer." - }, - "documentIds": { - "description": "A list of document identifiers that should be attached", + "accept": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, - "mediaIds": { - "description": "A list of media identifiers that should be attached", + "revoke": { "type": "array", "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } - }, - "stateFieldName": { - "description": "This is the state column within the order database table. There should be no need to change it from the default.", - "type": "string", - "default": "stateId" - }, - "internalComment": { - "description": "An optional internal comment that will be saved with the state transition.", - "type": "string" } - }, - "type": "object" + } + }, + "example": { + "accept": [ + "customer:read", + "order:read" + ], + "revoke": [ + "product:write" + ] } } } }, "responses": { - "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "204": { + "description": "Returns no content if privileges were managed successfully." + }, + "400": { + "description": "Malformed request." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." } - } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] } }, - "/_action/container_cache": { - "delete": { + "/_action/app-system/secret/rotate": { + "post": { "tags": [ - "System Operations" + "App System" ], - "summary": "Clear container caches", - "description": "The container cache is immediately cleared synchronously.", - "operationId": "clearContainerCache", + "summary": "Initiate secret rotation for the calling app", + "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", + "operationId": "appSecretRotation", "responses": { - "204": { - "description": "Returns a no content response indicating that the container cache is cleared." + "202": { + "description": "Returns \"Accepted\" when secret rotation was scheduled." + }, + "400": { + "description": "Malformed request, e.g. when requested with non app integration source." + }, + "401": { + "description": "Unauthorized Access." + }, + "403": { + "description": "Forbidden. Not a valid integration source." + }, + "404": { + "description": "App not found." } - } + }, + "security": [ + { + "oAuth": [ + "admin" + ] + } + ] } }, - "/_action/document/{documentId}/{deepLinkCode}": { + "/app-system/shop/verify": { "get": { "tags": [ - "Document Management" + "App System", + "Public" ], - "summary": "Download a document", - "description": "Download a document by its identifier and deep link code.", - "operationId": "downloadDocument", + "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": "documentId", - "in": "path", - "description": "Identifier of the document to be downloaded.", + "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": "deepLinkCode", - "in": "path", - "description": "A unique hash code which was generated when the document was created.", + "name": "token", + "in": "query", + "description": "A unique identifier", "required": true, "schema": { "type": "string" } + } + ], + "responses": { + "204": { + "description": "An empty response signalling successful verification." }, - { - "name": "download", - "in": "query", - "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", - "schema": { - "type": "boolean", - "default": false - } + "400": { + "description": "Malformed request or unsuccessful verification." } + } + } + }, + "/_info/message-stats.json": { + "get": { + "summary": "Get statistics message queue", + "description": "Get statistics for recently processed messages in the message queue", + "operationId": "getMessageStats", + "tags": [ + "System Info & Health Check" ], "responses": { "200": { - "description": "The document.", + "description": "Statistics received", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "type": "object", + "required": [ + "enabled" + ], + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether message queue statistics are enabled in configuration" + }, + "stats": { + "type": [ + "object", + "null" + ], + "properties": { + "totalMessagesProcessed": { + "type": "integer" + }, + "processedSince": { + "type": "string", + "format": "date-time" + }, + "averageTimeInQueue": { + "type": "number", + "format": "float" + }, + "messageTypeStats": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "count": { + "type": "integer" + } + } + } + } + } + } + } } } } @@ -74714,379 +74665,455 @@ } } }, - "/_action/document/{documentId}/upload": { - "post": { + "/_action/system-config": { + "get": { "tags": [ - "Document Management" + "System Config" ], - "summary": "Upload a file for a document", - "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", - "operationId": "uploadToDocument", + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", "parameters": [ { - "name": "documentId", - "in": "path", - "description": "Identifier of the document the new file should be added to.", + "name": "domain", + "in": "query", + "description": "The configuration domain.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "fileName", + "name": "salesChannelId", "in": "query", - "description": "Name of the uploaded file.", - "required": true, + "description": "The sales channel ID to scope the configuration to.", "schema": { "type": "string" } }, { - "name": "extension", + "name": "inherit", "in": "query", - "description": "Extension of the uploaded file. For example `pdf`", - "required": true, + "description": "Whether to include inherited (global) values.", "schema": { - "type": "string" + "type": "boolean", + "default": false } } ], - "requestBody": { - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - }, - "application/json": { - "schema": { - "required": [ - "url" - ], - "properties": { - "url": { - "description": "The url of the document that will be downloaded.", - "type": "string" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "Document uploaded successful", - "content": { - "application/json": { - "schema": { - "properties": { - "documentId": { - "description": "Identifier of the document.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "documentDeepLink": { - "description": "A unique hash code which is required to open the document.", - "type": "string" - } - }, - "type": "object" - } + "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": "Key-value pairs of configuration values to save.", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true } } } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } } } }, - "/_action/indexing": { - "post": { + "/_action/system-config/check": { + "get": { "tags": [ - "System Operations" + "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" + } + } ], - "summary": "Run indexer", - "description": "Runs all registered indexer in the shop asynchronously.", - "operationId": "indexing", "responses": { "200": { - "description": "Returns an empty response indicating that the indexing process started." + "description": "Returns whether the configuration domain exists." } } } }, - "/_action/indexing/{indexer}": { - "post": { + "/_action/system-config/schema": { + "get": { "tags": [ - "System Operations" + "System Config" ], - "summary": "Iterate an indexer", - "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", - "operationId": "iterate", + "summary": "Get configuration schema", + "description": "Returns the configuration schema for the given domain.", + "operationId": "getConfiguration", "parameters": [ { - "name": "indexer", - "in": "path", - "description": "Name of the indexer to iterate.", + "name": "domain", + "in": "query", + "description": "The configuration domain.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "offset": { - "description": "The offset for the iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } - }, "responses": { "200": { - "description": "Returns information about the iteration.", - "content": { - "application/json": { - "schema": { - "properties": { - "finish": { - "description": "Indicates if the indexing process finished.", - "type": "boolean" - }, - "offset": { - "description": "Offset to be used for the next iteration.", - "type": "integer" - } - }, - "type": "object" - } - } - } + "description": "Returns the configuration schema." } } } }, - "/_action/order_transaction_capture_refund/{refundId}": { + "/_action/system-config/batch": { "post": { "tags": [ - "Order Management" + "System Config" ], - "summary": "Refund an order transaction capture", - "description": "Refunds an order transaction capture.", - "operationId": "orderTransactionCaptureRefund", + "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": "refundId", - "in": "path", - "description": "Identifier of the order transaction capture refund.", - "required": true, + "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": "string", - "pattern": "^[0-9a-f]{32}$" + "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", + "additionalProperties": true + } + } + } + } + }, "responses": { "204": { - "description": "Refund was successful" - }, - "400": { - "description": "Something went wrong, while processing the refund" - }, - "404": { - "description": "Refund with id not found" + "description": "Configuration saved successfully." } } } }, - "/_action/cache_info": { - "get": { + "/_action/mail-template/send": { + "post": { "tags": [ - "System Operations" + "Mail Operations" ], - "summary": "Get cache information", - "description": "Get information about the cache configuration", - "operationId": "info", - "responses": { - "200": { - "description": "Information about the cache state.", - "content": { - "application/json": { - "schema": { - "properties": { - "environment": { - "description": "The active environment.", + "summary": "Send a mail", + "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", + "operationId": "send", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "recipients", + "salesChannelId", + "contentHtml", + "contentPlain", + "subject", + "senderName" + ], + "properties": { + "recipients": { + "description": "A list of recipients with name and mail address.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", "type": "string" + } + }, + "salesChannelId": { + "description": "Identifier of the sales channel from which the mail should be send.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" + }, + "subject": { + "description": "Subject of the mail.", + "type": "string" + }, + "senderName": { + "description": "Name of the sender.", + "type": "string" + }, + "senderEmail": { + "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", + "type": "string" + }, + "mediaIds": { + "description": "List of media identifiers which should be attached to the mail.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "binAttachments": { + "description": "A list of binary attachments which should be added to the mail.", + "required": [ + "content", + "fileName", + "mimeType" + ], + "type": "array", + "items": { + "properties": { + "content": { + "description": "Binary content of the attachment.", + "type": "string" + }, + "fileName": { + "description": "File name of the attachment.", + "type": "string" + }, + "mimeType": { + "description": "Mime type of the attachment.", + "type": "string" + } + }, + "type": "object" + } + }, + "recipientsBcc": { + "description": "A list of recipients with name and mail address to be set in BCC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" }, - "httpCache": { - "description": "State of the HTTP cache.", - "type": "boolean" + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "recipientsCc": { + "description": "A list of recipients with name and mail address to be set in CC.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" }, - "cacheAdapter": { - "description": "The active cache adapter.", + "additionalProperties": { + "description": "Name of the recipient.", "type": "string" } }, - "type": "object" - } + "replyTo": { + "description": "A list of mail addresses with name and mail address to be set in reply to.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + }, + "returnPath": { + "description": "A list of mail addresses with name and mail address to be set in return path.", + "type": "object", + "example": { + "test1@example.com": "Test user 1", + "test2@example.com": "Test user 2" + }, + "additionalProperties": { + "description": "Name of the recipient.", + "type": "string" + } + } + }, + "type": "object" } } } - } - } - }, - "/consents": { - "get": { - "tags": [ - "Consent Management", - "Experimental" - ], - "summary": "List all consents for current user", - "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "fetchConsents", + }, "responses": { "200": { - "description": "List of consents with their status", + "description": "The mail was sent successful", "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ConsentState" - }, - "example": { - "product_analytics": { - "name": "product_analytics", - "scopeName": "admin_user", - "identifier": "userId-12345", - "status": "accepted", - "actor": "userId-12345", - "updatedAt": "2024-01-15T10:20:30Z" - }, - "backend_data": { - "name": "backend_data", - "scopeName": "system", - "identifier": "system", - "status": "requested", - "actor": null, - "updatedAt": null + "properties": { + "size": { + "description": "Length of the email message", + "type": "integer" } - } + }, + "type": "object" } } } - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/consents/accept": { + "/_action/mail-template/validate": { "post": { "tags": [ - "Consent Management", - "Experimental" + "Mail Operations" ], - "summary": "Accept a consent", - "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "acceptConsent", + "summary": "Validate a mail content", + "description": "Validates if content for a mail can be rendered without sending an email.", + "operationId": "validate", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "contentHtml", + "contentPlain" + ], "properties": { - "consent": { - "type": "string", - "description": "The name of the consent to accept" + "contentHtml": { + "description": "The content of the mail in HTML format.", + "type": "string" + }, + "contentPlain": { + "description": "The content of the mail as plain text.", + "type": "string" } }, - "required": [ - "consent" - ], - "example": { - "consent": "product_analytics" - } + "type": "object" } } } }, "responses": { - "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ConsentState" - } - } - } - }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" + "204": { + "description": "Returns a no content response indicating the mail content was rendered successfully." } } } }, - "/consents/revoke": { + "/_action/mail-template/build": { "post": { "tags": [ - "Consent Management", - "Experimental" + "Mail Operations" ], - "summary": "Revoke a consent", - "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", - "operationId": "revokeConsent", + "summary": "Preview a mail template", + "description": "Generates a preview of a mail template.", + "operationId": "build", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "type": "object", + "required": [ + "mailTemplateType", + "mailTemplate" + ], "properties": { - "consent": { - "type": "string", - "description": "The name of the consent to accept" + "mailTemplateType": { + "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", + "properties": { + "templateData": { + "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "type": "object", + "example": { + "order": { + "orderNumber": 5000, + "customerName": "Example Customer" + }, + "messageOfTheDay": "An apple a day keeps the doctor away!" + }, + "additionalProperties": true + } + }, + "type": "object" + }, + "mailTemplate": { + "description": "The content of the mail as plain text.", + "properties": { + "contentHtml": { + "description": "The content of mail mail template in html format.", + "type": "string", + "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + } + }, + "type": "object" } }, - "required": [ - "consent" - ], - "example": { - "consent": "product_analytics" - } + "type": "object" } } } }, "responses": { "200": { - "description": "Consent status changed successfully. Returns the updated consent status.", + "description": "The rendered preview of the mail template.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ConsentState" + "type": "string" } } } - }, - "404": { - "description": "Bad request - Consent not found or consent property was empty" - }, - "401": { - "description": "Unauthorized - User not logged in or invalid session" } } } @@ -75106,8 +75133,7 @@ "description": "Identifier of the media entity.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/MediaId" } }, { @@ -75357,33 +75383,150 @@ "deduplicate": { "type": "boolean", "description": "Whether to deduplicate based on path" + }, + "thumbnails": { + "type": "array", + "description": "Optional list of external thumbnail URLs for the media entity. Used 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.", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } + } + }, + "required": [ + "url", + "mimeType" + ] + } + } + } + }, + "responses": { + "200": { + "description": "External media link created successfully", + "content": { + "application\\/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the created media entity" + } + } + } + } + } + } + } + } + }, + "/_action/media/{mediaId}/external-thumbnails": { + "post": { + "tags": [ + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "thumbnails": { + "type": "array", + "description": "List of external thumbnails to attach", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Thumbnails attached successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" + }, + "thumbnailsCreated": { + "type": "integer" + } } - }, - "required": [ - "url", - "mimeType" - ] + } } } + }, + "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": "External media link created successfully", + "description": "Thumbnails deleted successfully", "content": { - "application\\/json": { + "application/json": { "schema": { "type": "object", "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "ID of the created media entity" + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" } } } } } + }, + "400": { + "description": "Media is not an external media entity or path is missing" + }, + "404": { + "description": "Media entity not found" } } } @@ -75403,8 +75546,7 @@ "required": true, "description": "ID of the video media entity", "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "$ref": "#/components/schemas/MediaId" } } ], @@ -75437,19 +75579,34 @@ } } }, - "/_action/order/{orderId}/order-address": { + "/_action/indexing": { "post": { "tags": [ - "Order address" + "System Operations" ], - "summary": "Update order addresses", - "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", - "operationId": "updateOrderAddresses", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "indexing", + "responses": { + "200": { + "description": "Returns an empty response indicating that the indexing process started." + } + } + } + }, + "/_action/indexing/{indexer}": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Iterate an indexer", + "description": "Starts a defined indexer with an offset.\n\nfor the next request. `finish: true` in the response indicates that the indexer is finished", + "operationId": "iterate", "parameters": [ { - "name": "orderId", + "name": "indexer", "in": "path", - "description": "Identifier of the order.", + "description": "Name of the indexer to iterate.", "required": true, "schema": { "type": "string", @@ -75461,190 +75618,480 @@ "content": { "application/json": { "schema": { - "type": "object", "properties": { - "mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "customerAddressId": { - "type": "string", - "description": "The ID of the customer address" - }, - "type": { - "type": "string", - "description": "The type of the address" - }, - "deliveryId": { - "description": "The ID of the delivery (optional)", - "oneOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] - } - }, - "required": [ - "customerAddressId", - "type" - ] - }, - "description": "The mapping of order addresses" + "offset": { + "description": "The offset for the iteration.", + "type": "integer" } - } + }, + "type": "object" } } - }, - "required": true + } }, "responses": { - "204": { - "description": "Returns a no content response indicating that the update has been made." + "200": { + "description": "Returns information about the iteration.", + "content": { + "application/json": { + "schema": { + "properties": { + "finish": { + "description": "Indicates if the indexing process finished.", + "type": "boolean" + }, + "offset": { + "description": "Offset to be used for the next iteration.", + "type": "integer" + } + }, + "type": "object" + } + } + } } } } }, - "/app-system/privileges/requested": { + "/_action/state-machine/{entityName}/{entityId}/state": { "get": { "tags": [ - "App System" + "State Machine" ], - "summary": "Get requested privileges for all apps", - "description": "Returns the list of requested privileges for all apps. Requires admin scope and `acl_role:read` permission to read.", - "operationId": "getRequestedPrivileges", - "security": [ + "summary": "Get available transitions for an entity", + "description": "Retrieves the available state transitions for the specified entity.", + "operationId": "getEntityState", + "parameters": [ { - "oAuth": [ - "admin" - ] + "name": "entityName", + "in": "path", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } } ], "responses": { "200": { - "description": "A JSON object containing requested privileges.", + "description": "Available transitions for the current state.", "content": { "application/json": { "schema": { "type": "object", "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } + "transitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the transition." + }, + "technicalName": { + "type": "string", + "description": "The technical name of the transition." + }, + "actionName": { + "type": "string", + "description": "The action name of the transition." + }, + "fromStateName": { + "type": "string", + "description": "The technical name of the state the transition starts from." + }, + "toStateName": { + "type": "string", + "description": "The technical name of the state the transition goes to." + }, + "url": { + "type": "string", + "description": "The URL to trigger the transition." + } + }, + "required": [ + "name", + "technicalName", + "actionName", + "fromStateName", + "toStateName", + "url" + ] } } - } - }, - "example": { - "privileges": { - "SwagAnalytics": [ - "customer:read", - "order:read" - ], - "SwagExample": [ - "product:write" - ] - } + }, + "required": [ + "transitions" + ] } } } }, "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." + "description": "Unable to read the entity or entity field." }, "403": { - "description": "Forbidden. Not a valid integration source." + "description": "Forbidden. Missing privileges to access the entity." } } } }, - "/app-system/{appName}/privileges/accepted": { - "get": { + "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { + "post": { "tags": [ - "App System" + "State Machine" ], - "summary": "Get accepted privileges for an app", - "description": "Returns the list of accepted privileges for the current integration. Requires admin scope with an integration.", - "operationId": "getAcceptedPrivileges", + "summary": "Transition an entity to a new state", + "description": "Changes the entity state by applying the given transition.", + "operationId": "transitionEntityState", "parameters": [ { - "name": "appName", + "name": "entityName", + "in": "path", + "description": "Name of the entity.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "entityId", + "in": "path", + "description": "Identifier of the entity.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", "in": "path", + "description": "The `action_name` of the `state_machine_transition`.", "required": true, "schema": { "type": "string" } + }, + { + "name": "stateFieldName", + "in": "query", + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "required": false, + "schema": { + "type": "string", + "default": "stateId" + } } ], - "security": [ - { - "oAuth": [ - "admin" - ] + "requestBody": { + "description": "Optional internal comment for the state transition.", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "internalComment": { + "type": "string", + "description": "An optional internal comment that will be saved with the state transition." + } + } + } + } + } + }, + "responses": { + "200": { + "description": "State transition applied successfully." + }, + "400": { + "description": "Unable to read the entity or entity field, or invalid transition." + }, + "403": { + "description": "Forbidden. Missing privileges to access the entity." } + } + } + }, + "/_action/message-queue/consume": { + "post": { + "tags": [ + "System Operations" ], + "summary": "Consume messages from the message queue.", + "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", + "operationId": "consumeMessages", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "receiver" + ], + "properties": { + "receiver": { + "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", + "type": "string" + } + }, + "type": "object" + } + } + } + }, "responses": { "200": { - "description": "A JSON object containing accepted privileges.", + "description": "Returns information about handled messages", "content": { "application/json": { "schema": { + "properties": { + "handledMessages": { + "description": "The number of messages processed.", + "type": "integer" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Transition an order delivery to a new state", + "description": "Changes the order delivery state and informs the customer via email if configured.", + "operationId": "orderDeliveryStateTransition", + "parameters": [ + { + "name": "orderDeliveryId", + "in": "path", + "description": "Identifier of the order delivery.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": false, + "content": { + "application/json": { + "schema": { + "properties": { + "sendMail": { + "description": "Controls if a mail should be send to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "mediaIds": { + "description": "A list of media identifiers that should be attached", + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "stateFieldName": { + "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + }, + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" + } + } + } + }, + "/_action/order/document/download": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Download a documents", + "description": "Download a multiple documents in one pdf file.", + "operationId": "downloadDocuments", + "requestBody": { + "description": "documentIds", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + } + } + }, + "responses": { + "200": { + "description": "The documents.", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/order/document/{documentTypeName}/create": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Create documents for orders", + "description": "Creates documents for orders. Documents can for example be an invoice or a delivery note.", + "operationId": "createDocuments", + "parameters": [ + { + "name": "documentTypeName", + "in": "path", + "description": "The type of document to create", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "test", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "type": "object", + "required": [ + "orderId", + "type" + ], "properties": { - "privileges": { - "type": "object", - "additionalProperties": { - "type": "boolean" - } + "orderId": { + "description": "Identifier of the order.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "type": { + "description": "Type of the document to be generated.", + "type": "string" + }, + "fileType": { + "description": "Type of document file to be generated.", + "type": "string", + "default": "pdf" + }, + "static": { + "description": "Indicate if the document should be static or not.", + "type": "boolean", + "default": false + }, + "referencedDocumentId": { + "description": "Identifier of the reverenced document.", + "type": "string", + "default": "null", + "pattern": "^[0-9a-f]{32}$" + }, + "config": { + "description": "Document specific configuration, like documentNumber, documentDate, documentComment.", + "type": "object" } } - }, - "example": { - "privileges": { - "customer:read": true, - "order:read": true - } } } } - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." + } + }, + "responses": { + "200": { + "description": "Documents created successfully. The `api/_action/order/document/create` route can be used to download the document." } } } }, - "/app-system/{appName}/privileges": { - "patch": { + "/_action/order/{orderId}/state/{transition}": { + "post": { "tags": [ - "App System" + "Order Management" ], - "summary": "Accept or revoke privileges for an app", - "description": "Accepts or revokes specified privileges for the given app.", - "operationId": "managePrivileges", + "summary": "Transition an order to a new state", + "description": "Changes the order state and informs the customer via email if configured.", + "operationId": "orderStateTransition", "parameters": [ { - "name": "appName", + "name": "orderId", "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "transition", + "in": "path", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -75652,96 +76099,50 @@ } ], "requestBody": { - "required": true, + "required": false, "content": { "application/json": { "schema": { - "type": "object", "properties": { - "accept": { + "sendMail": { + "description": "Controls if a mail should be sent to the customer." + }, + "documentIds": { + "description": "A list of document identifiers that should be attached", "type": "array", "items": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } }, - "revoke": { + "mediaIds": { + "description": "A list of media identifiers that should be attached", "type": "array", "items": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" } + }, + "stateFieldName": { + "description": "This is the state column within the order database table. There should be no need to change it from the default.", + "type": "string", + "default": "stateId" + }, + "internalComment": { + "description": "An optional internal comment that will be saved with the state transition.", + "type": "string" } - } - }, - "example": { - "accept": [ - "customer:read", - "order:read" - ], - "revoke": [ - "product:write" - ] + }, + "type": "object" } } } }, "responses": { - "204": { - "description": "Returns no content if privileges were managed successfully." - }, - "400": { - "description": "Malformed request." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] - } - ] - } - }, - "/_action/app-system/secret/rotate": { - "post": { - "tags": [ - "App System" - ], - "summary": "Initiate secret rotation for the calling app", - "description": "Initiates an app secret rotation for the calling app. Needs to be called with an integration token belonging to an app. Note that the secret rotation will only be scheduled and then handled asynchronously.", - "operationId": "appSecretRotation", - "responses": { - "202": { - "description": "Returns \"Accepted\" when secret rotation was scheduled." - }, - "400": { - "description": "Malformed request, e.g. when requested with non app integration source." - }, - "401": { - "description": "Unauthorized Access." - }, - "403": { - "description": "Forbidden. Not a valid integration source." - }, - "404": { - "description": "App not found." - } - }, - "security": [ - { - "oAuth": [ - "admin" - ] + "200": { + "description": "Todo: Use ref of `state_machine_transition` here" } - ] + } } }, "/_action/sync": { @@ -75863,295 +76264,246 @@ } } }, - "/oauth/sso/config": { - "get": { + "/_action/order/{orderId}/order-address": { + "post": { "tags": [ - "Authorization & Authentication", - "SSO Login configuration" + "Order address" ], - "summary": "Loads configuration for the admin login", - "description": "Loads the configuration for the admin login. This configuration is used to load and configure the default or Single Sign On (SSO) login for the admin.", - "operationId": "loadSsoLoginConfig", - "responses": { - "200": { - "description": "Config loaded successfully.", - "content": { - "application/json": { - "schema": { - "properties": { - "useDefault": { - "description": "Experimental: Indicates which login is used. Default or SSO.", - "type": "boolean" - }, - "url": { - "description": "Experimental: Contains the return url for the Shopware SSO login.", - "type": "string" - } - }, - "type": "object" - } - } + "summary": "Update order addresses", + "description": "Endpoint which takes a list of mapping objects as payload and updates the order addresses accordingly", + "operationId": "updateOrderAddresses", + "parameters": [ + { + "name": "orderId", + "in": "path", + "description": "Identifier of the order.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" } } - } - } - }, - "/oauth/sso/code": { - "get": { - "tags": [ - "Authorization & Authentication", - "SSO Login callback" ], - "summary": "Callback function. Fetch an authorization code", - "description": "Fetch an authorization code log in the user.", - "operationId": "callBackWithCode", - "responses": { - "302": { - "description": "Experimental: Forwards to the Shopware admin" - }, - "200": { - "description": "Authorisation process continues", - "content": { - "application/json": { - "schema": { - "type": "object" + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mapping": { + "type": "array", + "items": { + "type": "object", + "properties": { + "customerAddressId": { + "type": "string", + "description": "The ID of the customer address" + }, + "type": { + "type": "string", + "description": "The type of the address" + }, + "deliveryId": { + "description": "The ID of the delivery (optional)", + "oneOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "required": [ + "customerAddressId", + "type" + ] + }, + "description": "The mapping of order addresses" + } } } } - } - } - } - }, - "/oauth/sso/auth": { - "get": { - "tags": [ - "Experimental", - "SSO Login forward" - ], - "summary": "Experimental: Redirect to SSO login", - "description": "Experimental: Creates a redirection to the SSO login page", - "operationId": "ssoAuth", + }, + "required": true + }, "responses": { - "302": { - "description": "Experimental: Forwards to SSO login Page" + "204": { + "description": "Returns a no content response indicating that the update has been made." } } } }, - "/_info/is-sso": { - "get": { + "/_action/user/logout": { + "post": { "tags": [ - "Experimental", - "Is SSO environment" + "Authorization & Authentication" ], - "summary": "Experimental: Is SSO environment", - "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", - "operationId": "isSso", + "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": "Experimental: Returns if it is a SSO environment or not" + "204": { + "description": "Tokens have been revoked successfully." + }, + "401": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." } } } }, - "/_action/sso/invite-user": { + "/oauth/token": { "post": { "tags": [ - "Experimental", - "Invite a new SSO user" + "Authorization & Authentication" ], - "summary": "Experimental: Invite a new SSO user", - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", - "operationId": "inviteUser", - "responses": { - "200": { - "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" + "summary": "Fetch an access token", + "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", + "operationId": "token", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/OAuthPasswordGrant" + }, + { + "$ref": "#/components/schemas/OAuthRefreshTokenGrant" + }, + { + "$ref": "#/components/schemas/OAuthClientCredentialsGrant" + } + ] + } + } } - } - } - }, - "/_info/message-stats.json": { - "get": { - "summary": "Get statistics message queue", - "description": "Get statistics for recently processed messages in the message queue", - "operationId": "getMessageStats", - "tags": [ - "System Info & Health Check" - ], + }, "responses": { "200": { - "description": "Statistics received", + "description": "Authorized successfully.", "content": { "application/json": { "schema": { - "type": "object", "required": [ - "enabled" + "token_type", + "expires_in", + "access_token" ], "properties": { - "enabled": { - "type": "boolean", - "description": "Whether message queue statistics are enabled in configuration" + "token_type": { + "description": "Type of the token.", + "type": "string" }, - "stats": { - "type": [ - "object", - "null" - ], - "properties": { - "totalMessagesProcessed": { - "type": "integer" - }, - "processedSince": { - "type": "string", - "format": "date-time" - }, - "averageTimeInQueue": { - "type": "number", - "format": "float" - }, - "messageTypeStats": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "count": { - "type": "integer" - } - } - } - } - } + "expires_in": { + "description": "Token lifetime in seconds.", + "type": "integer" + }, + "access_token": { + "description": "The access token that can be used for subsequent requests", + "type": "string" + }, + "refresh_token": { + "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "type": "string" } - } + }, + "type": "object" } } } + }, + "400": { + "$ref": "#/components/responses/400" } } } }, - "/_info/events.json": { + "/oauth/sso/config": { "get": { "tags": [ - "System Info & Health Check" - ], - "summary": "Get Business events", - "description": "Get a list of about the business events.", - "operationId": "business-events", - "responses": { - "200": { - "description": "Returns a list of about the business events.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/businessEventsResponse" - } - } - } - } - } - } - }, - "/_action/scheduled-task/run": { - "post": { - "tags": [ - "System Operations" + "Experimental", + "SSO Login configuration" ], - "summary": "Run scheduled tasks.", - "description": "Starts the scheduled task worker to handle the next scheduled tasks.", - "operationId": "runScheduledTasks", + "summary": "Experimental: Loads SSO login configuration.", + "description": "Experimental: Loads the SSO login configuration to configure the forward to the Shopware SSO login page.", "responses": { "200": { - "description": "Returns a success message indicating a successful run.", + "description": "Experimental: Returns the configuration for the SSO login page forward.", "content": { "application/json": { "schema": { + "type": "object", "properties": { - "message": { - "description": "Success message", + "useDefault": { + "description": "Experimental: Indicates which login is used. Default or SSO.", + "type": "boolean" + }, + "url": { + "description": "Experimental: Contains the return url for the Shopware SSO login.", "type": "string" } - }, - "type": "object" + } } } } } - } + }, + "operationId": "loadSsoLoginConfig" } }, - "/_action/scheduled-task/min-run-interval": { + "/oauth/sso/code": { "get": { "tags": [ - "System Operations" + "Experimental", + "SSO Login callback" ], - "summary": "Get the minimum schedules task interval", - "description": "Fetches the smallest interval that a scheduled task uses.", - "operationId": "getMinRunInterval", + "summary": "Experimental: Callback for SSO login", + "description": "Experimental: Logs in the user into the Shopware shop and forwards to the admin", "responses": { "200": { - "description": "Returns the minimum interval.", + "description": "Authorisation process continues", "content": { "application/json": { "schema": { - "properties": { - "minRunInterval": { - "description": "Minimal interval in seconds.", - "type": "string" - } - }, "type": "object" } } } + }, + "302": { + "description": "Experimental: Forwards to the Shopware admin" } - } + }, + "operationId": "callBackWithCode" } }, - "/_info/routes": { - "get": { - "summary": "Get API routes", - "operationId": "getRoutes", + "/_action/scheduled-task/run": { + "post": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "responses": { - "200": { - "description": "Successful operation", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "endpoints" - ], - "properties": { - "endpoints": { - "type": "array", - "items": { - "type": "object", - "required": [ - "methods", - "path" - ], - "properties": { - "methods": { - "type": "array", - "items": { - "type": "string" - } - }, - "path": { - "type": "string" - } - } - } + "summary": "Run scheduled tasks.", + "description": "Starts the scheduled task worker to handle the next scheduled tasks.", + "operationId": "runScheduledTasks", + "responses": { + "200": { + "description": "Returns a success message indicating a successful run.", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "description": "Success message", + "type": "string" } - } + }, + "type": "object" } } } @@ -76159,60 +76511,23 @@ } } }, - "/oauth/token": { - "post": { + "/_action/scheduled-task/min-run-interval": { + "get": { "tags": [ - "Authorization & Authentication" + "System Operations" ], - "summary": "Fetch an access token", - "description": "Fetch a access token that can be used to perform authenticated requests. For more information take a look at the [Authentication documentation](https://shopware.stoplight.io/docs/admin-api/docs/concepts/authentication-authorisation.md).", - "operationId": "token", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "$ref": "#/components/schemas/OAuthPasswordGrant" - }, - { - "$ref": "#/components/schemas/OAuthRefreshTokenGrant" - }, - { - "$ref": "#/components/schemas/OAuthClientCredentialsGrant" - } - ] - } - } - } - }, + "summary": "Get the minimum schedules task interval", + "description": "Fetches the smallest interval that a scheduled task uses.", + "operationId": "getMinRunInterval", "responses": { "200": { - "description": "Authorized successfully.", + "description": "Returns the minimum interval.", "content": { "application/json": { "schema": { - "required": [ - "token_type", - "expires_in", - "access_token" - ], "properties": { - "token_type": { - "description": "Type of the token.", - "type": "string" - }, - "expires_in": { - "description": "Token lifetime in seconds.", - "type": "integer" - }, - "access_token": { - "description": "The access token that can be used for subsequent requests", - "type": "string" - }, - "refresh_token": { - "description": "The refresh token that can be used to refresh the access token. This field is not returned on grant type `refresh_token`.", + "minRunInterval": { + "description": "Minimal interval in seconds.", "type": "string" } }, @@ -76220,26 +76535,23 @@ } } } - }, - "400": { - "$ref": "#/components/responses/400" } } } }, - "/_action/order_delivery/{orderDeliveryId}/state/{transition}": { + "/_action/order_transaction/{orderTransactionId}/state/{transition}": { "post": { "tags": [ "Order Management" ], - "summary": "Transition an order delivery to a new state", - "description": "Changes the order delivery state and informs the customer via email if configured.", - "operationId": "orderDeliveryStateTransition", + "summary": "Transition an order transaction to a new state", + "description": "Changes the order transaction state and informs the customer via email if configured.", + "operationId": "orderTransactionStateTransition", "parameters": [ { - "name": "orderDeliveryId", + "name": "orderTransactionId", "in": "path", - "description": "Identifier of the order delivery.", + "description": "Identifier of the order transaction.", "required": true, "schema": { "type": "string", @@ -76249,7 +76561,7 @@ { "name": "transition", "in": "path", - "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition which is not possible, you will get an error that lists possible transition for the actual state.", + "description": "The `action_name` of the `state_machine_transition`. For example `process` if the order state should change from open to in progress.\n\nNote: If you choose a transition that is not available, you will get an error that lists possible transitions for the current state.", "required": true, "schema": { "type": "string" @@ -76263,7 +76575,7 @@ "schema": { "properties": { "sendMail": { - "description": "Controls if a mail should be send to the customer." + "description": "Controls if a mail should be sent to the customer." }, "documentIds": { "description": "A list of document identifiers that should be attached", @@ -76282,7 +76594,7 @@ } }, "stateFieldName": { - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "description": "This is the state column within the order transaction database table. There should be no need to change it from the default.", "type": "string", "default": "stateId" }, @@ -76298,31 +76610,107 @@ }, "responses": { "200": { - "description": "Todo: Use ref of `state_machine_transition` here" + "description": "Returns information about the transition that was made. `#/components/schemas/StateMachineTransition`" } } } }, - "/_action/message-queue/consume": { + "/_info/openapi3.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get OpenAPI Specification", + "description": "Get information about the admin API in OpenAPI format.", + "operationId": "api-info", + "parameters": [ + { + "name": "type", + "in": "query", + "description": "Type of the api", + "schema": { + "type": "string", + "enum": [ + "jsonapi", + "json" + ] + } + } + ], + "responses": { + "200": { + "$ref": "#/components/responses/OpenApi3" + } + } + } + }, + "/_action/order_transaction_capture_refund/{refundId}": { + "post": { + "tags": [ + "Order Management" + ], + "summary": "Refund an order transaction capture", + "description": "Refunds an order transaction capture.", + "operationId": "orderTransactionCaptureRefund", + "parameters": [ + { + "name": "refundId", + "in": "path", + "description": "Identifier of the order transaction capture refund.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + } + ], + "responses": { + "204": { + "description": "Refund was successful" + }, + "400": { + "description": "Something went wrong, while processing the refund" + }, + "404": { + "description": "Refund with id not found" + } + } + } + }, + "/_action/cleanup": { + "delete": { + "tags": [ + "System Operations" + ], + "summary": "Clear old cache folders", + "description": "Removes cache folders that are not needed anymore.", + "operationId": "clearOldCacheFolders", + "responses": { + "204": { + "description": "Returns a no content response indicating that the cleanup finished." + } + } + } + }, + "/_action/index": { "post": { "tags": [ "System Operations" ], - "summary": "Consume messages from the message queue.", - "description": "This route can be used to consume messages from the message queue. It is intended to be used if\nno cronjob is configured to consume messages regularly.", - "operationId": "consumeMessages", + "summary": "Run indexer", + "description": "Runs all registered indexer in the shop asynchronously.", + "operationId": "index", "requestBody": { - "required": true, "content": { "application/json": { "schema": { - "required": [ - "receiver" - ], "properties": { - "receiver": { - "description": "The name of the transport in the messenger that should be processed.\nSee the [Symfony Messenger documentation](https://symfony.com/doc/current/messenger.html) for more information", - "type": "string" + "skip": { + "description": "Array of indexers/updaters to be skipped.", + "type": "array", + "items": { + "type": "string" + } } }, "type": "object" @@ -76331,148 +76719,127 @@ } }, "responses": { - "200": { - "description": "Returns information about handled messages", - "content": { - "application/json": { - "schema": { - "properties": { - "handledMessages": { - "description": "The number of messages processed.", - "type": "integer" - } - }, - "type": "object" - } - } - } + "204": { + "description": "Returns a no content response indicating that the indexing progress startet." } } } }, - "/_info/health-check": { - "get": { + "/_action/cache": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Check that the Application is running", - "operationId": "healthCheck", + "summary": "Clear caches", + "description": "The cache is immediately cleared synchronously for all used adapters.", + "operationId": "clearCache", "responses": { - "200": { - "description": "Returns empty response" - }, - "500": { - "description": "Application is not working properly" + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." } } } }, - "/_info/system-health-check": { - "get": { + "/_action/cache-delayed": { + "delete": { "tags": [ - "System Info & Health Check" + "System Operations" ], - "summary": "Perform a detailed system health check", - "operationId": "systemHealthCheck", + "summary": "Clear all invalidated caches", + "description": "Directly triggers invalidation of all cache tags that were marked for invalidation.", + "operationId": "clearCacheDelayed", "parameters": [ { - "name": "verbose", + "name": "refreshOpenSearch", "in": "query", "required": false, + "description": "This parameter indicates that in addition to invalidating the delayed caches, the opensearch indices will also be refreshed, which should lead to a clean state on the next read requests. When OpenSearch is not used this parameter will be ignored.", "schema": { "type": "boolean", "default": false - }, - "description": "Include detailed information in the response" + } + } + ], + "responses": { + "204": { + "description": "Returns a no content response indicating that the cache has been cleared." + } + } + } + }, + "/oauth/sso/auth": { + "get": { + "tags": [ + "Experimental", + "SSO Login forward" + ], + "summary": "Experimental: Redirect to SSO login", + "description": "Experimental: Creates a redirection to the SSO login page", + "operationId": "ssoAuth", + "responses": { + "302": { + "description": "Experimental: Forwards to SSO login Page" } + } + } + }, + "/_info/is-sso": { + "get": { + "tags": [ + "Experimental", + "Is SSO environment" ], + "summary": "Experimental: Is SSO environment", + "description": "Experimental: Returns a boolean which indicates the it is a SSO environment or not", + "operationId": "isSso", "responses": { "200": { - "description": "Returns the system health check results", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "checks": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "healthy": { - "type": "boolean" - }, - "status": { - "type": "string" - }, - "message": { - "type": "string" - }, - "extra": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - } - } - } - } - } - } - } - } - } - }, - "500": { - "description": "Application is not working properly" + "description": "Experimental: Returns if it is a SSO environment or not" } } } }, - "/_proxy/generate-imitate-customer-token": { + "/_action/sso/invite-user": { "post": { "tags": [ - "Customer impersonation" + "Experimental", + "Invite a new SSO user" ], - "summary": "Generate a customer impersonation token", - "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", - "operationId": "generateImitateCustomerToken", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "customerId", - "salesChannelId" - ], - "properties": { - "customerId": { - "description": "ID of the customer", - "type": "string" - }, - "salesChannelId": { - "description": "ID of the sales channel", - "type": "string" - } - }, - "type": "object" - } - } + "summary": "Experimental: Invite a new SSO user", + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite", + "operationId": "inviteUser", + "responses": { + "200": { + "description": "Experimental: Invite a new SSO user and sends a e-mail with the invite" } - }, + } + } + }, + "/_action/cache_info": { + "get": { + "tags": [ + "System Operations" + ], + "summary": "Get cache information", + "description": "Get information about the cache configuration", + "operationId": "info", "responses": { "200": { - "description": "The generated customer impersonation token.", + "description": "Information about the cache state.", "content": { "application/json": { "schema": { "properties": { - "token": { - "description": "The generated customer impersonation token", + "environment": { + "description": "The active environment.", + "type": "string" + }, + "httpCache": { + "description": "State of the HTTP cache.", + "type": "boolean" + }, + "cacheAdapter": { + "description": "The active cache adapter.", "type": "string" } }, @@ -76484,163 +76851,74 @@ } } }, - "/_action/mail-template/send": { - "post": { + "/_info/queue.json": { + "get": { "tags": [ - "Mail Operations" + "System Info & Health Check" ], - "summary": "Send a mail", - "description": "Generates a mail from a mail template and sends it to the customer.\n\nTake a look at the `salesChannel` entity for possible values. For example `{{ salesChannel.name }}` can be used.", - "operationId": "send", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "recipients", - "salesChannelId", - "contentHtml", - "contentPlain", - "subject", - "senderName" - ], - "properties": { - "recipients": { - "description": "A list of recipients with name and mail address.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "salesChannelId": { - "description": "Identifier of the sales channel from which the mail should be send.", - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - }, - "subject": { - "description": "Subject of the mail.", - "type": "string" - }, - "senderName": { - "description": "Name of the sender.", - "type": "string" - }, - "senderEmail": { - "description": "Mail address of the sender. If not set, `core.basicInformation.email` or `core.mailerSettings.senderAddress` will be used from the shop configuration.", - "type": "string" - }, - "mediaIds": { - "description": "List of media identifiers which should be attached to the mail.", - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "binAttachments": { - "description": "A list of binary attachments which should be added to the mail.", - "required": [ - "content", - "fileName", - "mimeType" - ], - "type": "array", - "items": { - "properties": { - "content": { - "description": "Binary content of the attachment.", - "type": "string" - }, - "fileName": { - "description": "File name of the attachment.", - "type": "string" - }, - "mimeType": { - "description": "Mime type of the attachment.", - "type": "string" - } - }, - "type": "object" - } - }, - "recipientsBcc": { - "description": "A list of recipients with name and mail address to be set in BCC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "recipientsCc": { - "description": "A list of recipients with name and mail address to be set in CC.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "replyTo": { - "description": "A list of mail addresses with name and mail address to be set in reply to.", - "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" - }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } - }, - "returnPath": { - "description": "A list of mail addresses with name and mail address to be set in return path.", + "summary": "Get message queue statistics (deprecated)", + "description": "Returns increment-based message queue statistics.\n\n**Deprecated:** This endpoint is deprecated and will be removed in v6.8.0. Use `GET /_info/message-stats.json` instead for accurate message processing statistics.", + "operationId": "queue", + "deprecated": true, + "responses": { + "200": { + "description": "Message queue statistics returned.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { "type": "object", - "example": { - "test1@example.com": "Test user 1", - "test2@example.com": "Test user 2" + "properties": { + "name": { + "type": "string", + "description": "Fully qualified class name of the message." + }, + "size": { + "type": "integer", + "description": "Number of pending messages of this type." + } }, - "additionalProperties": { - "description": "Name of the recipient.", - "type": "string" - } + "required": [ + "name", + "size" + ] } }, - "type": "object" + "example": [ + { + "name": "Shopware\\Core\\Content\\Product\\DataAbstractionLayer\\ProductIndexingMessage", + "size": 150 + }, + { + "name": "Shopware\\Core\\Content\\Media\\Message\\GenerateThumbnailsMessage", + "size": 25 + } + ] } } } - }, + } + } + }, + "/_info/version": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get the Shopware version", + "description": "Get the version of the Shopware instance", + "operationId": "infoShopwareVersion", "responses": { "200": { - "description": "The mail was sent successful", + "description": "Returns the version of the Shopware instance.", "content": { "application/json": { "schema": { "properties": { - "size": { - "description": "Length of the email message", - "type": "integer" + "version": { + "description": "The Shopware version.", + "type": "string" } }, "type": "object" @@ -76651,108 +76929,190 @@ } } }, - "/_action/mail-template/validate": { - "post": { + "/_info/flow-actions.json": { + "get": { "tags": [ - "Mail Operations" + "System Info & Health Check" ], - "summary": "Validate a mail content", - "description": "Validates if content for a mail can be rendered without sending an email.", - "operationId": "validate", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "contentHtml", - "contentPlain" - ], - "properties": { - "contentHtml": { - "description": "The content of the mail in HTML format.", - "type": "string" - }, - "contentPlain": { - "description": "The content of the mail as plain text.", - "type": "string" - } - }, - "type": "object" + "summary": "Get actions for flow builder", + "description": "Get a list of action for flow builder.", + "operationId": "flow-actions", + "responses": { + "200": { + "description": "Returns a list of action for flow builder.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/flowBuilderActionsResponse" + } } } } - }, + } + } + }, + "/_info/events.json": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Get Business events", + "description": "Get a list of about the business events.", + "operationId": "business-events", "responses": { - "204": { - "description": "Returns a no content response indicating the mail content was rendered successfully." + "200": { + "description": "Returns a list of about the business events.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/businessEventsResponse" + } + } + } } } } }, - "/_action/mail-template/build": { - "post": { + "/_info/routes": { + "get": { + "summary": "Get API routes", + "operationId": "getRoutes", "tags": [ - "Mail Operations" + "System Info & Health Check" ], - "summary": "Preview a mail template", - "description": "Generates a preview of a mail template.", - "operationId": "build", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "required": [ - "mailTemplateType", - "mailTemplate" - ], - "properties": { - "mailTemplateType": { - "description": "Only the property `templateData` is used. It provides additional variables to the templating engine.", - "properties": { - "templateData": { - "description": "An associative array that is handed over to the templating engine and can be used as variables in the mail content.", + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "endpoints" + ], + "properties": { + "endpoints": { + "type": "array", + "items": { "type": "object", - "example": { - "order": { - "orderNumber": 5000, - "customerName": "Example Customer" + "required": [ + "methods", + "path" + ], + "properties": { + "methods": { + "type": "array", + "items": { + "type": "string" + } }, - "messageOfTheDay": "An apple a day keeps the doctor away!" - }, - "additionalProperties": true - } - }, - "type": "object" - }, - "mailTemplate": { - "description": "The content of the mail as plain text.", - "properties": { - "contentHtml": { - "description": "The content of mail mail template in html format.", - "type": "string", - "example": "Hello {{ order.customerName }}, this is example mail content, the current date is {{ 'now'|date('d/m/Y') }}" + "path": { + "type": "string" + } + } } - }, - "type": "object" + } } - }, - "type": "object" + } } } } - }, + } + } + }, + "/_info/health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Check that the Application is running", + "operationId": "healthCheck", "responses": { "200": { - "description": "The rendered preview of the mail template.", + "description": "Returns empty response" + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_info/system-health-check": { + "get": { + "tags": [ + "System Info & Health Check" + ], + "summary": "Perform a detailed system health check", + "operationId": "systemHealthCheck", + "parameters": [ + { + "name": "verbose", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "description": "Include detailed information in the response" + } + ], + "responses": { + "200": { + "description": "Returns the system health check results", "content": { "application/json": { "schema": { - "type": "string" + "type": "object", + "properties": { + "checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "healthy": { + "type": "boolean" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + }, + "extra": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + } + } + } + } + } + } } } } + }, + "500": { + "description": "Application is not working properly" + } + } + } + }, + "/_action/index-products": { + "post": { + "tags": [ + "System Operations" + ], + "summary": "Send product indexing message", + "description": "Dispatches a product indexing message to the message bus, with the provided ids", + "operationId": "productIndexing", + "responses": { + "204": { + "description": "Returns an empty response indicating that the message dispatched." } } } @@ -77102,121 +77462,154 @@ } } }, - "/_action/cleanup": { + "/_action/container_cache": { "delete": { "tags": [ "System Operations" ], - "summary": "Clear old cache folders", - "description": "Removes cache folders that are not needed anymore.", - "operationId": "clearOldCacheFolders", + "summary": "Clear container caches", + "description": "The container cache is immediately cleared synchronously.", + "operationId": "clearContainerCache", "responses": { "204": { - "description": "Returns a no content response indicating that the cleanup finished." + "description": "Returns a no content response indicating that the container cache is cleared." } } } }, - "/_info/config": { + "/_action/document/{documentId}/{deepLinkCode}": { "get": { "tags": [ - "System Info & Health Check" + "Document Management" + ], + "summary": "Download a document", + "description": "Download a document by its identifier and deep link code.", + "operationId": "downloadDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document to be downloaded.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "deepLinkCode", + "in": "path", + "description": "A unique hash code which was generated when the document was created.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "download", + "in": "query", + "description": "This parameter controls the `Content-Disposition` header. If set to `true` the header will be set to `attachment` else `inline`.", + "schema": { + "type": "boolean", + "default": false + } + } ], - "summary": "Get public runtime config & feature metadata", - "description": "Returns non-sensitive system/runtime metadata used by the administration UI for initialization, feature toggling, and diagnostics. Typical fields include platform/API version, active feature flags, environment mode, available capabilities (e.g. workers, queue, cache), limits, and other public configuration hints. Use this at admin startup to decide which features to enable and to display environment information.", - "operationId": "config", "responses": { "200": { - "description": "Public runtime configuration & feature metadata returned.", + "description": "The document.", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/infoConfigResponse" + "type": "string", + "format": "binary" + } + } + } + } + } + } + }, + "/_action/document/{documentId}/upload": { + "post": { + "tags": [ + "Document Management" + ], + "summary": "Upload a file for a document", + "description": "Uploads a file for a document. This prevents the document from being dynamically generated and delivers the uploaded file instead, when the document is downloaded.\n\nNote:\n* The document is required to be `static`\n* A document can only have one media file\n\nThe are two methods of providing a file to this route:\n * Use a typical file upload and provide the file in the request\n * Fetch the file from an url. This only works if the `shopware.media.enable_url_upload_feature` variable is set to true in the shop environment.\nTo use file upload via url, the content type has to be `application/json` and the parameter `url` has to be provided.", + "operationId": "uploadToDocument", + "parameters": [ + { + "name": "documentId", + "in": "path", + "description": "Identifier of the document the new file should be added to.", + "required": true, + "schema": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + { + "name": "fileName", + "in": "query", + "description": "Name of the uploaded file.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "extension", + "in": "query", + "description": "Extension of the uploaded file. For example `pdf`", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + }, + "application/json": { + "schema": { + "required": [ + "url" + ], + "properties": { + "url": { + "description": "The url of the document that will be downloaded.", + "type": "string" + } }, - "example": { - "version": "6.7.2.0", - "shopId": "NoiU8PfJtu7NBY8M", - "versionRevision": "98fcdbeab238fbef3b47bc258340124a1dba4852", - "adminWorker": { - "enableAdminWorker": true, - "enableNotificationWorker": true, - "transports": [ - "async", - "low_priority" - ] - }, - "bundles": { - "Administration": { - "css": [ - "http://localhost:8000/bundles/administration/administration/assets/administration-DX5ywH2m.css" - ], - "js": [ - "http://localhost:8000/bundles/administration/administration/assets/administration-DPiBX_LO.js" - ], - "baseUrl": null, - "type": "plugin" + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "Document uploaded successful", + "content": { + "application/json": { + "schema": { + "properties": { + "documentId": { + "description": "Identifier of the document.", + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "Storefront": { - "css": [ - "http://localhost:8000/bundles/storefront/administration/assets/storefront-LFaCMnyI.css" - ], - "js": [ - "http://localhost:8000/bundles/storefront/administration/assets/storefront-C-M6U7ZM.js" - ], - "baseUrl": null, - "type": "plugin" - } - }, - "settings": { - "enableUrlFeature": true, - "appUrlReachable": true, - "appsRequireAppUrl": false, - "private_allowed_extensions": [ - "jpg", - "jpeg", - "png", - "webp", - "avif", - "gif", - "svg", - "bmp", - "tiff", - "tif", - "eps", - "webm", - "mkv", - "flv", - "ogv", - "ogg", - "mov", - "mp4", - "avi", - "wmv", - "pdf", - "aac", - "mp3", - "wav", - "flac", - "oga", - "wma", - "txt", - "doc", - "docx", - "ico", - "glb", - "zip", - "rar", - "csv", - "xls", - "xlsx", - "html", - "xml" - ], - "enableHtmlSanitizer": true, - "enableStagingMode": false, - "disableExtensionManagement": false + "documentDeepLink": { + "description": "A unique hash code which is required to open the document.", + "type": "string" + } }, - "inAppPurchases": [] + "type": "object" } } } @@ -77224,169 +77617,188 @@ } } }, - "/_action/state-machine/{entityName}/{entityId}/state": { + "/_action/number-range/reserve/{type}/{saleschannel}": { "get": { "tags": [ - "State Machine" + "Document Management" ], - "summary": "Get available transitions for an entity", - "description": "Retrieves the available state transitions for the specified entity.", - "operationId": "getEntityState", + "summary": "Reserve or preview a number-range / document number.", + "description": "This endpoint provides functionality to reserve or preview a document number which can be used to create a new document using the `/_action/order/{orderId}/document/{documentTypeName}` endpoint.\n\nThe number generated by the endpoint will be reserved and the number pointer will be incremented with every call. For preview purposes, you can add the `?preview=1` parameter to the request. In that case, the number will not be incremented.", + "operationId": "numberRangeReserve", "parameters": [ { - "name": "entityName", + "name": "type", "in": "path", - "description": "Name of the entity.", + "description": "`technicalName` of the document type (e.g. `document_invoice`). Available types can be fetched with the `/api/document-type endpoint`.", "required": true, "schema": { "type": "string" } }, { - "name": "entityId", + "name": "saleschannel", "in": "path", - "description": "Identifier of the entity.", + "description": "Sales channel for the number range. Number ranges can be defined per sales channel, so you can pass a sales channel ID here.", "required": true, "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + "type": "string" } }, { - "name": "stateFieldName", + "name": "preview", "in": "query", - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", + "description": "If this parameter has a true value, the number will not actually be incremented, but only previewed.", "required": false, "schema": { - "type": "string", - "default": "stateId" + "type": "boolean" } } ], "responses": { "200": { - "description": "Available transitions for the current state.", + "description": "The generated number", "content": { "application/json": { "schema": { - "type": "object", "properties": { - "transitions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the transition." - }, - "technicalName": { - "type": "string", - "description": "The technical name of the transition." - }, - "actionName": { - "type": "string", - "description": "The action name of the transition." - }, - "fromStateName": { - "type": "string", - "description": "The technical name of the state the transition starts from." - }, - "toStateName": { - "type": "string", - "description": "The technical name of the state the transition goes to." - }, - "url": { - "type": "string", - "description": "The URL to trigger the transition." - } - }, - "required": [ - "name", - "technicalName", - "actionName", - "fromStateName", - "toStateName", - "url" - ] - } + "number": { + "description": "The generated (or previewed) document number.", + "type": "string" } }, - "required": [ - "transitions" - ] + "type": "object" } } } }, "400": { - "description": "Unable to read the entity or entity field." + "description": "Number range not found" + } + } + } + }, + "/consents": { + "get": { + "tags": [ + "Consent Management", + "Experimental" + ], + "summary": "List all consents for current user", + "description": "Returns a list of all available consents with their current status for the authenticated admin user. Each consent includes its name, identifier, and current state (requested, accepted, or revoked). Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "fetchConsents", + "responses": { + "200": { + "description": "List of consents with their status", + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/ConsentState" + }, + "example": { + "product_analytics": { + "name": "product_analytics", + "scopeName": "admin_user", + "identifier": "userId-12345", + "status": "accepted", + "actor": "userId-12345", + "updatedAt": "2024-01-15T10:20:30Z" + }, + "backend_data": { + "name": "backend_data", + "scopeName": "system", + "identifier": "system", + "status": "requested", + "actor": null, + "updatedAt": null + } + } + } + } + } }, - "403": { - "description": "Forbidden. Missing privileges to access the entity." + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_action/state-machine/{entityName}/{entityId}/state/{transition}": { + "/consents/accept": { "post": { "tags": [ - "State Machine" + "Consent Management", + "Experimental" ], - "summary": "Transition an entity to a new state", - "description": "Changes the entity state by applying the given transition.", - "operationId": "transitionEntityState", - "parameters": [ - { - "name": "entityName", - "in": "path", - "description": "Name of the entity.", - "required": true, - "schema": { - "type": "string" + "summary": "Accept a consent", + "description": "Marks the specified consent as accepted for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "acceptConsent", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "consent": { + "type": "string", + "description": "The name of the consent to accept" + } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" + } + } } - }, - { - "name": "entityId", - "in": "path", - "description": "Identifier of the entity.", - "required": true, - "schema": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" + } + }, + "responses": { + "200": { + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } } }, - { - "name": "transition", - "in": "path", - "description": "The `action_name` of the `state_machine_transition`.", - "required": true, - "schema": { - "type": "string" - } + "404": { + "description": "Bad request - Consent not found or consent property was empty" }, - { - "name": "stateFieldName", - "in": "query", - "description": "This is the state column within the order delivery database table. There should be no need to change it from the default.", - "required": false, - "schema": { - "type": "string", - "default": "stateId" - } + "401": { + "description": "Unauthorized - User not logged in or invalid session" } + } + } + }, + "/consents/revoke": { + "post": { + "tags": [ + "Consent Management", + "Experimental" ], + "summary": "Revoke a consent", + "description": "Marks the specified consent as revoked for the authenticated admin user. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", + "operationId": "revokeConsent", "requestBody": { - "description": "Optional internal comment for the state transition.", "content": { "application/json": { "schema": { "type": "object", "properties": { - "internalComment": { + "consent": { "type": "string", - "description": "An optional internal comment that will be saved with the state transition." + "description": "The name of the consent to accept" } + }, + "required": [ + "consent" + ], + "example": { + "consent": "product_analytics" } } } @@ -77394,42 +77806,72 @@ }, "responses": { "200": { - "description": "State transition applied successfully." + "description": "Consent status changed successfully. Returns the updated consent status.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConsentState" + } + } + } }, - "400": { - "description": "Unable to read the entity or entity field, or invalid transition." + "404": { + "description": "Bad request - Consent not found or consent property was empty" }, - "403": { - "description": "Forbidden. Missing privileges to access the entity." + "401": { + "description": "Unauthorized - User not logged in or invalid session" } } } }, - "/_info/openapi3.json": { - "get": { + "/_proxy/generate-imitate-customer-token": { + "post": { "tags": [ - "System Info & Health Check" + "Customer impersonation" ], - "summary": "Get OpenAPI Specification", - "description": "Get information about the admin API in OpenAPI format.", - "operationId": "api-info", - "parameters": [ - { - "name": "type", - "in": "query", - "description": "Type of the api", - "schema": { - "type": "string", - "enum": [ - "jsonapi", - "json" - ] + "summary": "Generate a customer impersonation token", + "description": "Generates a customer impersonation token for the given customer and sales channel.\n\nThe token can be used to authenticate as the customer in the sales channel.", + "operationId": "generateImitateCustomerToken", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "required": [ + "customerId", + "salesChannelId" + ], + "properties": { + "customerId": { + "description": "ID of the customer", + "type": "string" + }, + "salesChannelId": { + "description": "ID of the sales channel", + "type": "string" + } + }, + "type": "object" + } } } - ], + }, "responses": { "200": { - "$ref": "#/components/responses/OpenApi3" + "description": "The generated customer impersonation token.", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "description": "The generated customer impersonation token", + "type": "string" + } + }, + "type": "object" + } + } + } } } } @@ -81005,7 +81447,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -81019,10 +81466,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -81038,7 +81481,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -81080,6 +81529,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -81583,7 +82037,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -81597,10 +82056,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -81620,6 +82075,12 @@ }, "linkType": { "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ], "description": "linkType : `external`, `category`, `product`, `landing_page`." }, "internalLink": { @@ -81671,6 +82132,11 @@ "pattern": "^[0-9a-f]{32}$", "description": "Unique identity of custom entity type." }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -82539,8 +83005,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -82736,7 +83206,11 @@ }, "type": { "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean", @@ -85366,7 +85840,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -88475,6 +88949,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -88485,9 +88962,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -88615,6 +89089,10 @@ "description": "Technical name of document type.", "type": "string" }, + "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", @@ -88625,10 +89103,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object", - "description": "Additional fields that offer a possibility to add own fields for the different program-areas." - }, "translated": { "type": "object", "description": "Contains the translations of all translated fields." @@ -94816,7 +95290,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -95029,7 +95509,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -98964,7 +99450,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -99457,7 +99952,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object", @@ -102379,7 +102883,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -103697,7 +104205,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -107307,6 +107819,38 @@ } }, "type": "object" + }, + "products": { + "description": "Products this product stream includes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -107391,6 +107935,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" @@ -114117,7 +114668,12 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -114261,7 +114817,12 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \"frontend.detail.page\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \"/detail/bbf36734504741c79a3bbe3795b91564\"", @@ -120051,6 +120612,97 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -120216,6 +120868,13 @@ "type": "boolean", "description": "True if at least one installed app requires a reachable APP_URL." }, + "firstMigrationDate": { + "type": [ + "string", + "null" + ], + "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." + }, "private_allowed_extensions": { "type": "array", "description": "Whitelisted file extensions for private filesystem uploads.", @@ -120236,6 +120895,9 @@ "description": "True if runtime extension management is disabled." } }, + "required": [ + "firstMigrationDate" + ], "additionalProperties": false }, "inAppPurchases": { @@ -120259,200 +120921,6 @@ ], "additionalProperties": false }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "refresh_token" - ] - } - ] - }, "businessEventsResponse": { "type": "array", "items": { @@ -121207,6 +121675,200 @@ "field" ] }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "Price": { "type": "object", "description": "Price object", @@ -121289,55 +121951,6 @@ "linked" ] }, - "ConsentState": { - "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" - }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" - } - } - }, "Cart": { "properties": { "id": { diff --git a/adminapi.summary.json b/adminapi.summary.json index c92927b..bbc9b45 100644 --- a/adminapi.summary.json +++ b/adminapi.summary.json @@ -21,6 +21,7 @@ "/_action/media/external-link", "/_action/media/upload", "/_action/media/upload_by_url", + "/_action/media/{mediaId}/external-thumbnails", "/_action/media/{mediaId}/upload", "/_action/media/{mediaId}/video-cover", "/_action/message-queue/consume", @@ -39,11 +40,17 @@ "/_action/state-machine/{entityName}/{entityId}/state", "/_action/state-machine/{entityName}/{entityId}/state/{transition}", "/_action/sync", + "/_action/system-config", + "/_action/system-config/batch", + "/_action/system-config/check", + "/_action/system-config/schema", "/_action/theme/{themeId}", "/_action/theme/{themeId}/assign/{salesChannelId}", "/_action/theme/{themeId}/configuration", "/_action/theme/{themeId}/reset", "/_action/theme/{themeId}/structured-fields", + "/_action/user/logout", + "/_action/validation/email", "/_info/config", "/_info/events.json", "/_info/flow-actions.json", @@ -213,6 +220,7 @@ "/app-shipping-method", "/app-shipping-method/{id}", "/app-system/privileges/requested", + "/app-system/shop/verify", "/app-system/{appName}/privileges", "/app-system/{appName}/privileges/accepted", "/app-template", @@ -710,6 +718,7 @@ "DocumentTypeJsonApi", "EqualsFilter", "Excludes", + "ExternalThumbnail", "Filters", "FindProductVariantRouteResponse", "Flow", @@ -762,6 +771,7 @@ "MediaFolderConfigurationJsonApi", "MediaFolderConfigurationMediaThumbnailSize", "MediaFolderJsonApi", + "MediaId", "MediaJsonApi", "MediaTag", "MediaThumbnail", From dddbb7cc777e6f3257080d406f3c3a2cbc83142f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 11:02:01 +0200 Subject: [PATCH 59/63] [create-pull-request] automated change (#478) Co-authored-by: shopwareBot --- SwagCommercial-adminapi.json | 1335 +++++++++++++++++++------- SwagCommercial-adminapi.summary.json | 10 + 2 files changed, 981 insertions(+), 364 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 65da824..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.8.2" + "version": "6.7.9.0" }, "servers": [ { @@ -36887,6 +36887,442 @@ } } }, + "/_action/validation/email": { + "post": { + "tags": [ + "Email support validation" + ], + "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": { + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", + "content": { + "application/json": { + "schema": { + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" + } + }, + "type": "object" + }, + "example": { + "errors": [ + { + "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": { + "properties": { + "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." + } + ] + } + } + } + } + } + } + }, + "/app-system/shop/verify": { + "get": { + "tags": [ + "App System", + "Public" + ], + "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": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "token", + "in": "query", + "description": "A unique identifier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "An empty response signalling successful verification." + }, + "400": { + "description": "Malformed request or unsuccessful verification." + } + } + } + }, + "/_action/system-config": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "salesChannelId", + "in": "query", + "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": "Key-value pairs of configuration values to save.", + "required": true, + "content": { + "application/json": { + "schema": { + "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": "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", + "additionalProperties": true + } + } + } + } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } + } + } + }, + "/_action/media/{mediaId}/external-thumbnails": { + "post": { + "tags": [ + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "thumbnails": { + "type": "array", + "description": "List of external thumbnails to attach", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Thumbnails attached successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" + }, + "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": { + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" + } + } + } + } + } + }, + "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": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." + } + } + } + }, "/_action/custom-price": { "post": { "tags": [ @@ -43653,8 +44089,7 @@ "type": "string" }, "lastRenews": { - "type": "string", - "readOnly": true + "type": "string" }, "nextRenews": { "type": "string", @@ -43947,8 +44382,7 @@ "type": "string" }, "lastRenews": { - "type": "string", - "readOnly": true + "type": "string" }, "nextRenews": { "type": "string", @@ -50111,7 +50545,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -51941,7 +52379,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -53331,7 +53773,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -53345,10 +53792,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -53364,7 +53807,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -53406,6 +53855,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -53972,7 +54426,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -53986,10 +54445,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -54005,7 +54460,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -54047,6 +54508,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -54965,8 +55431,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -55158,8 +55628,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -58646,7 +59120,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -59980,7 +60454,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -63184,6 +63658,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -63194,9 +63671,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -63358,6 +63832,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -63368,9 +63845,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -70551,7 +71025,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -70763,7 +71243,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -75288,7 +75774,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -75828,7 +76323,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -83553,6 +84057,38 @@ } }, "type": "object" + }, + "products": { + "description": "Products this product stream includes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -83727,6 +84263,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" @@ -95006,7 +95549,13 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.navigation.page", + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -95149,7 +95698,13 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.navigation.page", + "frontend.landing.page", + "frontend.bundle.detail.page", + "frontend.detail.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -107539,6 +108094,97 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -107704,6 +108350,13 @@ "type": "boolean", "description": "True if at least one installed app requires a reachable APP_URL." }, + "firstMigrationDate": { + "type": [ + "string", + "null" + ], + "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." + }, "private_allowed_extensions": { "type": "array", "description": "Whitelisted file extensions for private filesystem uploads.", @@ -107724,6 +108377,9 @@ "description": "True if runtime extension management is disabled." } }, + "required": [ + "firstMigrationDate" + ], "additionalProperties": false }, "inAppPurchases": { @@ -107747,200 +108403,6 @@ ], "additionalProperties": false }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "refresh_token" - ] - } - ] - }, "businessEventsResponse": { "type": "array", "items": { @@ -108681,6 +109143,200 @@ "field" ] }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "Price": { "type": "object", "description": "Price object", @@ -108763,52 +109419,56 @@ "linked" ] }, - "ConsentState": { + "CustomPricingResponse": { "type": "object", "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt" + "success", + "data" ], "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "success": { + "type": "boolean" }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "result": { + "type": "array", + "items": { + "type": "object", + "required": [ + "entities", + "errors" + ], + "properties": { + "entities": { + "type": "array", + "maxItems": 1, + "items": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + } + }, + "errors": { + "type": "array", + "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", + "items": { + "type": "string" + } + } + } + } + }, + "extensions": { + "type": "array", + "items": { + "type": "object" + } + } + } + } } } }, @@ -108863,64 +109523,6 @@ } } }, - "CustomPricingUpsertOperation": { - "type": "object", - "required": [ - "action", - "payload" - ], - "properties": { - "action": { - "description": "A specific verb defining what operation should be actioned for a specific data record", - "type": "string", - "enum": [ - "upsert" - ] - }, - "payload": { - "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", - "type": "array", - "items": { - "type": "object", - "required": [ - "productId", - "prices" - ], - "description": "A definition almost symmetric with Sync API payload", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productVersionId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "productId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "customerId": { - "type": "string", - "description": "This parameter should be specified, or 'customerGroupId', not both", - "pattern": "^[0-9a-f]{32}$" - }, - "customerGroupId": { - "type": "string", - "description": "This parameter should be specified, or 'customerId', not both", - "pattern": "^[0-9a-f]{32}$" - }, - "price": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CustomPricingPrice" - } - } - } - } - } - } - }, "CustomPricingPrice": { "type": "object", "description": "An extended schema for the Custom Price 'price' column (as opposed to ProductPrice 'price' column)", @@ -109002,52 +109604,57 @@ } } }, - "CustomPricingResponse": { + "CustomPricingUpsertOperation": { "type": "object", "required": [ - "success", - "data" + "action", + "payload" ], "properties": { - "success": { - "type": "boolean" + "action": { + "description": "A specific verb defining what operation should be actioned for a specific data record", + "type": "string", + "enum": [ + "upsert" + ] }, - "data": { + "payload": { + "description": "Contains a list of changesets for an entity. If the action type is `delete`,\n a list of identifiers can be provided.", "type": "array", "items": { "type": "object", + "required": [ + "productId", + "prices" + ], + "description": "A definition almost symmetric with Sync API payload", "properties": { - "result": { - "type": "array", - "items": { - "type": "object", - "required": [ - "entities", - "errors" - ], - "properties": { - "entities": { - "type": "array", - "maxItems": 1, - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - } - }, - "errors": { - "type": "array", - "description": "A detailed error list addressing specific points in which sync payload does not meet system expectations (data types, structure etc.)", - "items": { - "type": "string" - } - } - } - } + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "extensions": { + "productVersionId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "productId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "customerId": { + "type": "string", + "description": "This parameter should be specified, or 'customerGroupId', not both", + "pattern": "^[0-9a-f]{32}$" + }, + "customerGroupId": { + "type": "string", + "description": "This parameter should be specified, or 'customerId', not both", + "pattern": "^[0-9a-f]{32}$" + }, + "price": { "type": "array", "items": { - "type": "object" + "$ref": "#/components/schemas/CustomPricingPrice" } } } diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index 2d52c32..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", @@ -98,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", @@ -463,6 +471,7 @@ "DocumentTypeJsonApi", "EqualsFilter", "Excludes", + "ExternalThumbnail", "Filters", "Flow", "FlowJsonApi", @@ -514,6 +523,7 @@ "MediaFolderConfigurationJsonApi", "MediaFolderConfigurationMediaThumbnailSize", "MediaFolderJsonApi", + "MediaId", "MediaJsonApi", "MediaTag", "MediaThumbnail", From d4c914eeae11aeadc74d8d1adfa21347f4f114f3 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 11:02:57 +0200 Subject: [PATCH 60/63] [create-pull-request] automated change (#477) Co-authored-by: shopwareBot --- SwagDigitalSalesRooms-adminapi.json | 2909 +++++++++++-------- SwagDigitalSalesRooms-adminapi.summary.json | 10 + 2 files changed, 1768 insertions(+), 1151 deletions(-) diff --git a/SwagDigitalSalesRooms-adminapi.json b/SwagDigitalSalesRooms-adminapi.json index 630decb..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.8.2" + "version": "6.7.9.0" }, "servers": [ { @@ -4884,6 +4884,442 @@ } } }, + "/_action/validation/email": { + "post": { + "tags": [ + "Email support validation" + ], + "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": { + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", + "content": { + "application/json": { + "schema": { + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" + } + }, + "type": "object" + }, + "example": { + "errors": [ + { + "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": { + "properties": { + "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." + } + ] + } + } + } + } + } + } + }, + "/app-system/shop/verify": { + "get": { + "tags": [ + "App System", + "Public" + ], + "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": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "token", + "in": "query", + "description": "A unique identifier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "An empty response signalling successful verification." + }, + "400": { + "description": "Malformed request or unsuccessful verification." + } + } + } + }, + "/_action/system-config": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "salesChannelId", + "in": "query", + "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": "Key-value pairs of configuration values to save.", + "required": true, + "content": { + "application/json": { + "schema": { + "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": "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", + "additionalProperties": true + } + } + } + } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } + } + } + }, + "/_action/media/{mediaId}/external-thumbnails": { + "post": { + "tags": [ + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "thumbnails": { + "type": "array", + "description": "List of external thumbnails to attach", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Thumbnails attached successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" + }, + "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": { + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" + } + } + } + } + } + }, + "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": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." + } + } + } + }, "/_action/dsr/appointment/{appointmentId}/join-as-guide": { "post": { "tags": [ @@ -8963,7 +9399,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -8977,10 +9418,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -8996,7 +9433,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -9038,6 +9481,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -9534,7 +9982,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -9548,10 +10001,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -9567,7 +10016,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -9609,6 +10064,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -10525,8 +10985,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -10752,8 +11216,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -13358,7 +13826,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -14200,7 +14668,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -16480,6 +16948,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16490,9 +16961,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -16618,6 +17086,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -16628,9 +17099,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -24930,7 +25398,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -25142,7 +25616,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -28991,7 +29471,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -29466,7 +29955,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -32200,7 +32698,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -33558,7 +34060,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -37195,6 +37701,38 @@ } }, "type": "object" + }, + "products": { + "description": "Products this product stream includes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -37309,6 +37847,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" @@ -43987,7 +44532,12 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -44130,7 +44680,12 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -50195,6 +50750,97 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -50360,6 +51006,13 @@ "type": "boolean", "description": "True if at least one installed app requires a reachable APP_URL." }, + "firstMigrationDate": { + "type": [ + "string", + "null" + ], + "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." + }, "private_allowed_extensions": { "type": "array", "description": "Whitelisted file extensions for private filesystem uploads.", @@ -50380,6 +51033,9 @@ "description": "True if runtime extension management is disabled." } }, + "required": [ + "firstMigrationDate" + ], "additionalProperties": false }, "inAppPurchases": { @@ -50403,200 +51059,6 @@ ], "additionalProperties": false }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "refresh_token" - ] - } - ] - }, "businessEventsResponse": { "type": "array", "items": { @@ -51337,6 +51799,200 @@ "field" ] }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "Price": { "type": "object", "description": "Price object", @@ -51419,226 +52075,589 @@ "linked" ] }, - "ConsentState": { + "CartPriceQuantity": { "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt" - ], "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { + "apiAlias": { "type": "string", "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" + "cart_price_quantity" + ] }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" - } - } - }, - "Cart": { - "type": "object", - "properties": { - "name": { - "description": "Name of the cart - for example `guest-cart`", - "type": "string" + "isCalculated": { + "type": "boolean" }, - "token": { - "description": "Context token identifying the cart and the user session", - "type": "string" + "listPrice": { + "$ref": "#/components/schemas/CartListPrice" }, "price": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "lineItems": { - "description": "All items within the cart", - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } + "type": "number" }, - "errors": { - "type": "array", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "items": { - "$ref": "#/components/schemas/CartError" - } + "quantity": { + "type": "number" }, - "deliveries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/CartDelivery" - } + "regulationPrice": { + "properties": { + "price": { + "type": "number", + "format": "float" + } + }, + "type": "object" }, - "transactions": { - "description": "A list of all payment transactions associated with the current cart.", + "taxRules": { "type": "array", "items": { "type": "object", "properties": { - "paymentMethodId": { - "type": "string" + "taxRate": { + "type": "number", + "format": "float" }, - "amount": { - "$ref": "#/components/schemas/CalculatedPrice" + "name": { + "type": "string" } } } }, - "modified": { - "type": "boolean" + "type": { + "type": "string" + } + }, + "required": [ + "apiAlias" + ] + }, + "CartDeliveryPosition": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } }, - "customerComment": { - "type": "string", - "description": "A comment that can be added to the cart.", - "nullable": true + "identifier": { + "type": "string" }, - "affiliateCode": { - "type": "string", - "description": "An affiliate tracking code", - "nullable": true + "lineItem": { + "$ref": "#/components/schemas/LineItem" }, - "campaignCode": { - "type": "string", - "description": "A campaign tracking code", - "nullable": true + "price": { + "$ref": "#/components/schemas/CalculatedPrice" } } }, - "CartDeliveryInformation": { + "LineItemType": { + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "discount", + "container", + "quantity", + "dsr-line-item-discount", + "dsr-cart-discount" + ] + }, + "DiscountLineItemPayload": { "type": "object", "properties": { - "apiAlias": { + "discountType": { "type": "string", "enum": [ - "cart_delivery_information" + "percentage", + "absolute" ] }, - "freeDelivery": { + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } + }, + "LineItem": { + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + }, + "cover": { + "$ref": "#/components/schemas/ProductMedia" + }, + "dataContextHash": { + "type": "string" + }, + "dataTimestamp": { + "type": "string" + }, + "deliveryInformation": { + "$ref": "#/components/schemas/CartDeliveryInformation" + }, + "description": { + "type": "string" + }, + "good": { "type": "boolean" }, - "deliveryTime": { + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "modified": { + "type": "boolean" + }, + "modifiedByApp": { + "type": "boolean" + }, + "payload": { + "allOf": [ + { + "$ref": "#/components/schemas/ProductJsonApi" + }, + { + "type": "object", + "properties": { + "discountType": { + "type": "string", + "enum": [ + "percentage", + "absolute" + ] + }, + "discountValue": { + "type": "number", + "format": "float", + "maximum": 0 + }, + "discountPrice": { + "type": "number", + "format": "float", + "maximum": 0 + } + } + } + ] + }, + "extensions": { "type": "object", "properties": { - "name": { - "type": "string" + "meta": { + "type": "object", + "properties": { + "attendees": { + "type": "array", + "items": { + "type": "object", + "required": [ + "id", + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "id": { + "type": "string" + } + } + } + } + } + } + } + }, + "price": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] }, - "min": { - "type": "integer" + "calculatedTaxes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_tax_calculated" + ] + }, + "tax": { + "type": "number" + }, + "taxRate": { + "type": "number" + }, + "price": { + "type": "number" + } + }, + "required": [ + "apiAlias", + "tax", + "taxRate", + "price" + ] + } }, - "max": { - "type": "integer" + "listPrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartListPrice" + }, + { + "type": "null" + } + ] }, - "unit": { - "type": "string" + "quantity": { + "type": "number" }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_time" + "referencePrice": { + "oneOf": [ + { + "$ref": "#/components/schemas/CartPriceReference" + }, + { + "type": "null" + } ] + }, + "regulationPrice": { + "type": "object", + "properties": { + "price": { + "type": "number" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_regulation_price" + ] + } + }, + "nullable": true + }, + "totalPrice": { + "type": "number" + }, + "unitPrice": { + "type": "number" + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + } + }, + "required": [ + "apiAlias", + "totalPrice", + "quantity", + "unitPrice" + ] + }, + "priceDefinition": { + "$ref": "#/components/schemas/CartPriceQuantity" + }, + "quantity": { + "type": "number" + }, + "quantityInformation": { + "type": "object", + "properties": { + "maxPurchase": { + "type": "number" + }, + "minPurchase": { + "type": "number" + }, + "purchaseSteps": { + "type": "number" } } }, - "height": { - "type": "integer" + "referencedId": { + "type": "string" }, - "length": { - "type": "integer" + "removable": { + "type": "boolean" }, - "restockTime": { - "type": "integer" + "stackable": { + "type": "boolean" }, - "stock": { - "type": "integer" + "states": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "is-physical", + "is-download" + ] + } }, - "weight": { - "type": "integer" + "type": { + "$ref": "#/components/schemas/LineItemType" }, - "width": { - "type": "integer" + "uniqueIdentifier": { + "type": "string" } }, "required": [ - "apiAlias" + "id", + "type" ] }, - "StateForGuides": { + "CartItems": { "type": "object", "properties": { - "clients": { + "items": { "type": "array", "items": { - "type": "string" - }, - "default": [] + "$ref": "#/components/schemas/LineItem" + } + } + } + }, + "DynamicProductListingPageOpenedPayload": { + "required": [ + "page" + ], + "properties": { + "page": { + "type": "integer", + "description": "Current page position in the pagination" + } + } + }, + "CartDelivery": { + "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "properties": { + "deliveryDate": { + "type": "object", + "properties": { + "earliest": { + "type": "string", + "format": "date-time" + }, + "latest": { + "type": "string", + "format": "date-time" + } + } }, - "inactiveClients": { + "location": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_shipping_location" + ] + }, + "country": { + "$ref": "#/components/schemas/Country" + }, + "address": { + "$ref": "#/components/schemas/CustomerAddress" + }, + "state": { + "$ref": "#/components/schemas/CountryState" + } + } + }, + "positions": { "type": "array", "items": { - "type": "string" - }, - "default": [] + "$ref": "#/components/schemas/CartDeliveryPosition" + } }, - "guides": { + "shippingCosts": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "shippingMethod": { + "$ref": "#/components/schemas/ShippingMethod" + } + } + }, + "DiscountType": { + "type": "string", + "description": "Type of the discount", + "enum": [ + "percentage", + "absolute" + ] + }, + "AddTempDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue", + "appliedItemIds" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" + }, + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + }, + "appliedItemIds": { "type": "array", "items": { - "type": "string" + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "default": [] + "description": "Ids of the items to which the discount should be applied" + } + } + }, + "AddCartDiscountRequestBody": { + "type": "object", + "required": [ + "discountType", + "discountValue" + ], + "properties": { + "discountType": { + "$ref": "#/components/schemas/DiscountType" }, - "videoGuideToken": { - "anyOf": [ - { - "type": "string" - }, - { - "type": "null" - } - ] + "discountValue": { + "type": "number", + "description": "Value of the discount (leave it 0 if you want to remove the discount)", + "maximum": 0 + } + } + }, + "GuidePresentationStateResponse": { + "type": "object", + "properties": { + "stateForAll": { + "$ref": "#/components/schemas/StateForAll" }, - "quickViewState": { - "type": "array", - "items": { - "type": "string" + "stateForClients": { + "$ref": "#/components/schemas/StateForGuides" + } + }, + "example": { + "extensions": [], + "stateForAll": { + "currentGuideProductId": null, + "lastActiveGuideSection": null, + "currentPageId": null, + "currentSectionId": null, + "currentSlideAlias": 0, + "currentDynamicPage": null, + "started": false, + "running": false, + "ended": false, + "startedAt": null, + "endedAt": null, + "accessibleFrom": { + "date": "2023-08-04 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" }, - "default": [] + "accessibleTo": { + "date": "2023-08-05 00:00:00.000000", + "timezone_type": 3, + "timezone": "UTC" + }, + "appointmentMode": "guided", + "videoAudioSettings": "both", + "videoRoomUrl": "", + "attendeeRestrictionType": "open", + "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", + "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", + "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", + "broadcastMode": false, + "extensions": [] }, - "extensions": { - "type": "array", - "default": [] + "stateForGuides": { + "clients": [], + "inactiveClients": { + "2b4066cd37a341088e32a81e04a56817": { + "attendeeId": "2b4066cd37a341088e32a81e04a56817", + "attendeeName": "Attendee 1", + "videoUserId": null, + "hasJoined": false + }, + "302108ad602b4ac687f5247aae5d0297": { + "attendeeId": "302108ad602b4ac687f5247aae5d0297", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "5a3b4e84acab47119b8a6bceb79e732e": { + "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", + "attendeeName": "Test attende name", + "videoUserId": null, + "hasJoined": true + }, + "b6358241e4ad4a4e99d0f729d21d63be": { + "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", + "attendeeName": null, + "videoUserId": null, + "hasJoined": true + }, + "f1bb9374308d4e088c29d10a2fc8cc07": { + "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", + "attendeeName": null, + "videoUserId": null, + "hasJoined": false + } + }, + "guides": { + "1850bbdc12dc44aba95bc78b16c3643c": { + "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", + "attendeeName": " admin", + "videoUserId": null, + "hasJoined": true + } + }, + "videoGuideToken": null, + "quickViewState": [], + "extensions": [] } } }, @@ -51755,17 +52774,6 @@ } } }, - "DynamicProductListingPageOpenedPayload": { - "required": [ - "page" - ], - "properties": { - "page": { - "type": "integer", - "description": "Current page position in the pagination" - } - } - }, "WidgetProductListing": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", @@ -51816,40 +52824,94 @@ } } }, - "CartListPrice": { + "GetAttendeeInsightsResponse": { "type": "object", - "description": "", + "description": "Returns aggregations for the current attendees within the appointment.", "properties": { - "discount": { - "type": "number" + "attendees": { + "type": "object", + "additionalProperties": { + "$ref": "#/components/schemas/AttendeeInsights" + } }, - "percentage": { - "type": "number" + "currencyId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" }, - "price": { - "type": "number" + "currencySymbol": { + "type": "string" + } + }, + "example": { + "extensions": [], + "attendees": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } }, - "apiAlias": { + "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", + "currencySymbol": "$" + } + }, + "VideoChatCreateStruct": { + "type": "object", + "description": "Includes all data you will need to attend to a appointment.", + "properties": { + "roomUrl": { "type": "string", - "enum": [ - "cart_list_price" - ] + "description": "Url of the video room in daily" + }, + "roomName": { + "type": "string", + "description": "Name of the video room in daily" + }, + "userToken": { + "type": "string", + "description": "Token for the end users to connect to the daily room" + }, + "ownerToken": { + "type": "string", + "description": "Token for the room owner (guide) to connect to the daily room" } }, - "required": [ - "apiAlias" - ] + "example": { + "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", + "userToken": "dummy user token", + "ownerToken": "dummy owner token", + "roomName": "rSq20mrgwsj4eIXo1u95", + "extensions": [] + } }, - "GetListBodyRequest": { + "CartError": { "type": "object", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", "properties": { - "limit": { - "type": "integer", - "description": "Max amount of resources to be returned in a page" - }, - "page": { - "type": "integer", - "description": "The page to be returned" + "items": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "level": { + "type": "number", + "enum": [ + 0, + 10, + 20 + ], + "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" + }, + "message": { + "type": "string" + }, + "messageKey": { + "type": "string" + } + } } } }, @@ -51919,68 +52981,6 @@ "unitName" ] }, - "CartItems": { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - } - } - }, - "AbstractDynamicPageOpenedPayload": { - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "description": "The type of the current dynamic page" - }, - "opened": { - "type": "boolean", - "default": true - } - } - }, - "PresentationCmsPage": { - "allOf": [ - { - "$ref": "#/components/schemas/DsrPresentationCmsPage" - }, - { - "type": "object", - "properties": { - "pickedProductIds": { - "anyOf": [ - { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Product id" - } - }, - { - "type": "null" - } - ], - "description": "The product id is assigned to presentation if it's product listing or instant listing" - } - } - } - ] - }, - "DynamicPageOpenedPayload": { - "allOf": [ - { - "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" - } - ] - }, "StateForAll": { "type": "object", "properties": { @@ -52192,318 +53192,50 @@ } } }, - "CartError": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "items": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "level": { - "type": "number", - "enum": [ - 0, - 10, - 20 - ], - "description": "* `0` - notice,\n* `10` - warning,\n* `20` - error" - }, - "message": { - "type": "string" - }, - "messageKey": { - "type": "string" - } - } - } - } - }, - "GetAttendeeInsightsResponse": { - "type": "object", - "description": "Returns aggregations for the current attendees within the appointment.", - "properties": { - "attendees": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/AttendeeInsights" - } - }, - "currencyId": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "currencySymbol": { - "type": "string" - } - }, - "example": { - "extensions": [], - "attendees": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 - } - }, - "currencyId": "b7d2554b0ce847cd82f3ac9bd1c0dfca", - "currencySymbol": "$" - } - }, - "GuidePresentationStateResponse": { + "StateForGuides": { "type": "object", "properties": { - "stateForAll": { - "$ref": "#/components/schemas/StateForAll" - }, - "stateForClients": { - "$ref": "#/components/schemas/StateForGuides" - } - }, - "example": { - "extensions": [], - "stateForAll": { - "currentGuideProductId": null, - "lastActiveGuideSection": null, - "currentPageId": null, - "currentSectionId": null, - "currentSlideAlias": 0, - "currentDynamicPage": null, - "started": false, - "running": false, - "ended": false, - "startedAt": null, - "endedAt": null, - "accessibleFrom": { - "date": "2023-08-04 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "accessibleTo": { - "date": "2023-08-05 00:00:00.000000", - "timezone_type": 3, - "timezone": "UTC" - }, - "appointmentMode": "guided", - "videoAudioSettings": "both", - "videoRoomUrl": "", - "attendeeRestrictionType": "open", - "productDetailDefaultPageId": "bea211b5099241719830df8026624f7f", - "quickviewPageId": "182d3f7f988044adbba449b70c8bc472", - "productListingDefaultPageId": "33e88c7994fa4cf79a1265e5105b93b2", - "broadcastMode": false, - "extensions": [] - }, - "stateForGuides": { - "clients": [], - "inactiveClients": { - "2b4066cd37a341088e32a81e04a56817": { - "attendeeId": "2b4066cd37a341088e32a81e04a56817", - "attendeeName": "Attendee 1", - "videoUserId": null, - "hasJoined": false - }, - "302108ad602b4ac687f5247aae5d0297": { - "attendeeId": "302108ad602b4ac687f5247aae5d0297", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "5a3b4e84acab47119b8a6bceb79e732e": { - "attendeeId": "5a3b4e84acab47119b8a6bceb79e732e", - "attendeeName": "Test attende name", - "videoUserId": null, - "hasJoined": true - }, - "b6358241e4ad4a4e99d0f729d21d63be": { - "attendeeId": "b6358241e4ad4a4e99d0f729d21d63be", - "attendeeName": null, - "videoUserId": null, - "hasJoined": true - }, - "f1bb9374308d4e088c29d10a2fc8cc07": { - "attendeeId": "f1bb9374308d4e088c29d10a2fc8cc07", - "attendeeName": null, - "videoUserId": null, - "hasJoined": false - } - }, - "guides": { - "1850bbdc12dc44aba95bc78b16c3643c": { - "attendeeId": "1850bbdc12dc44aba95bc78b16c3643c", - "attendeeName": " admin", - "videoUserId": null, - "hasJoined": true - } + "clients": { + "type": "array", + "items": { + "type": "string" }, - "videoGuideToken": null, - "quickViewState": [], - "extensions": [] - } - } - }, - "CartPriceQuantity": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_price_quantity" - ] - }, - "isCalculated": { - "type": "boolean" - }, - "listPrice": { - "$ref": "#/components/schemas/CartListPrice" - }, - "price": { - "type": "number" - }, - "quantity": { - "type": "number" + "default": [] }, - "regulationPrice": { - "properties": { - "price": { - "type": "number", - "format": "float" - } + "inactiveClients": { + "type": "array", + "items": { + "type": "string" }, - "type": "object" + "default": [] }, - "taxRules": { + "guides": { "type": "array", "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } - }, - "type": { - "type": "string" - } - }, - "required": [ - "apiAlias" - ] - }, - "CartDelivery": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } + "type": "string" + }, + "default": [] }, - "location": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "cart_delivery_shipping_location" - ] - }, - "country": { - "$ref": "#/components/schemas/Country" - }, - "address": { - "$ref": "#/components/schemas/CustomerAddress" + "videoGuideToken": { + "anyOf": [ + { + "type": "string" }, - "state": { - "$ref": "#/components/schemas/CountryState" + { + "type": "null" } - } + ] }, - "positions": { + "quickViewState": { "type": "array", "items": { - "$ref": "#/components/schemas/CartDeliveryPosition" - } - }, - "shippingCosts": { - "$ref": "#/components/schemas/CalculatedPrice" - }, - "shippingMethod": { - "$ref": "#/components/schemas/ShippingMethod" - } - } - }, - "VideoChatCreateStruct": { - "type": "object", - "description": "Includes all data you will need to attend to a appointment.", - "properties": { - "roomUrl": { - "type": "string", - "description": "Url of the video room in daily" - }, - "roomName": { - "type": "string", - "description": "Name of the video room in daily" - }, - "userToken": { - "type": "string", - "description": "Token for the end users to connect to the daily room" - }, - "ownerToken": { - "type": "string", - "description": "Token for the room owner (guide) to connect to the daily room" - } - }, - "example": { - "roomUrl": "http://daily.co/rSq20mrgwsj4eIXo1u95", - "userToken": "dummy user token", - "ownerToken": "dummy owner token", - "roomName": "rSq20mrgwsj4eIXo1u95", - "extensions": [] - } - }, - "CartDeliveryPosition": { - "type": "object", - "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", - "properties": { - "deliveryDate": { - "type": "object", - "properties": { - "earliest": { - "type": "string", - "format": "date-time" - }, - "latest": { - "type": "string", - "format": "date-time" - } - } - }, - "identifier": { - "type": "string" - }, - "lineItem": { - "$ref": "#/components/schemas/LineItem" + "type": "string" + }, + "default": [] }, - "price": { - "$ref": "#/components/schemas/CalculatedPrice" + "extensions": { + "type": "array", + "default": [] } } }, @@ -52593,51 +53325,259 @@ }, "nullable": true }, - "hasRange": { - "type": "boolean" + "hasRange": { + "type": "boolean" + }, + "variantId": { + "type": "string", + "format": "^[0-9a-f]{32}$", + "nullable": true + }, + "apiAlias": { + "type": "string", + "enum": [ + "calculated_price" + ] + }, + "taxRules": { + "type": "array", + "description": "Currently active tax rules and/or rates", + "items": { + "type": "object", + "properties": { + "taxRate": { + "type": "number", + "format": "float" + }, + "name": { + "type": "string" + } + } + } + } + }, + "required": [ + "apiAlias", + "hasRange", + "regulationPrice", + "listPrice", + "referencePrice", + "calculatedTaxes", + "totalPrice", + "quantity", + "unitPrice", + "positionPrice", + "netPrice", + "taxRules" + ] + }, + "GetListBodyRequest": { + "type": "object", + "properties": { + "limit": { + "type": "integer", + "description": "Max amount of resources to be returned in a page" + }, + "page": { + "type": "integer", + "description": "The page to be returned" + } + } + }, + "CartDeliveryInformation": { + "type": "object", + "properties": { + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_information" + ] + }, + "freeDelivery": { + "type": "boolean" + }, + "deliveryTime": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "min": { + "type": "integer" + }, + "max": { + "type": "integer" + }, + "unit": { + "type": "string" + }, + "apiAlias": { + "type": "string", + "enum": [ + "cart_delivery_time" + ] + } + } + }, + "height": { + "type": "integer" + }, + "length": { + "type": "integer" + }, + "restockTime": { + "type": "integer" + }, + "stock": { + "type": "integer" + }, + "weight": { + "type": "integer" + }, + "width": { + "type": "integer" + } + }, + "required": [ + "apiAlias" + ] + }, + "CartListPrice": { + "type": "object", + "description": "", + "properties": { + "discount": { + "type": "number" + }, + "percentage": { + "type": "number" }, - "variantId": { - "type": "string", - "format": "^[0-9a-f]{32}$", - "nullable": true + "price": { + "type": "number" }, "apiAlias": { "type": "string", "enum": [ - "calculated_price" + "cart_list_price" ] + } + }, + "required": [ + "apiAlias" + ] + }, + "Cart": { + "type": "object", + "properties": { + "name": { + "description": "Name of the cart - for example `guest-cart`", + "type": "string" }, - "taxRules": { + "token": { + "description": "Context token identifying the cart and the user session", + "type": "string" + }, + "price": { + "$ref": "#/components/schemas/CalculatedPrice" + }, + "lineItems": { + "description": "All items within the cart", + "type": "array", + "items": { + "$ref": "#/components/schemas/LineItem" + } + }, + "errors": { + "type": "array", + "description": "A list of all cart errors, such as insufficient stocks, invalid addresses or vouchers.", + "items": { + "$ref": "#/components/schemas/CartError" + } + }, + "deliveries": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CartDelivery" + } + }, + "transactions": { + "description": "A list of all payment transactions associated with the current cart.", "type": "array", - "description": "Currently active tax rules and/or rates", "items": { "type": "object", "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { + "paymentMethodId": { "type": "string" + }, + "amount": { + "$ref": "#/components/schemas/CalculatedPrice" } } } + }, + "modified": { + "type": "boolean" + }, + "customerComment": { + "type": "string", + "description": "A comment that can be added to the cart.", + "nullable": true + }, + "affiliateCode": { + "type": "string", + "description": "An affiliate tracking code", + "nullable": true + }, + "campaignCode": { + "type": "string", + "description": "A campaign tracking code", + "nullable": true } - }, + } + }, + "AbstractDynamicPageOpenedPayload": { + "type": "object", "required": [ - "apiAlias", - "hasRange", - "regulationPrice", - "listPrice", - "referencePrice", - "calculatedTaxes", - "totalPrice", - "quantity", - "unitPrice", - "positionPrice", - "netPrice", - "taxRules" - ] + "type" + ], + "properties": { + "type": { + "type": "string", + "description": "The type of the current dynamic page" + }, + "opened": { + "type": "boolean", + "default": true + } + } + }, + "AttendeeInsights": { + "type": "object", + "description": "Attendee Insights", + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Id of the attendee" + }, + "cartSum": { + "type": "number", + "description": "Sum of the cart net in base currency" + }, + "productCount": { + "type": "number", + "description": "Sum of all quantities in the cart which were added during the appointment" + } + }, + "example": { + "04da9d8572494ae68391a471d4c3a470": { + "extensions": [], + "id": "04da9d8572494ae68391a471d4c3a470", + "cartSum": 6770.53, + "productCount": 3, + "lineItemCount": 3 + } + } }, "BasePresentationSlideData": { "properties": { @@ -53139,374 +54079,34 @@ "apiAlias": "pwa_page_result" } }, - "LineItemType": { - "type": "string", - "enum": [ - "product", - "credit", - "custom", - "promotion", - "discount", - "container", - "quantity", - "dsr-line-item-discount", - "dsr-cart-discount" - ] - }, - "DiscountLineItemPayload": { - "type": "object", - "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } - } - }, - "LineItem": { - "type": "object", - "properties": { - "children": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LineItem" - } - }, - "cover": { - "$ref": "#/components/schemas/ProductMedia" - }, - "dataContextHash": { - "type": "string" - }, - "dataTimestamp": { - "type": "string" - }, - "deliveryInformation": { - "$ref": "#/components/schemas/CartDeliveryInformation" - }, - "description": { - "type": "string" - }, - "good": { - "type": "boolean" - }, - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "modified": { - "type": "boolean" - }, - "modifiedByApp": { - "type": "boolean" - }, - "payload": { - "allOf": [ - { - "$ref": "#/components/schemas/ProductJsonApi" - }, - { - "type": "object", - "properties": { - "discountType": { - "type": "string", - "enum": [ - "percentage", - "absolute" - ] - }, - "discountValue": { - "type": "number", - "format": "float", - "maximum": 0 - }, - "discountPrice": { - "type": "number", - "format": "float", - "maximum": 0 - } - } - } - ] + "PresentationCmsPage": { + "allOf": [ + { + "$ref": "#/components/schemas/DsrPresentationCmsPage" }, - "extensions": { + { "type": "object", "properties": { - "meta": { - "type": "object", - "properties": { - "attendees": { + "pickedProductIds": { + "anyOf": [ + { "type": "array", "items": { - "type": "object", - "required": [ - "id", - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "id": { - "type": "string" - } - } - } - } - } - } - } - }, - "price": { - "type": "object", - "properties": { - "apiAlias": { - "type": "string", - "enum": [ - "calculated_price" - ] - }, - "calculatedTaxes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "apiAlias": { "type": "string", - "enum": [ - "cart_tax_calculated" - ] - }, - "tax": { - "type": "number" - }, - "taxRate": { - "type": "number" - }, - "price": { - "type": "number" + "pattern": "^[0-9a-f]{32}$", + "description": "Product id" } }, - "required": [ - "apiAlias", - "tax", - "taxRate", - "price" - ] - } - }, - "listPrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartListPrice" - }, - { - "type": "null" - } - ] - }, - "quantity": { - "type": "number" - }, - "referencePrice": { - "oneOf": [ - { - "$ref": "#/components/schemas/CartPriceReference" - }, { "type": "null" } - ] - }, - "regulationPrice": { - "type": "object", - "properties": { - "price": { - "type": "number" - }, - "apiAlias": { - "type": "string", - "enum": [ - "cart_regulation_price" - ] - } - }, - "nullable": true - }, - "totalPrice": { - "type": "number" - }, - "unitPrice": { - "type": "number" - }, - "taxRules": { - "type": "array", - "description": "Currently active tax rules and/or rates", - "items": { - "type": "object", - "properties": { - "taxRate": { - "type": "number", - "format": "float" - }, - "name": { - "type": "string" - } - } - } - } - }, - "required": [ - "apiAlias", - "totalPrice", - "quantity", - "unitPrice" - ] - }, - "priceDefinition": { - "$ref": "#/components/schemas/CartPriceQuantity" - }, - "quantity": { - "type": "number" - }, - "quantityInformation": { - "type": "object", - "properties": { - "maxPurchase": { - "type": "number" - }, - "minPurchase": { - "type": "number" - }, - "purchaseSteps": { - "type": "number" + ], + "description": "The product id is assigned to presentation if it's product listing or instant listing" } } - }, - "referencedId": { - "type": "string" - }, - "removable": { - "type": "boolean" - }, - "stackable": { - "type": "boolean" - }, - "states": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "is-physical", - "is-download" - ] - } - }, - "type": { - "$ref": "#/components/schemas/LineItemType" - }, - "uniqueIdentifier": { - "type": "string" - } - }, - "required": [ - "id", - "type" - ] - }, - "AttendeeInsights": { - "type": "object", - "description": "Attendee Insights", - "properties": { - "id": { - "type": "string", - "pattern": "^[0-9a-f]{32}$", - "description": "Id of the attendee" - }, - "cartSum": { - "type": "number", - "description": "Sum of the cart net in base currency" - }, - "productCount": { - "type": "number", - "description": "Sum of all quantities in the cart which were added during the appointment" - } - }, - "example": { - "04da9d8572494ae68391a471d4c3a470": { - "extensions": [], - "id": "04da9d8572494ae68391a471d4c3a470", - "cartSum": 6770.53, - "productCount": 3, - "lineItemCount": 3 } - } - }, - "DiscountType": { - "type": "string", - "description": "Type of the discount", - "enum": [ - "percentage", - "absolute" ] }, - "AddTempDiscountRequestBody": { - "type": "object", - "required": [ - "discountType", - "discountValue", - "appliedItemIds" - ], - "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" - }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 - }, - "appliedItemIds": { - "type": "array", - "items": { - "type": "string", - "pattern": "^[0-9a-f]{32}$" - }, - "description": "Ids of the items to which the discount should be applied" - } - } - }, - "AddCartDiscountRequestBody": { - "type": "object", - "required": [ - "discountType", - "discountValue" - ], - "properties": { - "discountType": { - "$ref": "#/components/schemas/DiscountType" - }, - "discountValue": { - "type": "number", - "description": "Value of the discount (leave it 0 if you want to remove the discount)", - "maximum": 0 - } - } - }, "JoinAppointmentResponse": { "type": "object", "description": "Includes all data you will need to attend to a appointment.", @@ -53661,6 +54261,13 @@ "isPreview": false, "apiAlias": "swag_digital_sales_rooms_content_appointment_struct_appointment_join_struct" } + }, + "DynamicPageOpenedPayload": { + "allOf": [ + { + "$ref": "#/components/schemas/AbstractDynamicPageOpenedPayload" + } + ] } }, "responses": { diff --git a/SwagDigitalSalesRooms-adminapi.summary.json b/SwagDigitalSalesRooms-adminapi.summary.json index 2fd7e85..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,6 +36,7 @@ "/aggregate/dsr-interaction", "/aggregate/dsr-presentation", "/aggregate/dsr-presentation-cms-page", + "/app-system/shop/verify", "/dsr-appointment", "/dsr-appointment-attendee", "/dsr-appointment-attendee/{id}", @@ -181,6 +189,7 @@ "DynamicProductListingPageOpenedPayload", "EqualsFilter", "Excludes", + "ExternalThumbnail", "Filters", "Flow", "FlowJsonApi", @@ -237,6 +246,7 @@ "MediaFolderConfigurationJsonApi", "MediaFolderConfigurationMediaThumbnailSize", "MediaFolderJsonApi", + "MediaId", "MediaJsonApi", "MediaTag", "MediaThumbnail", From 18422057672a326f29ea2735976e3adaea95e742 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 17 Apr 2026 11:03:11 +0200 Subject: [PATCH 61/63] [create-pull-request] automated change (#476) Co-authored-by: shopwareBot --- SwagCustomizedProducts-adminapi.json | 1159 +++++++++++++----- SwagCustomizedProducts-adminapi.summary.json | 10 + 2 files changed, 893 insertions(+), 276 deletions(-) diff --git a/SwagCustomizedProducts-adminapi.json b/SwagCustomizedProducts-adminapi.json index a86444a..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.8.2" + "version": "6.7.9.0" }, "servers": [ { @@ -5424,6 +5424,442 @@ } } } + }, + "/_action/validation/email": { + "post": { + "tags": [ + "Email support validation" + ], + "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": { + "204": { + "description": "Email is supported" + }, + "400": { + "description": "Invalid request payload. The argument 'email' may be missing.", + "content": { + "application/json": { + "schema": { + "properties": { + "errors": { + "description": "Contains the error message.", + "type": "array" + } + }, + "type": "object" + }, + "example": { + "errors": [ + { + "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": { + "properties": { + "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." + } + ] + } + } + } + } + } + } + }, + "/app-system/shop/verify": { + "get": { + "tags": [ + "App System", + "Public" + ], + "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": "runId", + "in": "query", + "description": "A unique identifier used to look up the token", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "token", + "in": "query", + "description": "A unique identifier", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "An empty response signalling successful verification." + }, + "400": { + "description": "Malformed request or unsuccessful verification." + } + } + } + }, + "/_action/system-config": { + "get": { + "tags": [ + "System Config" + ], + "summary": "Get configuration values", + "description": "Returns the configuration values for the given domain and optional sales channel.", + "operationId": "getConfigurationValues", + "parameters": [ + { + "name": "domain", + "in": "query", + "description": "The configuration domain.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "salesChannelId", + "in": "query", + "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": "Key-value pairs of configuration values to save.", + "required": true, + "content": { + "application/json": { + "schema": { + "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": "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", + "additionalProperties": true + } + } + } + } + }, + "responses": { + "204": { + "description": "Configuration saved successfully." + } + } + } + }, + "/_action/media/{mediaId}/external-thumbnails": { + "post": { + "tags": [ + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "thumbnails": { + "type": "array", + "description": "List of external thumbnails to attach", + "items": { + "$ref": "#/components/schemas/ExternalThumbnail" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Thumbnails attached successfully", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "mediaId": { + "description": "ID of the media entity the thumbnails were attached to.", + "$ref": "#/components/schemas/MediaId" + }, + "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": { + "mediaId": { + "description": "ID of the media entity the thumbnails were deleted from.", + "$ref": "#/components/schemas/MediaId" + } + } + } + } + } + }, + "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": { + "description": "Unauthorized - the access token is missing or invalid." + }, + "403": { + "description": "The authenticated source does not have a user ID associated." + } + } + } } }, "components": { @@ -8447,7 +8883,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -8461,10 +8902,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -8480,7 +8917,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -8522,6 +8965,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -9018,7 +9466,12 @@ }, "type": { "description": "Type of categories like `page`, `folder`, `link`.", - "type": "string" + "type": "string", + "enum": [ + "page", + "link", + "folder" + ] }, "productAssignmentType": { "description": "Type of product assignment: Dynamic product group as or `product_stream` or Manual assignment as `product`.", @@ -9032,10 +9485,6 @@ "description": "When boolean value is `true`, the category is listed for selection.", "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", @@ -9051,7 +9500,13 @@ "type": "object" }, "linkType": { - "type": "string" + "type": "string", + "enum": [ + "category", + "product", + "external", + "landing_page" + ] }, "internalLink": { "type": "string", @@ -9093,6 +9548,11 @@ "type": "string", "pattern": "^[0-9a-f]{32}$" }, + "cmsPageIdSwitched": { + "description": "Runtime field, cannot be used as part of the criteria.", + "type": "boolean", + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -9941,8 +10401,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -10134,8 +10598,12 @@ "format": "int64" }, "type": { - "description": "Types of sections can be `sidebar` or `fullwidth`.", - "type": "string" + "description": "Types of sections can be `default` or `sidebar`.", + "type": "string", + "enum": [ + "default", + "sidebar" + ] }, "locked": { "type": "boolean" @@ -12706,7 +13174,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -13512,7 +13980,7 @@ "format": "date-time" }, "hash": { - "description": "Password hash for customer recovery.", + "description": "Customer registration double opt-in hash for confirming the customer account.", "type": "string" }, "guest": { @@ -15756,6 +16224,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -15766,9 +16237,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -15894,6 +16362,9 @@ "description": "Technical name of document type.", "type": "string" }, + "customFields": { + "type": "object" + }, "createdAt": { "type": "string", "format": "date-time", @@ -15904,9 +16375,6 @@ "format": "date-time", "readOnly": true }, - "customFields": { - "type": "object" - }, "translated": { "type": "object" }, @@ -22023,7 +22491,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -22235,7 +22709,13 @@ }, "status": { "description": "When status is set, the NewsletterRecipient is made visible.", - "type": "string" + "type": "string", + "enum": [ + "notSet", + "optIn", + "optOut", + "direct" + ] }, "hash": { "description": "Password hash for account recovery.", @@ -26084,7 +26564,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -26559,7 +27048,16 @@ }, "type": { "description": "Type refers to the entity type of an item whether it is product or promotion for instance.", - "type": "string" + "type": "string", + "enum": [ + "product", + "credit", + "custom", + "promotion", + "container", + "discount", + "quantity" + ] }, "customFields": { "type": "object" @@ -29293,7 +29791,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -30615,7 +31117,11 @@ }, "type": { "description": "The type of the product, e.g., physical or digital.", - "type": "string" + "type": "string", + "enum": [ + "physical", + "digital" + ] }, "states": { "type": "array", @@ -34180,6 +34686,38 @@ } }, "type": "object" + }, + "products": { + "description": "Products this product stream includes", + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/product-stream/8f4cdc10a7afbd7f3948c6f8cd5c4801/products" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "product" + }, + "id": { + "type": "string", + "example": "86024cad1e83101d97359d7351051156" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -34258,6 +34796,13 @@ "items": { "$ref": "#/components/schemas/Category" } + }, + "products": { + "description": "Products this product stream includes", + "type": "array", + "items": { + "$ref": "#/components/schemas/Product" + } } }, "type": "object" @@ -40998,7 +41543,12 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -41141,7 +41691,12 @@ }, "routeName": { "description": "A destination routeName that has been registered somewhere in the app's router. For example: \\\\\"frontend.detail.page\\\\\"", - "type": "string" + "type": "string", + "enum": [ + "frontend.detail.page", + "frontend.navigation.page", + "frontend.landing.page" + ] }, "pathInfo": { "description": "Path to product URL. For example: \\\\\"/detail/bbf36734504741c79a3bbe3795b91564\\\\\"", @@ -49170,6 +49725,97 @@ }, "type": "object" }, + "ConsentState": { + "type": "object", + "required": [ + "name", + "scopeName", + "identifier", + "status", + "actor", + "updatedAt", + "acceptedUntil" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the consent" + }, + "scopeName": { + "type": "string", + "description": "The scope of the consent that defines how the identifier is resolved" + }, + "identifier": { + "type": "string", + "description": "The resolved identifier of the consent" + }, + "status": { + "type": "string", + "enum": [ + "unset", + "accepted", + "revoked" + ], + "description": "The current status of the consent (requested, accepted, revoked)" + }, + "actor": { + "type": [ + "string", + "null" + ], + "description": "The user name of the user who made the consent decision. null if never updated" + }, + "updatedAt": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp of when the consent status was last updated. null if never updated" + }, + "acceptedUntil": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The timestamp until when the consent is accepted. null if never accepted" + } + } + }, + "MediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "Media entity ID" + }, + "ExternalThumbnail": { + "type": "object", + "description": "An external thumbnail URL with its dimensions. Used when a CDN provides pre-generated thumbnails alongside the main media file.", + "required": [ + "url", + "width", + "height" + ], + "properties": { + "url": { + "type": "string", + "description": "Absolute HTTP/HTTPS URL of the thumbnail", + "example": "https://cdn.example.com/image-200x200.jpg" + }, + "width": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Width of the thumbnail in pixels", + "example": 200 + }, + "height": { + "type": "integer", + "exclusiveMinimum": 0, + "description": "Height of the thumbnail in pixels", + "example": 200 + } + } + }, "infoConfigResponse": { "type": "object", "properties": { @@ -49335,6 +49981,13 @@ "type": "boolean", "description": "True if at least one installed app requires a reachable APP_URL." }, + "firstMigrationDate": { + "type": [ + "string", + "null" + ], + "description": "Timestamp of the first executed migration in ISO-8601 UTC format, used for Product Analytics consent eligibility." + }, "private_allowed_extensions": { "type": "array", "description": "Whitelisted file extensions for private filesystem uploads.", @@ -49355,6 +50008,9 @@ "description": "True if runtime extension management is disabled." } }, + "required": [ + "firstMigrationDate" + ], "additionalProperties": false }, "inAppPurchases": { @@ -49378,200 +50034,6 @@ ], "additionalProperties": false }, - "flowBuilderActionsResponse": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the flow action" - }, - "requirements": { - "type": "array", - "description": "When requirement fit with aware from `events.json` actions will be shown", - "items": { - "type": "string" - } - }, - "extensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Extensions data of event" - } - } - } - }, - "MeasurementUnits": { - "type": "object", - "description": "Configuration of the measurement system", - "properties": { - "system": { - "type": "string", - "enum": [ - "metric", - "imperial" - ], - "default": "metric", - "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." - }, - "units": { - "type": "object", - "description": "Units used in the measurement system.", - "properties": { - "length": { - "type": "string", - "enum": [ - "mm", - "cm", - "m", - "in", - "ft" - ], - "default": "mm", - "description": "Unit of length." - }, - "weight": { - "type": "string", - "enum": [ - "g", - "kg", - "oz", - "lb" - ], - "default": "kg", - "description": "Unit of weight." - } - } - } - } - }, - "OAuthScopes": { - "description": "OAuth scopes that should be requested.", - "type": "string", - "enum": [ - "write", - "user-verified", - "admin", - "write user-verified", - "write admin", - "user-verified admin", - "write user-verified admin" - ] - }, - "OAuthGrant": { - "type": "object", - "properties": { - "grant_type": { - "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", - "type": "string" - } - }, - "required": [ - "grant_type" - ], - "discriminator": { - "propertyName": "grant_type", - "mapping": { - "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", - "password": "#/components/schemas/OAuthPasswordGrant", - "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" - } - } - }, - "OAuthClientCredentialsGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string" - }, - "client_secret": { - "description": "Password of the client that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "client_secret" - ] - } - ] - }, - "OAuthPasswordGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "username": { - "description": "Username of the user that should be authenticated.", - "type": "string" - }, - "password": { - "description": "Password of the user that should be authenticated.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "username", - "password" - ] - } - ] - }, - "OAuthRefreshTokenGrant": { - "allOf": [ - { - "$ref": "#/components/schemas/OAuthGrant" - }, - { - "type": "object", - "properties": { - "client_id": { - "description": "OAuth client id.", - "type": "string", - "enum": [ - "administration" - ] - }, - "scope": { - "$ref": "#/components/schemas/OAuthScopes" - }, - "refresh_token": { - "description": "The refresh token that should be used to refresh the access token.", - "type": "string" - } - }, - "required": [ - "client_id", - "scope", - "refresh_token" - ] - } - ] - }, "businessEventsResponse": { "type": "array", "items": { @@ -50312,6 +50774,200 @@ "field" ] }, + "flowBuilderActionsResponse": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the flow action" + }, + "requirements": { + "type": "array", + "description": "When requirement fit with aware from `events.json` actions will be shown", + "items": { + "type": "string" + } + }, + "extensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Extensions data of event" + } + } + } + }, + "OAuthScopes": { + "description": "OAuth scopes that should be requested.", + "type": "string", + "enum": [ + "write", + "user-verified", + "admin", + "write user-verified", + "write admin", + "user-verified admin", + "write user-verified admin" + ] + }, + "OAuthGrant": { + "type": "object", + "properties": { + "grant_type": { + "description": "OAuth grant type that should be requested. See [OAuth 2.0 grant](https://oauth2.thephpleague.com/authorization-server/which-grant/) for more information.", + "type": "string" + } + }, + "required": [ + "grant_type" + ], + "discriminator": { + "propertyName": "grant_type", + "mapping": { + "client_credentials": "#/components/schemas/OAuthClientCredentialsGrant", + "password": "#/components/schemas/OAuthPasswordGrant", + "refresh_token": "#/components/schemas/OAuthRefreshTokenGrant" + } + } + }, + "OAuthClientCredentialsGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string" + }, + "client_secret": { + "description": "Password of the client that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "client_secret" + ] + } + ] + }, + "OAuthPasswordGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "username": { + "description": "Username of the user that should be authenticated.", + "type": "string" + }, + "password": { + "description": "Password of the user that should be authenticated.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "username", + "password" + ] + } + ] + }, + "OAuthRefreshTokenGrant": { + "allOf": [ + { + "$ref": "#/components/schemas/OAuthGrant" + }, + { + "type": "object", + "properties": { + "client_id": { + "description": "OAuth client id.", + "type": "string", + "enum": [ + "administration" + ] + }, + "scope": { + "$ref": "#/components/schemas/OAuthScopes" + }, + "refresh_token": { + "description": "The refresh token that should be used to refresh the access token.", + "type": "string" + } + }, + "required": [ + "client_id", + "scope", + "refresh_token" + ] + } + ] + }, + "MeasurementUnits": { + "type": "object", + "description": "Configuration of the measurement system", + "properties": { + "system": { + "type": "string", + "enum": [ + "metric", + "imperial" + ], + "default": "metric", + "description": "The measurement system used in the store. 'metric' for metric system, 'imperial' for imperial system." + }, + "units": { + "type": "object", + "description": "Units used in the measurement system.", + "properties": { + "length": { + "type": "string", + "enum": [ + "mm", + "cm", + "m", + "in", + "ft" + ], + "default": "mm", + "description": "Unit of length." + }, + "weight": { + "type": "string", + "enum": [ + "g", + "kg", + "oz", + "lb" + ], + "default": "kg", + "description": "Unit of weight." + } + } + } + } + }, "Price": { "type": "object", "description": "Price object", @@ -50393,55 +51049,6 @@ "net", "linked" ] - }, - "ConsentState": { - "type": "object", - "required": [ - "name", - "scopeName", - "identifier", - "status", - "actor", - "updatedAt" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the consent" - }, - "scopeName": { - "type": "string", - "description": "The scope of the consent that defines how the identifier is resolved" - }, - "identifier": { - "type": "string", - "description": "The resolved identifier of the consent" - }, - "status": { - "type": "string", - "enum": [ - "unset", - "accepted", - "revoked" - ], - "description": "The current status of the consent (requested, accepted, revoked)" - }, - "actor": { - "type": [ - "string", - "null" - ], - "description": "The user name of the user who made the consent decision. null if never updated" - }, - "updatedAt": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "The timestamp of when the consent status was last updated. null if never updated" - } - } } }, "responses": { diff --git a/SwagCustomizedProducts-adminapi.summary.json b/SwagCustomizedProducts-adminapi.summary.json index 6b55267..e780cc7 100644 --- a/SwagCustomizedProducts-adminapi.summary.json +++ b/SwagCustomizedProducts-adminapi.summary.json @@ -1,5 +1,12 @@ { "paths": [ + "/_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", @@ -10,6 +17,7 @@ "/aggregate/swag-customized-products-template-option-price", "/aggregate/swag-customized-products-template-option-value", "/aggregate/swag-customized-products-template-option-value-price", + "/app-system/shop/verify", "/search/swag-customized-products-template", "/search/swag-customized-products-template-configuration", "/search/swag-customized-products-template-configuration-share", @@ -128,6 +136,7 @@ "DocumentTypeJsonApi", "EqualsFilter", "Excludes", + "ExternalThumbnail", "Filters", "Flow", "FlowJsonApi", @@ -177,6 +186,7 @@ "MediaFolderConfigurationJsonApi", "MediaFolderConfigurationMediaThumbnailSize", "MediaFolderJsonApi", + "MediaId", "MediaJsonApi", "MediaTag", "MediaThumbnail", From 1648f2383cda71e423d06c0612924754e4ea8ade Mon Sep 17 00:00:00 2001 From: shopwareBot Date: Fri, 1 May 2026 10:35:25 +0000 Subject: [PATCH 62/63] [create-pull-request] automated change --- SwagCommercial-adminapi.json | 4730 +++++++++++++------------- SwagCommercial-adminapi.summary.json | 16 +- 2 files changed, 2336 insertions(+), 2410 deletions(-) diff --git a/SwagCommercial-adminapi.json b/SwagCommercial-adminapi.json index 22c2de5..9deb9a0 100644 --- a/SwagCommercial-adminapi.json +++ b/SwagCommercial-adminapi.json @@ -18423,14 +18423,14 @@ } } }, - "/media-ai-tag": { + "/document-file": { "get": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "List with basic information of Media Ai Tag resources.", - "description": "", - "operationId": "getMediaAiTagList", + "summary": "List with basic information of Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "getDocumentFileList", "parameters": [ { "name": "limit", @@ -18459,7 +18459,7 @@ ], "responses": { "200": { - "description": "List of Media Ai Tag resources.", + "description": "List of Document File resources.", "content": { "application/vnd.api+json": { "schema": { @@ -18478,7 +18478,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } ] @@ -18492,16 +18492,16 @@ "type": "object", "properties": { "first": { - "example": "/media-ai-tag?limit=25" + "example": "/document-file?limit=25" }, "last": { - "example": "/media-ai-tag?limit=25&page=11" + "example": "/document-file?limit=25&page=11" }, "next": { - "example": "/media-ai-tag?limit=25&page=4" + "example": "/document-file?limit=25&page=4" }, "prev": { - "example": "/media-ai-tag?limit=25&page=2" + "example": "/document-file?limit=25&page=2" } } } @@ -18522,7 +18522,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18537,11 +18537,11 @@ }, "post": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "Create a new Media Ai Tag resources.", - "description": "", - "operationId": "createMediaAiTag", + "summary": "Create a new Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "createDocumentFile", "parameters": [ { "name": "_response", @@ -18560,14 +18560,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -18579,7 +18579,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18594,7 +18594,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18610,14 +18610,14 @@ } } }, - "/search/media-ai-tag": { + "/search/document-file": { "post": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "Search for the Media Ai Tag resources.", - "description": "", - "operationId": "searchMediaAiTag", + "summary": "Search for the Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "searchDocumentFile", "parameters": [ { "name": "sw-include-search-info", @@ -18645,7 +18645,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -18659,7 +18659,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18677,7 +18677,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18694,19 +18694,19 @@ } } }, - "/media-ai-tag/{id}": { + "/document-file/{id}": { "get": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "Detailed information about a Media Ai Tag resource.", - "description": "", - "operationId": "getMediaAiTag", + "summary": "Detailed information about a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "getDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -18716,7 +18716,7 @@ ], "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -18728,7 +18728,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18743,7 +18743,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18760,16 +18760,16 @@ }, "delete": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "Delete a Media Ai Tag resource.", - "description": "", - "operationId": "deleteMediaAiTag", + "summary": "Delete a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "deleteDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -18800,16 +18800,16 @@ }, "patch": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "Partially update information about a Media Ai Tag resource.", - "description": "", - "operationId": "updateMediaAiTag", + "summary": "Partially update information about a Document File resource.", + "description": "Available since: 6.7.10.0", + "operationId": "updateDocumentFile", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the media_ai_tag", + "description": "Identifier for the document_file", "required": true, "schema": { "type": "string", @@ -18827,18 +18827,18 @@ } ], "requestBody": { - "description": "Partially update information about a Media Ai Tag resource.", + "description": "Partially update information about a Document File resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } }, "responses": { "200": { - "description": "Detail of MediaAiTag", + "description": "Detail of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -18850,7 +18850,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18865,7 +18865,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18884,14 +18884,14 @@ } } }, - "/aggregate/media-ai-tag": { + "/aggregate/document-file": { "post": { "tags": [ - "Media Ai Tag" + "Document File" ], - "summary": "Aggregate for the Media Ai Tag resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateMediaAiTag", + "summary": "Aggregate for the Document File resources.", + "description": "Available since: 6.7.10.0", + "operationId": "aggregateDocumentFile", "requestBody": { "required": true, "content": { @@ -18915,7 +18915,7 @@ }, "responses": { "200": { - "description": "List of MediaAiTag", + "description": "List of DocumentFile", "content": { "application/vnd.api+json": { "schema": { @@ -18929,7 +18929,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18947,7 +18947,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/MediaAiTag" + "$ref": "#/components/schemas/DocumentFile" } } } @@ -18964,14 +18964,14 @@ } } }, - "/order-product-warehouse": { + "/media-ai-tag": { "get": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "List with basic information of Order Product Warehouse resources.", + "summary": "List with basic information of Media Ai Tag resources.", "description": "", - "operationId": "getOrderProductWarehouseList", + "operationId": "getMediaAiTagList", "parameters": [ { "name": "limit", @@ -19000,7 +19000,7 @@ ], "responses": { "200": { - "description": "List of Order Product Warehouse resources.", + "description": "List of Media Ai Tag resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19019,7 +19019,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } ] @@ -19033,16 +19033,16 @@ "type": "object", "properties": { "first": { - "example": "/order-product-warehouse?limit=25" + "example": "/media-ai-tag?limit=25" }, "last": { - "example": "/order-product-warehouse?limit=25&page=11" + "example": "/media-ai-tag?limit=25&page=11" }, "next": { - "example": "/order-product-warehouse?limit=25&page=4" + "example": "/media-ai-tag?limit=25&page=4" }, "prev": { - "example": "/order-product-warehouse?limit=25&page=2" + "example": "/media-ai-tag?limit=25&page=2" } } } @@ -19063,7 +19063,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19078,11 +19078,11 @@ }, "post": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "Create a new Order Product Warehouse resources.", + "summary": "Create a new Media Ai Tag resources.", "description": "", - "operationId": "createOrderProductWarehouse", + "operationId": "createMediaAiTag", "parameters": [ { "name": "_response", @@ -19101,14 +19101,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -19120,7 +19120,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19135,7 +19135,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19151,14 +19151,14 @@ } } }, - "/search/order-product-warehouse": { + "/search/media-ai-tag": { "post": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "Search for the Order Product Warehouse resources.", + "summary": "Search for the Media Ai Tag resources.", "description": "", - "operationId": "searchOrderProductWarehouse", + "operationId": "searchMediaAiTag", "parameters": [ { "name": "sw-include-search-info", @@ -19186,7 +19186,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -19200,7 +19200,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19218,7 +19218,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19235,19 +19235,19 @@ } } }, - "/order-product-warehouse/{id}": { + "/media-ai-tag/{id}": { "get": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "Detailed information about a Order Product Warehouse resource.", + "summary": "Detailed information about a Media Ai Tag resource.", "description": "", - "operationId": "getOrderProductWarehouse", + "operationId": "getMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -19257,7 +19257,7 @@ ], "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -19269,7 +19269,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19284,7 +19284,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19301,16 +19301,16 @@ }, "delete": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "Delete a Order Product Warehouse resource.", + "summary": "Delete a Media Ai Tag resource.", "description": "", - "operationId": "deleteOrderProductWarehouse", + "operationId": "deleteMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -19341,16 +19341,16 @@ }, "patch": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "Partially update information about a Order Product Warehouse resource.", + "summary": "Partially update information about a Media Ai Tag resource.", "description": "", - "operationId": "updateOrderProductWarehouse", + "operationId": "updateMediaAiTag", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_product_warehouse", + "description": "Identifier for the media_ai_tag", "required": true, "schema": { "type": "string", @@ -19368,18 +19368,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Product Warehouse resource.", + "description": "Partially update information about a Media Ai Tag resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } }, "responses": { "200": { - "description": "Detail of OrderProductWarehouse", + "description": "Detail of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -19391,7 +19391,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19406,7 +19406,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19425,14 +19425,14 @@ } } }, - "/aggregate/order-product-warehouse": { + "/aggregate/media-ai-tag": { "post": { "tags": [ - "Order Product Warehouse" + "Media Ai Tag" ], - "summary": "Aggregate for the Order Product Warehouse resources.", + "summary": "Aggregate for the Media Ai Tag resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderProductWarehouse", + "operationId": "aggregateMediaAiTag", "requestBody": { "required": true, "content": { @@ -19456,7 +19456,7 @@ }, "responses": { "200": { - "description": "List of OrderProductWarehouse", + "description": "List of MediaAiTag", "content": { "application/vnd.api+json": { "schema": { @@ -19470,7 +19470,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19488,7 +19488,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderProductWarehouse" + "$ref": "#/components/schemas/MediaAiTag" } } } @@ -19505,14 +19505,14 @@ } } }, - "/order-return": { + "/order-product-warehouse": { "get": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "List with basic information of Order Return resources.", + "summary": "List with basic information of Order Product Warehouse resources.", "description": "", - "operationId": "getOrderReturnList", + "operationId": "getOrderProductWarehouseList", "parameters": [ { "name": "limit", @@ -19541,7 +19541,7 @@ ], "responses": { "200": { - "description": "List of Order Return resources.", + "description": "List of Order Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -19560,7 +19560,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } ] @@ -19574,16 +19574,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return?limit=25" + "example": "/order-product-warehouse?limit=25" }, "last": { - "example": "/order-return?limit=25&page=11" + "example": "/order-product-warehouse?limit=25&page=11" }, "next": { - "example": "/order-return?limit=25&page=4" + "example": "/order-product-warehouse?limit=25&page=4" }, "prev": { - "example": "/order-return?limit=25&page=2" + "example": "/order-product-warehouse?limit=25&page=2" } } } @@ -19604,7 +19604,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19619,11 +19619,11 @@ }, "post": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "Create a new Order Return resources.", + "summary": "Create a new Order Product Warehouse resources.", "description": "", - "operationId": "createOrderReturn", + "operationId": "createOrderProductWarehouse", "parameters": [ { "name": "_response", @@ -19642,14 +19642,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19661,7 +19661,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19676,7 +19676,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19692,14 +19692,14 @@ } } }, - "/search/order-return": { + "/search/order-product-warehouse": { "post": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "Search for the Order Return resources.", + "summary": "Search for the Order Product Warehouse resources.", "description": "", - "operationId": "searchOrderReturn", + "operationId": "searchOrderProductWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -19727,7 +19727,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19741,7 +19741,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19759,7 +19759,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19776,19 +19776,19 @@ } } }, - "/order-return/{id}": { + "/order-product-warehouse/{id}": { "get": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "Detailed information about a Order Return resource.", + "summary": "Detailed information about a Order Product Warehouse resource.", "description": "", - "operationId": "getOrderReturn", + "operationId": "getOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19798,7 +19798,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19810,7 +19810,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19825,7 +19825,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19842,16 +19842,16 @@ }, "delete": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "Delete a Order Return resource.", + "summary": "Delete a Order Product Warehouse resource.", "description": "", - "operationId": "deleteOrderReturn", + "operationId": "deleteOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19882,16 +19882,16 @@ }, "patch": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "Partially update information about a Order Return resource.", + "summary": "Partially update information about a Order Product Warehouse resource.", "description": "", - "operationId": "updateOrderReturn", + "operationId": "updateOrderProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return", + "description": "Identifier for the order_product_warehouse", "required": true, "schema": { "type": "string", @@ -19909,18 +19909,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return resource.", + "description": "Partially update information about a Order Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of OrderReturn", + "description": "Detail of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -19932,7 +19932,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19947,7 +19947,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -19966,14 +19966,14 @@ } } }, - "/aggregate/order-return": { + "/aggregate/order-product-warehouse": { "post": { "tags": [ - "Order Return" + "Order Product Warehouse" ], - "summary": "Aggregate for the Order Return resources.", + "summary": "Aggregate for the Order Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturn", + "operationId": "aggregateOrderProductWarehouse", "requestBody": { "required": true, "content": { @@ -19997,7 +19997,7 @@ }, "responses": { "200": { - "description": "List of OrderReturn", + "description": "List of OrderProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -20011,7 +20011,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -20029,7 +20029,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturn" + "$ref": "#/components/schemas/OrderProductWarehouse" } } } @@ -20046,14 +20046,14 @@ } } }, - "/order-return-line-item": { + "/order-return": { "get": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "List with basic information of Order Return Line Item resources.", + "summary": "List with basic information of Order Return resources.", "description": "", - "operationId": "getOrderReturnLineItemList", + "operationId": "getOrderReturnList", "parameters": [ { "name": "limit", @@ -20082,7 +20082,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item resources.", + "description": "List of Order Return resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20101,7 +20101,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } ] @@ -20115,16 +20115,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item?limit=25" + "example": "/order-return?limit=25" }, "last": { - "example": "/order-return-line-item?limit=25&page=11" + "example": "/order-return?limit=25&page=11" }, "next": { - "example": "/order-return-line-item?limit=25&page=4" + "example": "/order-return?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item?limit=25&page=2" + "example": "/order-return?limit=25&page=2" } } } @@ -20145,7 +20145,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20160,11 +20160,11 @@ }, "post": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "Create a new Order Return Line Item resources.", + "summary": "Create a new Order Return resources.", "description": "", - "operationId": "createOrderReturnLineItem", + "operationId": "createOrderReturn", "parameters": [ { "name": "_response", @@ -20183,14 +20183,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -20202,7 +20202,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20217,7 +20217,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20233,14 +20233,14 @@ } } }, - "/search/order-return-line-item": { + "/search/order-return": { "post": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "Search for the Order Return Line Item resources.", + "summary": "Search for the Order Return resources.", "description": "", - "operationId": "searchOrderReturnLineItem", + "operationId": "searchOrderReturn", "parameters": [ { "name": "sw-include-search-info", @@ -20268,7 +20268,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -20282,7 +20282,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20300,7 +20300,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20317,19 +20317,19 @@ } } }, - "/order-return-line-item/{id}": { + "/order-return/{id}": { "get": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "Detailed information about a Order Return Line Item resource.", + "summary": "Detailed information about a Order Return resource.", "description": "", - "operationId": "getOrderReturnLineItem", + "operationId": "getOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -20339,7 +20339,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -20351,7 +20351,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20366,7 +20366,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20383,16 +20383,16 @@ }, "delete": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "Delete a Order Return Line Item resource.", + "summary": "Delete a Order Return resource.", "description": "", - "operationId": "deleteOrderReturnLineItem", + "operationId": "deleteOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -20423,16 +20423,16 @@ }, "patch": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "Partially update information about a Order Return Line Item resource.", + "summary": "Partially update information about a Order Return resource.", "description": "", - "operationId": "updateOrderReturnLineItem", + "operationId": "updateOrderReturn", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item", + "description": "Identifier for the order_return", "required": true, "schema": { "type": "string", @@ -20450,18 +20450,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item resource.", + "description": "Partially update information about a Order Return resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItem", + "description": "Detail of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -20473,7 +20473,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20488,7 +20488,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20507,14 +20507,14 @@ } } }, - "/aggregate/order-return-line-item": { + "/aggregate/order-return": { "post": { "tags": [ - "Order Return Line Item" + "Order Return" ], - "summary": "Aggregate for the Order Return Line Item resources.", + "summary": "Aggregate for the Order Return resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItem", + "operationId": "aggregateOrderReturn", "requestBody": { "required": true, "content": { @@ -20538,7 +20538,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItem", + "description": "List of OrderReturn", "content": { "application/vnd.api+json": { "schema": { @@ -20552,7 +20552,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20570,7 +20570,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItem" + "$ref": "#/components/schemas/OrderReturn" } } } @@ -20587,14 +20587,14 @@ } } }, - "/order-return-line-item-reason": { + "/order-return-line-item": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "List with basic information of Order Return Line Item Reason resources.", + "summary": "List with basic information of Order Return Line Item resources.", "description": "", - "operationId": "getOrderReturnLineItemReasonList", + "operationId": "getOrderReturnLineItemList", "parameters": [ { "name": "limit", @@ -20623,7 +20623,7 @@ ], "responses": { "200": { - "description": "List of Order Return Line Item Reason resources.", + "description": "List of Order Return Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -20642,7 +20642,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } ] @@ -20656,16 +20656,16 @@ "type": "object", "properties": { "first": { - "example": "/order-return-line-item-reason?limit=25" + "example": "/order-return-line-item?limit=25" }, "last": { - "example": "/order-return-line-item-reason?limit=25&page=11" + "example": "/order-return-line-item?limit=25&page=11" }, "next": { - "example": "/order-return-line-item-reason?limit=25&page=4" + "example": "/order-return-line-item?limit=25&page=4" }, "prev": { - "example": "/order-return-line-item-reason?limit=25&page=2" + "example": "/order-return-line-item?limit=25&page=2" } } } @@ -20686,7 +20686,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20701,11 +20701,11 @@ }, "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "Create a new Order Return Line Item Reason resources.", + "summary": "Create a new Order Return Line Item resources.", "description": "", - "operationId": "createOrderReturnLineItemReason", + "operationId": "createOrderReturnLineItem", "parameters": [ { "name": "_response", @@ -20724,14 +20724,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20743,7 +20743,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20758,7 +20758,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20774,14 +20774,14 @@ } } }, - "/search/order-return-line-item-reason": { + "/search/order-return-line-item": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "Search for the Order Return Line Item Reason resources.", + "summary": "Search for the Order Return Line Item resources.", "description": "", - "operationId": "searchOrderReturnLineItemReason", + "operationId": "searchOrderReturnLineItem", "parameters": [ { "name": "sw-include-search-info", @@ -20809,7 +20809,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20823,7 +20823,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20841,7 +20841,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20858,19 +20858,19 @@ } } }, - "/order-return-line-item-reason/{id}": { + "/order-return-line-item/{id}": { "get": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "Detailed information about a Order Return Line Item Reason resource.", + "summary": "Detailed information about a Order Return Line Item resource.", "description": "", - "operationId": "getOrderReturnLineItemReason", + "operationId": "getOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20880,7 +20880,7 @@ ], "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -20892,7 +20892,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20907,7 +20907,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -20924,16 +20924,16 @@ }, "delete": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "Delete a Order Return Line Item Reason resource.", + "summary": "Delete a Order Return Line Item resource.", "description": "", - "operationId": "deleteOrderReturnLineItemReason", + "operationId": "deleteOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20964,16 +20964,16 @@ }, "patch": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "Partially update information about a Order Return Line Item Reason resource.", + "summary": "Partially update information about a Order Return Line Item resource.", "description": "", - "operationId": "updateOrderReturnLineItemReason", + "operationId": "updateOrderReturnLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_return_line_item_reason", + "description": "Identifier for the order_return_line_item", "required": true, "schema": { "type": "string", @@ -20991,18 +20991,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Return Line Item Reason resource.", + "description": "Partially update information about a Order Return Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } }, "responses": { "200": { - "description": "Detail of OrderReturnLineItemReason", + "description": "Detail of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -21014,7 +21014,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -21029,7 +21029,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -21048,14 +21048,14 @@ } } }, - "/aggregate/order-return-line-item-reason": { + "/aggregate/order-return-line-item": { "post": { "tags": [ - "Order Return Line Item Reason" + "Order Return Line Item" ], - "summary": "Aggregate for the Order Return Line Item Reason resources.", + "summary": "Aggregate for the Order Return Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderReturnLineItemReason", + "operationId": "aggregateOrderReturnLineItem", "requestBody": { "required": true, "content": { @@ -21079,7 +21079,7 @@ }, "responses": { "200": { - "description": "List of OrderReturnLineItemReason", + "description": "List of OrderReturnLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -21093,7 +21093,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -21111,7 +21111,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderReturnLineItemReason" + "$ref": "#/components/schemas/OrderReturnLineItem" } } } @@ -21128,14 +21128,14 @@ } } }, - "/order-warehouse-group": { + "/order-return-line-item-reason": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "List with basic information of Order Warehouse Group resources.", + "summary": "List with basic information of Order Return Line Item Reason resources.", "description": "", - "operationId": "getOrderWarehouseGroupList", + "operationId": "getOrderReturnLineItemReasonList", "parameters": [ { "name": "limit", @@ -21164,7 +21164,7 @@ ], "responses": { "200": { - "description": "List of Order Warehouse Group resources.", + "description": "List of Order Return Line Item Reason resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21183,7 +21183,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } ] @@ -21197,16 +21197,16 @@ "type": "object", "properties": { "first": { - "example": "/order-warehouse-group?limit=25" + "example": "/order-return-line-item-reason?limit=25" }, "last": { - "example": "/order-warehouse-group?limit=25&page=11" + "example": "/order-return-line-item-reason?limit=25&page=11" }, "next": { - "example": "/order-warehouse-group?limit=25&page=4" + "example": "/order-return-line-item-reason?limit=25&page=4" }, "prev": { - "example": "/order-warehouse-group?limit=25&page=2" + "example": "/order-return-line-item-reason?limit=25&page=2" } } } @@ -21227,7 +21227,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21242,11 +21242,11 @@ }, "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "Create a new Order Warehouse Group resources.", + "summary": "Create a new Order Return Line Item Reason resources.", "description": "", - "operationId": "createOrderWarehouseGroup", + "operationId": "createOrderReturnLineItemReason", "parameters": [ { "name": "_response", @@ -21265,14 +21265,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21284,7 +21284,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21299,7 +21299,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21315,14 +21315,14 @@ } } }, - "/search/order-warehouse-group": { + "/search/order-return-line-item-reason": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "Search for the Order Warehouse Group resources.", + "summary": "Search for the Order Return Line Item Reason resources.", "description": "", - "operationId": "searchOrderWarehouseGroup", + "operationId": "searchOrderReturnLineItemReason", "parameters": [ { "name": "sw-include-search-info", @@ -21350,7 +21350,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21364,7 +21364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21382,7 +21382,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21399,19 +21399,19 @@ } } }, - "/order-warehouse-group/{id}": { + "/order-return-line-item-reason/{id}": { "get": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "Detailed information about a Order Warehouse Group resource.", + "summary": "Detailed information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "getOrderWarehouseGroup", + "operationId": "getOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -21421,7 +21421,7 @@ ], "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21433,7 +21433,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21448,7 +21448,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21465,16 +21465,16 @@ }, "delete": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "Delete a Order Warehouse Group resource.", + "summary": "Delete a Order Return Line Item Reason resource.", "description": "", - "operationId": "deleteOrderWarehouseGroup", + "operationId": "deleteOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -21505,16 +21505,16 @@ }, "patch": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "Partially update information about a Order Warehouse Group resource.", + "summary": "Partially update information about a Order Return Line Item Reason resource.", "description": "", - "operationId": "updateOrderWarehouseGroup", + "operationId": "updateOrderReturnLineItemReason", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the order_warehouse_group", + "description": "Identifier for the order_return_line_item_reason", "required": true, "schema": { "type": "string", @@ -21532,18 +21532,18 @@ } ], "requestBody": { - "description": "Partially update information about a Order Warehouse Group resource.", + "description": "Partially update information about a Order Return Line Item Reason resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } }, "responses": { "200": { - "description": "Detail of OrderWarehouseGroup", + "description": "Detail of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21555,7 +21555,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21570,7 +21570,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21589,14 +21589,14 @@ } } }, - "/aggregate/order-warehouse-group": { + "/aggregate/order-return-line-item-reason": { "post": { "tags": [ - "Order Warehouse Group" + "Order Return Line Item Reason" ], - "summary": "Aggregate for the Order Warehouse Group resources.", + "summary": "Aggregate for the Order Return Line Item Reason resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateOrderWarehouseGroup", + "operationId": "aggregateOrderReturnLineItemReason", "requestBody": { "required": true, "content": { @@ -21620,7 +21620,7 @@ }, "responses": { "200": { - "description": "List of OrderWarehouseGroup", + "description": "List of OrderReturnLineItemReason", "content": { "application/vnd.api+json": { "schema": { @@ -21634,7 +21634,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21652,7 +21652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/OrderWarehouseGroup" + "$ref": "#/components/schemas/OrderReturnLineItemReason" } } } @@ -21669,14 +21669,14 @@ } } }, - "/product-review-summary": { + "/order-warehouse-group": { "get": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "List with basic information of Product Review Summary resources.", + "summary": "List with basic information of Order Warehouse Group resources.", "description": "", - "operationId": "getProductReviewSummaryList", + "operationId": "getOrderWarehouseGroupList", "parameters": [ { "name": "limit", @@ -21705,7 +21705,7 @@ ], "responses": { "200": { - "description": "List of Product Review Summary resources.", + "description": "List of Order Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -21724,7 +21724,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } ] @@ -21738,16 +21738,16 @@ "type": "object", "properties": { "first": { - "example": "/product-review-summary?limit=25" + "example": "/order-warehouse-group?limit=25" }, "last": { - "example": "/product-review-summary?limit=25&page=11" + "example": "/order-warehouse-group?limit=25&page=11" }, "next": { - "example": "/product-review-summary?limit=25&page=4" + "example": "/order-warehouse-group?limit=25&page=4" }, "prev": { - "example": "/product-review-summary?limit=25&page=2" + "example": "/order-warehouse-group?limit=25&page=2" } } } @@ -21768,7 +21768,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21783,11 +21783,11 @@ }, "post": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "Create a new Product Review Summary resources.", + "summary": "Create a new Order Warehouse Group resources.", "description": "", - "operationId": "createProductReviewSummary", + "operationId": "createOrderWarehouseGroup", "parameters": [ { "name": "_response", @@ -21806,14 +21806,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21825,7 +21825,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21840,7 +21840,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21856,14 +21856,14 @@ } } }, - "/search/product-review-summary": { + "/search/order-warehouse-group": { "post": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "Search for the Product Review Summary resources.", + "summary": "Search for the Order Warehouse Group resources.", "description": "", - "operationId": "searchProductReviewSummary", + "operationId": "searchOrderWarehouseGroup", "parameters": [ { "name": "sw-include-search-info", @@ -21891,7 +21891,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21905,7 +21905,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21923,7 +21923,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21940,19 +21940,19 @@ } } }, - "/product-review-summary/{id}": { + "/order-warehouse-group/{id}": { "get": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "Detailed information about a Product Review Summary resource.", + "summary": "Detailed information about a Order Warehouse Group resource.", "description": "", - "operationId": "getProductReviewSummary", + "operationId": "getOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -21962,7 +21962,7 @@ ], "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -21974,7 +21974,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -21989,7 +21989,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -22006,16 +22006,16 @@ }, "delete": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "Delete a Product Review Summary resource.", + "summary": "Delete a Order Warehouse Group resource.", "description": "", - "operationId": "deleteProductReviewSummary", + "operationId": "deleteOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -22046,16 +22046,16 @@ }, "patch": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "Partially update information about a Product Review Summary resource.", + "summary": "Partially update information about a Order Warehouse Group resource.", "description": "", - "operationId": "updateProductReviewSummary", + "operationId": "updateOrderWarehouseGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_review_summary", + "description": "Identifier for the order_warehouse_group", "required": true, "schema": { "type": "string", @@ -22073,18 +22073,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Review Summary resource.", + "description": "Partially update information about a Order Warehouse Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } }, "responses": { "200": { - "description": "Detail of ProductReviewSummary", + "description": "Detail of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -22096,7 +22096,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -22111,7 +22111,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -22130,14 +22130,14 @@ } } }, - "/aggregate/product-review-summary": { + "/aggregate/order-warehouse-group": { "post": { "tags": [ - "Product Review Summary" + "Order Warehouse Group" ], - "summary": "Aggregate for the Product Review Summary resources.", + "summary": "Aggregate for the Order Warehouse Group resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductReviewSummary", + "operationId": "aggregateOrderWarehouseGroup", "requestBody": { "required": true, "content": { @@ -22161,7 +22161,7 @@ }, "responses": { "200": { - "description": "List of ProductReviewSummary", + "description": "List of OrderWarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -22175,7 +22175,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -22193,7 +22193,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductReviewSummary" + "$ref": "#/components/schemas/OrderWarehouseGroup" } } } @@ -22210,14 +22210,14 @@ } } }, - "/product-warehouse": { + "/product-review-summary": { "get": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "List with basic information of Product Warehouse resources.", + "summary": "List with basic information of Product Review Summary resources.", "description": "", - "operationId": "getProductWarehouseList", + "operationId": "getProductReviewSummaryList", "parameters": [ { "name": "limit", @@ -22246,7 +22246,7 @@ ], "responses": { "200": { - "description": "List of Product Warehouse resources.", + "description": "List of Product Review Summary resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22265,7 +22265,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } ] @@ -22279,16 +22279,16 @@ "type": "object", "properties": { "first": { - "example": "/product-warehouse?limit=25" + "example": "/product-review-summary?limit=25" }, "last": { - "example": "/product-warehouse?limit=25&page=11" + "example": "/product-review-summary?limit=25&page=11" }, "next": { - "example": "/product-warehouse?limit=25&page=4" + "example": "/product-review-summary?limit=25&page=4" }, "prev": { - "example": "/product-warehouse?limit=25&page=2" + "example": "/product-review-summary?limit=25&page=2" } } } @@ -22309,7 +22309,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22324,11 +22324,11 @@ }, "post": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "Create a new Product Warehouse resources.", + "summary": "Create a new Product Review Summary resources.", "description": "", - "operationId": "createProductWarehouse", + "operationId": "createProductReviewSummary", "parameters": [ { "name": "_response", @@ -22347,14 +22347,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22366,7 +22366,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22381,7 +22381,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22397,14 +22397,14 @@ } } }, - "/search/product-warehouse": { + "/search/product-review-summary": { "post": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "Search for the Product Warehouse resources.", + "summary": "Search for the Product Review Summary resources.", "description": "", - "operationId": "searchProductWarehouse", + "operationId": "searchProductReviewSummary", "parameters": [ { "name": "sw-include-search-info", @@ -22432,7 +22432,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22446,7 +22446,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22464,7 +22464,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22481,19 +22481,19 @@ } } }, - "/product-warehouse/{id}": { + "/product-review-summary/{id}": { "get": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "Detailed information about a Product Warehouse resource.", + "summary": "Detailed information about a Product Review Summary resource.", "description": "", - "operationId": "getProductWarehouse", + "operationId": "getProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22503,7 +22503,7 @@ ], "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22515,7 +22515,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22530,7 +22530,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22547,16 +22547,16 @@ }, "delete": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "Delete a Product Warehouse resource.", + "summary": "Delete a Product Review Summary resource.", "description": "", - "operationId": "deleteProductWarehouse", + "operationId": "deleteProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22587,16 +22587,16 @@ }, "patch": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "Partially update information about a Product Warehouse resource.", + "summary": "Partially update information about a Product Review Summary resource.", "description": "", - "operationId": "updateProductWarehouse", + "operationId": "updateProductReviewSummary", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the product_warehouse", + "description": "Identifier for the product_review_summary", "required": true, "schema": { "type": "string", @@ -22614,18 +22614,18 @@ } ], "requestBody": { - "description": "Partially update information about a Product Warehouse resource.", + "description": "Partially update information about a Product Review Summary resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } }, "responses": { "200": { - "description": "Detail of ProductWarehouse", + "description": "Detail of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22637,7 +22637,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22652,7 +22652,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22671,14 +22671,14 @@ } } }, - "/aggregate/product-warehouse": { + "/aggregate/product-review-summary": { "post": { "tags": [ - "Product Warehouse" + "Product Review Summary" ], - "summary": "Aggregate for the Product Warehouse resources.", + "summary": "Aggregate for the Product Review Summary resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateProductWarehouse", + "operationId": "aggregateProductReviewSummary", "requestBody": { "required": true, "content": { @@ -22702,7 +22702,7 @@ }, "responses": { "200": { - "description": "List of ProductWarehouse", + "description": "List of ProductReviewSummary", "content": { "application/vnd.api+json": { "schema": { @@ -22716,7 +22716,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22734,7 +22734,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/ProductWarehouse" + "$ref": "#/components/schemas/ProductReviewSummary" } } } @@ -22751,14 +22751,14 @@ } } }, - "/quote": { + "/product-warehouse": { "get": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "List with basic information of Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteList", + "summary": "List with basic information of Product Warehouse resources.", + "description": "", + "operationId": "getProductWarehouseList", "parameters": [ { "name": "limit", @@ -22787,7 +22787,7 @@ ], "responses": { "200": { - "description": "List of Quote resources.", + "description": "List of Product Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -22806,7 +22806,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } ] @@ -22820,16 +22820,16 @@ "type": "object", "properties": { "first": { - "example": "/quote?limit=25" + "example": "/product-warehouse?limit=25" }, "last": { - "example": "/quote?limit=25&page=11" + "example": "/product-warehouse?limit=25&page=11" }, "next": { - "example": "/quote?limit=25&page=4" + "example": "/product-warehouse?limit=25&page=4" }, "prev": { - "example": "/quote?limit=25&page=2" + "example": "/product-warehouse?limit=25&page=2" } } } @@ -22850,7 +22850,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22865,11 +22865,11 @@ }, "post": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "Create a new Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuote", + "summary": "Create a new Product Warehouse resources.", + "description": "", + "operationId": "createProductWarehouse", "parameters": [ { "name": "_response", @@ -22888,14 +22888,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22907,7 +22907,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22922,7 +22922,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -22938,14 +22938,14 @@ } } }, - "/search/quote": { + "/search/product-warehouse": { "post": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "Search for the Quote resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuote", + "summary": "Search for the Product Warehouse resources.", + "description": "", + "operationId": "searchProductWarehouse", "parameters": [ { "name": "sw-include-search-info", @@ -22973,7 +22973,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -22987,7 +22987,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23005,7 +23005,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23022,19 +23022,19 @@ } } }, - "/quote/{id}": { + "/product-warehouse/{id}": { "get": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "Detailed information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuote", + "summary": "Detailed information about a Product Warehouse resource.", + "description": "", + "operationId": "getProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -23044,7 +23044,7 @@ ], "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -23056,7 +23056,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23071,7 +23071,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23088,16 +23088,16 @@ }, "delete": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "Delete a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuote", + "summary": "Delete a Product Warehouse resource.", + "description": "", + "operationId": "deleteProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -23128,16 +23128,16 @@ }, "patch": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "Partially update information about a Quote resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuote", + "summary": "Partially update information about a Product Warehouse resource.", + "description": "", + "operationId": "updateProductWarehouse", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote", + "description": "Identifier for the product_warehouse", "required": true, "schema": { "type": "string", @@ -23155,18 +23155,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote resource.", + "description": "Partially update information about a Product Warehouse resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } }, "responses": { "200": { - "description": "Detail of Quote", + "description": "Detail of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -23178,7 +23178,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23193,7 +23193,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23212,14 +23212,14 @@ } } }, - "/aggregate/quote": { + "/aggregate/product-warehouse": { "post": { "tags": [ - "Quote" + "Product Warehouse" ], - "summary": "Aggregate for the Quote resources.", + "summary": "Aggregate for the Product Warehouse resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuote", + "operationId": "aggregateProductWarehouse", "requestBody": { "required": true, "content": { @@ -23243,7 +23243,7 @@ }, "responses": { "200": { - "description": "List of Quote", + "description": "List of ProductWarehouse", "content": { "application/vnd.api+json": { "schema": { @@ -23257,7 +23257,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23275,7 +23275,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Quote" + "$ref": "#/components/schemas/ProductWarehouse" } } } @@ -23292,14 +23292,14 @@ } } }, - "/quote-comment": { + "/quote": { "get": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "List with basic information of Quote Comment resources.", - "description": "", - "operationId": "getQuoteCommentList", + "summary": "List with basic information of Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteList", "parameters": [ { "name": "limit", @@ -23328,7 +23328,7 @@ ], "responses": { "200": { - "description": "List of Quote Comment resources.", + "description": "List of Quote resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23347,7 +23347,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } ] @@ -23361,16 +23361,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-comment?limit=25" + "example": "/quote?limit=25" }, "last": { - "example": "/quote-comment?limit=25&page=11" + "example": "/quote?limit=25&page=11" }, "next": { - "example": "/quote-comment?limit=25&page=4" + "example": "/quote?limit=25&page=4" }, "prev": { - "example": "/quote-comment?limit=25&page=2" + "example": "/quote?limit=25&page=2" } } } @@ -23391,7 +23391,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23406,11 +23406,11 @@ }, "post": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "Create a new Quote Comment resources.", - "description": "", - "operationId": "createQuoteComment", + "summary": "Create a new Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuote", "parameters": [ { "name": "_response", @@ -23429,14 +23429,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23448,7 +23448,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23463,7 +23463,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23479,14 +23479,14 @@ } } }, - "/search/quote-comment": { + "/search/quote": { "post": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "Search for the Quote Comment resources.", - "description": "", - "operationId": "searchQuoteComment", + "summary": "Search for the Quote resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuote", "parameters": [ { "name": "sw-include-search-info", @@ -23514,7 +23514,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23528,7 +23528,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23546,7 +23546,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23563,19 +23563,19 @@ } } }, - "/quote-comment/{id}": { + "/quote/{id}": { "get": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "Detailed information about a Quote Comment resource.", - "description": "", - "operationId": "getQuoteComment", + "summary": "Detailed information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23585,7 +23585,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23597,7 +23597,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23612,7 +23612,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23629,16 +23629,16 @@ }, "delete": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "Delete a Quote Comment resource.", - "description": "", - "operationId": "deleteQuoteComment", + "summary": "Delete a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23669,16 +23669,16 @@ }, "patch": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "Partially update information about a Quote Comment resource.", - "description": "", - "operationId": "updateQuoteComment", + "summary": "Partially update information about a Quote resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuote", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_comment", + "description": "Identifier for the quote", "required": true, "schema": { "type": "string", @@ -23696,18 +23696,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Comment resource.", + "description": "Partially update information about a Quote resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } }, "responses": { "200": { - "description": "Detail of QuoteComment", + "description": "Detail of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23719,7 +23719,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23734,7 +23734,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23753,14 +23753,14 @@ } } }, - "/aggregate/quote-comment": { + "/aggregate/quote": { "post": { "tags": [ - "Quote Comment" + "Quote" ], - "summary": "Aggregate for the Quote Comment resources.", + "summary": "Aggregate for the Quote resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteComment", + "operationId": "aggregateQuote", "requestBody": { "required": true, "content": { @@ -23784,7 +23784,7 @@ }, "responses": { "200": { - "description": "List of QuoteComment", + "description": "List of Quote", "content": { "application/vnd.api+json": { "schema": { @@ -23798,7 +23798,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23816,7 +23816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteComment" + "$ref": "#/components/schemas/Quote" } } } @@ -23833,14 +23833,14 @@ } } }, - "/quote-delivery": { + "/quote-comment": { "get": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "List with basic information of Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryList", + "summary": "List with basic information of Quote Comment resources.", + "description": "", + "operationId": "getQuoteCommentList", "parameters": [ { "name": "limit", @@ -23869,7 +23869,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery resources.", + "description": "List of Quote Comment resources.", "content": { "application/vnd.api+json": { "schema": { @@ -23888,7 +23888,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } ] @@ -23902,16 +23902,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery?limit=25" + "example": "/quote-comment?limit=25" }, "last": { - "example": "/quote-delivery?limit=25&page=11" + "example": "/quote-comment?limit=25&page=11" }, "next": { - "example": "/quote-delivery?limit=25&page=4" + "example": "/quote-comment?limit=25&page=4" }, "prev": { - "example": "/quote-delivery?limit=25&page=2" + "example": "/quote-comment?limit=25&page=2" } } } @@ -23932,7 +23932,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -23947,11 +23947,11 @@ }, "post": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "Create a new Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDelivery", + "summary": "Create a new Quote Comment resources.", + "description": "", + "operationId": "createQuoteComment", "parameters": [ { "name": "_response", @@ -23970,14 +23970,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -23989,7 +23989,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24004,7 +24004,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24020,14 +24020,14 @@ } } }, - "/search/quote-delivery": { + "/search/quote-comment": { "post": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "Search for the Quote Delivery resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDelivery", + "summary": "Search for the Quote Comment resources.", + "description": "", + "operationId": "searchQuoteComment", "parameters": [ { "name": "sw-include-search-info", @@ -24055,7 +24055,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -24069,7 +24069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24087,7 +24087,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24104,19 +24104,19 @@ } } }, - "/quote-delivery/{id}": { + "/quote-comment/{id}": { "get": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "Detailed information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDelivery", + "summary": "Detailed information about a Quote Comment resource.", + "description": "", + "operationId": "getQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -24126,7 +24126,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -24138,7 +24138,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24153,7 +24153,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24170,16 +24170,16 @@ }, "delete": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "Delete a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDelivery", + "summary": "Delete a Quote Comment resource.", + "description": "", + "operationId": "deleteQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -24210,16 +24210,16 @@ }, "patch": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "Partially update information about a Quote Delivery resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDelivery", + "summary": "Partially update information about a Quote Comment resource.", + "description": "", + "operationId": "updateQuoteComment", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery", + "description": "Identifier for the quote_comment", "required": true, "schema": { "type": "string", @@ -24237,18 +24237,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery resource.", + "description": "Partially update information about a Quote Comment resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } }, "responses": { "200": { - "description": "Detail of QuoteDelivery", + "description": "Detail of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -24260,7 +24260,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24275,7 +24275,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24294,14 +24294,14 @@ } } }, - "/aggregate/quote-delivery": { + "/aggregate/quote-comment": { "post": { "tags": [ - "Quote Delivery" + "Quote Comment" ], - "summary": "Aggregate for the Quote Delivery resources.", + "summary": "Aggregate for the Quote Comment resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDelivery", + "operationId": "aggregateQuoteComment", "requestBody": { "required": true, "content": { @@ -24325,7 +24325,7 @@ }, "responses": { "200": { - "description": "List of QuoteDelivery", + "description": "List of QuoteComment", "content": { "application/vnd.api+json": { "schema": { @@ -24339,7 +24339,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24357,7 +24357,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDelivery" + "$ref": "#/components/schemas/QuoteComment" } } } @@ -24374,14 +24374,14 @@ } } }, - "/quote-delivery-position": { + "/quote-delivery": { "get": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "List with basic information of Quote Delivery Position resources.", + "summary": "List with basic information of Quote Delivery resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPositionList", + "operationId": "getQuoteDeliveryList", "parameters": [ { "name": "limit", @@ -24410,7 +24410,7 @@ ], "responses": { "200": { - "description": "List of Quote Delivery Position resources.", + "description": "List of Quote Delivery resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24429,7 +24429,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } ] @@ -24443,16 +24443,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-delivery-position?limit=25" + "example": "/quote-delivery?limit=25" }, "last": { - "example": "/quote-delivery-position?limit=25&page=11" + "example": "/quote-delivery?limit=25&page=11" }, "next": { - "example": "/quote-delivery-position?limit=25&page=4" + "example": "/quote-delivery?limit=25&page=4" }, "prev": { - "example": "/quote-delivery-position?limit=25&page=2" + "example": "/quote-delivery?limit=25&page=2" } } } @@ -24473,7 +24473,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24488,11 +24488,11 @@ }, "post": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "Create a new Quote Delivery Position resources.", + "summary": "Create a new Quote Delivery resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteDeliveryPosition", + "operationId": "createQuoteDelivery", "parameters": [ { "name": "_response", @@ -24511,14 +24511,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24530,7 +24530,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24545,7 +24545,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24561,14 +24561,14 @@ } } }, - "/search/quote-delivery-position": { + "/search/quote-delivery": { "post": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "Search for the Quote Delivery Position resources.", + "summary": "Search for the Quote Delivery resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteDeliveryPosition", + "operationId": "searchQuoteDelivery", "parameters": [ { "name": "sw-include-search-info", @@ -24596,7 +24596,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24610,7 +24610,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24628,7 +24628,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24645,19 +24645,19 @@ } } }, - "/quote-delivery-position/{id}": { + "/quote-delivery/{id}": { "get": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "Detailed information about a Quote Delivery Position resource.", + "summary": "Detailed information about a Quote Delivery resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteDeliveryPosition", + "operationId": "getQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24667,7 +24667,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24679,7 +24679,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24694,7 +24694,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24711,16 +24711,16 @@ }, "delete": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "Delete a Quote Delivery Position resource.", + "summary": "Delete a Quote Delivery resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteDeliveryPosition", + "operationId": "deleteQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24751,16 +24751,16 @@ }, "patch": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "Partially update information about a Quote Delivery Position resource.", + "summary": "Partially update information about a Quote Delivery resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteDeliveryPosition", + "operationId": "updateQuoteDelivery", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_delivery_position", + "description": "Identifier for the quote_delivery", "required": true, "schema": { "type": "string", @@ -24778,18 +24778,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Delivery Position resource.", + "description": "Partially update information about a Quote Delivery resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } }, "responses": { "200": { - "description": "Detail of QuoteDeliveryPosition", + "description": "Detail of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24801,7 +24801,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24816,7 +24816,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24835,14 +24835,14 @@ } } }, - "/aggregate/quote-delivery-position": { + "/aggregate/quote-delivery": { "post": { "tags": [ - "Quote Delivery Position" + "Quote Delivery" ], - "summary": "Aggregate for the Quote Delivery Position resources.", + "summary": "Aggregate for the Quote Delivery resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDeliveryPosition", + "operationId": "aggregateQuoteDelivery", "requestBody": { "required": true, "content": { @@ -24866,7 +24866,7 @@ }, "responses": { "200": { - "description": "List of QuoteDeliveryPosition", + "description": "List of QuoteDelivery", "content": { "application/vnd.api+json": { "schema": { @@ -24880,7 +24880,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24898,7 +24898,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDeliveryPosition" + "$ref": "#/components/schemas/QuoteDelivery" } } } @@ -24915,14 +24915,14 @@ } } }, - "/quote-document": { + "/quote-delivery-position": { "get": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "List with basic information of Quote Document resources.", - "description": "", - "operationId": "getQuoteDocumentList", + "summary": "List with basic information of Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPositionList", "parameters": [ { "name": "limit", @@ -24951,7 +24951,7 @@ ], "responses": { "200": { - "description": "List of Quote Document resources.", + "description": "List of Quote Delivery Position resources.", "content": { "application/vnd.api+json": { "schema": { @@ -24970,7 +24970,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } ] @@ -24984,16 +24984,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-document?limit=25" + "example": "/quote-delivery-position?limit=25" }, "last": { - "example": "/quote-document?limit=25&page=11" + "example": "/quote-delivery-position?limit=25&page=11" }, "next": { - "example": "/quote-document?limit=25&page=4" + "example": "/quote-delivery-position?limit=25&page=4" }, "prev": { - "example": "/quote-document?limit=25&page=2" + "example": "/quote-delivery-position?limit=25&page=2" } } } @@ -25014,7 +25014,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25029,11 +25029,11 @@ }, "post": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "Create a new Quote Document resources.", - "description": "", - "operationId": "createQuoteDocument", + "summary": "Create a new Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteDeliveryPosition", "parameters": [ { "name": "_response", @@ -25052,14 +25052,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25071,7 +25071,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25086,7 +25086,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25102,14 +25102,14 @@ } } }, - "/search/quote-document": { + "/search/quote-delivery-position": { "post": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "Search for the Quote Document resources.", - "description": "", - "operationId": "searchQuoteDocument", + "summary": "Search for the Quote Delivery Position resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteDeliveryPosition", "parameters": [ { "name": "sw-include-search-info", @@ -25137,7 +25137,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25151,7 +25151,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25169,7 +25169,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25186,19 +25186,19 @@ } } }, - "/quote-document/{id}": { + "/quote-delivery-position/{id}": { "get": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "Detailed information about a Quote Document resource.", - "description": "", - "operationId": "getQuoteDocument", + "summary": "Detailed information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -25208,7 +25208,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25220,7 +25220,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25235,7 +25235,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25252,16 +25252,16 @@ }, "delete": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "Delete a Quote Document resource.", - "description": "", - "operationId": "deleteQuoteDocument", + "summary": "Delete a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -25292,16 +25292,16 @@ }, "patch": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "Partially update information about a Quote Document resource.", - "description": "", - "operationId": "updateQuoteDocument", + "summary": "Partially update information about a Quote Delivery Position resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteDeliveryPosition", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_document", + "description": "Identifier for the quote_delivery_position", "required": true, "schema": { "type": "string", @@ -25319,18 +25319,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Document resource.", + "description": "Partially update information about a Quote Delivery Position resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } }, "responses": { "200": { - "description": "Detail of QuoteDocument", + "description": "Detail of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25342,7 +25342,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25357,7 +25357,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25376,14 +25376,14 @@ } } }, - "/aggregate/quote-document": { + "/aggregate/quote-delivery-position": { "post": { "tags": [ - "Quote Document" + "Quote Delivery Position" ], - "summary": "Aggregate for the Quote Document resources.", + "summary": "Aggregate for the Quote Delivery Position resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteDocument", + "operationId": "aggregateQuoteDeliveryPosition", "requestBody": { "required": true, "content": { @@ -25407,7 +25407,7 @@ }, "responses": { "200": { - "description": "List of QuoteDocument", + "description": "List of QuoteDeliveryPosition", "content": { "application/vnd.api+json": { "schema": { @@ -25421,7 +25421,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25439,7 +25439,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteDocument" + "$ref": "#/components/schemas/QuoteDeliveryPosition" } } } @@ -25456,14 +25456,14 @@ } } }, - "/quote-employee": { + "/quote-document": { "get": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "List with basic information of Quote Employee resources.", + "summary": "List with basic information of Quote Document resources.", "description": "", - "operationId": "getQuoteEmployeeList", + "operationId": "getQuoteDocumentList", "parameters": [ { "name": "limit", @@ -25492,7 +25492,7 @@ ], "responses": { "200": { - "description": "List of Quote Employee resources.", + "description": "List of Quote Document resources.", "content": { "application/vnd.api+json": { "schema": { @@ -25511,7 +25511,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } ] @@ -25525,16 +25525,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-employee?limit=25" + "example": "/quote-document?limit=25" }, "last": { - "example": "/quote-employee?limit=25&page=11" + "example": "/quote-document?limit=25&page=11" }, "next": { - "example": "/quote-employee?limit=25&page=4" + "example": "/quote-document?limit=25&page=4" }, "prev": { - "example": "/quote-employee?limit=25&page=2" + "example": "/quote-document?limit=25&page=2" } } } @@ -25555,7 +25555,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25570,11 +25570,11 @@ }, "post": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "Create a new Quote Employee resources.", + "summary": "Create a new Quote Document resources.", "description": "", - "operationId": "createQuoteEmployee", + "operationId": "createQuoteDocument", "parameters": [ { "name": "_response", @@ -25593,14 +25593,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25612,7 +25612,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25627,7 +25627,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25643,14 +25643,14 @@ } } }, - "/search/quote-employee": { + "/search/quote-document": { "post": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "Search for the Quote Employee resources.", + "summary": "Search for the Quote Document resources.", "description": "", - "operationId": "searchQuoteEmployee", + "operationId": "searchQuoteDocument", "parameters": [ { "name": "sw-include-search-info", @@ -25678,7 +25678,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25692,7 +25692,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25710,7 +25710,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25727,19 +25727,19 @@ } } }, - "/quote-employee/{id}": { + "/quote-document/{id}": { "get": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "Detailed information about a Quote Employee resource.", + "summary": "Detailed information about a Quote Document resource.", "description": "", - "operationId": "getQuoteEmployee", + "operationId": "getQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25749,7 +25749,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25761,7 +25761,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25776,7 +25776,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25793,16 +25793,16 @@ }, "delete": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "Delete a Quote Employee resource.", + "summary": "Delete a Quote Document resource.", "description": "", - "operationId": "deleteQuoteEmployee", + "operationId": "deleteQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25833,16 +25833,16 @@ }, "patch": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "Partially update information about a Quote Employee resource.", + "summary": "Partially update information about a Quote Document resource.", "description": "", - "operationId": "updateQuoteEmployee", + "operationId": "updateQuoteDocument", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_employee", + "description": "Identifier for the quote_document", "required": true, "schema": { "type": "string", @@ -25860,18 +25860,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Employee resource.", + "description": "Partially update information about a Quote Document resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } }, "responses": { "200": { - "description": "Detail of QuoteEmployee", + "description": "Detail of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25883,7 +25883,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25898,7 +25898,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25917,14 +25917,14 @@ } } }, - "/aggregate/quote-employee": { + "/aggregate/quote-document": { "post": { "tags": [ - "Quote Employee" + "Quote Document" ], - "summary": "Aggregate for the Quote Employee resources.", + "summary": "Aggregate for the Quote Document resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteEmployee", + "operationId": "aggregateQuoteDocument", "requestBody": { "required": true, "content": { @@ -25948,7 +25948,7 @@ }, "responses": { "200": { - "description": "List of QuoteEmployee", + "description": "List of QuoteDocument", "content": { "application/vnd.api+json": { "schema": { @@ -25962,7 +25962,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25980,7 +25980,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteEmployee" + "$ref": "#/components/schemas/QuoteDocument" } } } @@ -25997,14 +25997,14 @@ } } }, - "/quote-line-item": { + "/quote-employee": { "get": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "List with basic information of Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItemList", + "summary": "List with basic information of Quote Employee resources.", + "description": "", + "operationId": "getQuoteEmployeeList", "parameters": [ { "name": "limit", @@ -26033,7 +26033,7 @@ ], "responses": { "200": { - "description": "List of Quote Line Item resources.", + "description": "List of Quote Employee resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26052,7 +26052,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } ] @@ -26066,16 +26066,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-line-item?limit=25" + "example": "/quote-employee?limit=25" }, "last": { - "example": "/quote-line-item?limit=25&page=11" + "example": "/quote-employee?limit=25&page=11" }, "next": { - "example": "/quote-line-item?limit=25&page=4" + "example": "/quote-employee?limit=25&page=4" }, "prev": { - "example": "/quote-line-item?limit=25&page=2" + "example": "/quote-employee?limit=25&page=2" } } } @@ -26096,7 +26096,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26111,11 +26111,11 @@ }, "post": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "Create a new Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "createQuoteLineItem", + "summary": "Create a new Quote Employee resources.", + "description": "", + "operationId": "createQuoteEmployee", "parameters": [ { "name": "_response", @@ -26134,14 +26134,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26153,7 +26153,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26168,7 +26168,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26184,14 +26184,14 @@ } } }, - "/search/quote-line-item": { + "/search/quote-employee": { "post": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "Search for the Quote Line Item resources.", - "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteLineItem", + "summary": "Search for the Quote Employee resources.", + "description": "", + "operationId": "searchQuoteEmployee", "parameters": [ { "name": "sw-include-search-info", @@ -26219,7 +26219,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26233,7 +26233,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26251,7 +26251,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26268,19 +26268,19 @@ } } }, - "/quote-line-item/{id}": { + "/quote-employee/{id}": { "get": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "Detailed information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "getQuoteLineItem", + "summary": "Detailed information about a Quote Employee resource.", + "description": "", + "operationId": "getQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -26290,7 +26290,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26302,7 +26302,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26317,7 +26317,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26334,16 +26334,16 @@ }, "delete": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "Delete a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteLineItem", + "summary": "Delete a Quote Employee resource.", + "description": "", + "operationId": "deleteQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -26374,16 +26374,16 @@ }, "patch": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "Partially update information about a Quote Line Item resource.", - "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteLineItem", + "summary": "Partially update information about a Quote Employee resource.", + "description": "", + "operationId": "updateQuoteEmployee", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_line_item", + "description": "Identifier for the quote_employee", "required": true, "schema": { "type": "string", @@ -26401,18 +26401,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Line Item resource.", + "description": "Partially update information about a Quote Employee resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } }, "responses": { "200": { - "description": "Detail of QuoteLineItem", + "description": "Detail of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26424,7 +26424,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26439,7 +26439,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26458,14 +26458,14 @@ } } }, - "/aggregate/quote-line-item": { + "/aggregate/quote-employee": { "post": { "tags": [ - "Quote Line Item" + "Quote Employee" ], - "summary": "Aggregate for the Quote Line Item resources.", + "summary": "Aggregate for the Quote Employee resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteLineItem", + "operationId": "aggregateQuoteEmployee", "requestBody": { "required": true, "content": { @@ -26489,7 +26489,7 @@ }, "responses": { "200": { - "description": "List of QuoteLineItem", + "description": "List of QuoteEmployee", "content": { "application/vnd.api+json": { "schema": { @@ -26503,7 +26503,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26521,7 +26521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteLineItem" + "$ref": "#/components/schemas/QuoteEmployee" } } } @@ -26538,14 +26538,14 @@ } } }, - "/quote-transaction": { + "/quote-line-item": { "get": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "List with basic information of Quote Transaction resources.", + "summary": "List with basic information of Quote Line Item resources.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransactionList", + "operationId": "getQuoteLineItemList", "parameters": [ { "name": "limit", @@ -26574,7 +26574,7 @@ ], "responses": { "200": { - "description": "List of Quote Transaction resources.", + "description": "List of Quote Line Item resources.", "content": { "application/vnd.api+json": { "schema": { @@ -26593,7 +26593,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } ] @@ -26607,16 +26607,16 @@ "type": "object", "properties": { "first": { - "example": "/quote-transaction?limit=25" + "example": "/quote-line-item?limit=25" }, "last": { - "example": "/quote-transaction?limit=25&page=11" + "example": "/quote-line-item?limit=25&page=11" }, "next": { - "example": "/quote-transaction?limit=25&page=4" + "example": "/quote-line-item?limit=25&page=4" }, "prev": { - "example": "/quote-transaction?limit=25&page=2" + "example": "/quote-line-item?limit=25&page=2" } } } @@ -26637,7 +26637,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26652,11 +26652,11 @@ }, "post": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "Create a new Quote Transaction resources.", + "summary": "Create a new Quote Line Item resources.", "description": "Available since: 6.5.3.0", - "operationId": "createQuoteTransaction", + "operationId": "createQuoteLineItem", "parameters": [ { "name": "_response", @@ -26675,14 +26675,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26694,7 +26694,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26709,7 +26709,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26725,14 +26725,14 @@ } } }, - "/search/quote-transaction": { + "/search/quote-line-item": { "post": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "Search for the Quote Transaction resources.", + "summary": "Search for the Quote Line Item resources.", "description": "Available since: 6.5.3.0", - "operationId": "searchQuoteTransaction", + "operationId": "searchQuoteLineItem", "parameters": [ { "name": "sw-include-search-info", @@ -26760,7 +26760,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26774,7 +26774,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26792,7 +26792,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26809,19 +26809,19 @@ } } }, - "/quote-transaction/{id}": { + "/quote-line-item/{id}": { "get": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "Detailed information about a Quote Transaction resource.", + "summary": "Detailed information about a Quote Line Item resource.", "description": "Available since: 6.5.3.0", - "operationId": "getQuoteTransaction", + "operationId": "getQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -26831,7 +26831,7 @@ ], "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26843,7 +26843,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26858,7 +26858,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26875,16 +26875,16 @@ }, "delete": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "Delete a Quote Transaction resource.", + "summary": "Delete a Quote Line Item resource.", "description": "Available since: 6.5.3.0", - "operationId": "deleteQuoteTransaction", + "operationId": "deleteQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -26915,16 +26915,16 @@ }, "patch": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "Partially update information about a Quote Transaction resource.", + "summary": "Partially update information about a Quote Line Item resource.", "description": "Available since: 6.5.3.0", - "operationId": "updateQuoteTransaction", + "operationId": "updateQuoteLineItem", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the quote_transaction", + "description": "Identifier for the quote_line_item", "required": true, "schema": { "type": "string", @@ -26942,18 +26942,18 @@ } ], "requestBody": { - "description": "Partially update information about a Quote Transaction resource.", + "description": "Partially update information about a Quote Line Item resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } }, "responses": { "200": { - "description": "Detail of QuoteTransaction", + "description": "Detail of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -26965,7 +26965,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26980,7 +26980,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -26999,14 +26999,14 @@ } } }, - "/aggregate/quote-transaction": { + "/aggregate/quote-line-item": { "post": { "tags": [ - "Quote Transaction" + "Quote Line Item" ], - "summary": "Aggregate for the Quote Transaction resources.", + "summary": "Aggregate for the Quote Line Item resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateQuoteTransaction", + "operationId": "aggregateQuoteLineItem", "requestBody": { "required": true, "content": { @@ -27030,7 +27030,7 @@ }, "responses": { "200": { - "description": "List of QuoteTransaction", + "description": "List of QuoteLineItem", "content": { "application/vnd.api+json": { "schema": { @@ -27044,7 +27044,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27062,7 +27062,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/QuoteTransaction" + "$ref": "#/components/schemas/QuoteLineItem" } } } @@ -27079,15 +27079,14 @@ } } }, - "/sales-channel-tracking-customer": { + "/quote-transaction": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransactionList", "parameters": [ { "name": "limit", @@ -27116,7 +27115,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Customer resources.", + "description": "List of Quote Transaction resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27135,7 +27134,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } ] @@ -27149,16 +27148,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-customer?limit=25" + "example": "/quote-transaction?limit=25" }, "last": { - "example": "/sales-channel-tracking-customer?limit=25&page=11" + "example": "/quote-transaction?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-customer?limit=25&page=4" + "example": "/quote-transaction?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-customer?limit=25&page=2" + "example": "/quote-transaction?limit=25&page=2" } } } @@ -27179,7 +27178,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27194,12 +27193,11 @@ }, "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "createQuoteTransaction", "parameters": [ { "name": "_response", @@ -27218,14 +27216,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27237,7 +27235,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27252,7 +27250,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27268,15 +27266,14 @@ } } }, - "/search/sales-channel-tracking-customer": { + "/search/quote-transaction": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", + "description": "Available since: 6.5.3.0", + "operationId": "searchQuoteTransaction", "parameters": [ { "name": "sw-include-search-info", @@ -27304,7 +27301,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27318,7 +27315,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27336,7 +27333,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27353,20 +27350,19 @@ } } }, - "/sales-channel-tracking-customer/{id}": { + "/quote-transaction/{id}": { "get": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "getQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -27376,7 +27372,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27388,7 +27384,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27403,7 +27399,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27420,17 +27416,16 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "deleteQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -27461,17 +27456,16 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resource.", + "description": "Available since: 6.5.3.0", + "operationId": "updateQuoteTransaction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sales_channel_tracking_customer", + "description": "Identifier for the quote_transaction", "required": true, "schema": { "type": "string", @@ -27489,18 +27483,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Customer resource.", + "description": "Partially update information about a Quote Transaction resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingCustomer", + "description": "Detail of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27512,7 +27506,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27527,7 +27521,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27546,15 +27540,14 @@ } } }, - "/aggregate/sales-channel-tracking-customer": { + "/aggregate/quote-transaction": { "post": { "tags": [ - "Sales Channel Tracking Customer", - "Experimental" + "Quote Transaction" ], - "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 Quote Transaction resources.", + "description": "Available since: 6.6.10.0", + "operationId": "aggregateQuoteTransaction", "requestBody": { "required": true, "content": { @@ -27578,7 +27571,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingCustomer", + "description": "List of QuoteTransaction", "content": { "application/vnd.api+json": { "schema": { @@ -27592,7 +27585,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27610,7 +27603,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingCustomer" + "$ref": "#/components/schemas/QuoteTransaction" } } } @@ -27627,15 +27620,15 @@ } } }, - "/sales-channel-tracking-order": { + "/spatial-render-config-size": { "get": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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", @@ -27664,7 +27657,7 @@ ], "responses": { "200": { - "description": "List of Sales Channel Tracking Order resources.", + "description": "List of Spatial Render Config Size resources.", "content": { "application/vnd.api+json": { "schema": { @@ -27683,7 +27676,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } ] @@ -27697,16 +27690,16 @@ "type": "object", "properties": { "first": { - "example": "/sales-channel-tracking-order?limit=25" + "example": "/spatial-render-config-size?limit=25" }, "last": { - "example": "/sales-channel-tracking-order?limit=25&page=11" + "example": "/spatial-render-config-size?limit=25&page=11" }, "next": { - "example": "/sales-channel-tracking-order?limit=25&page=4" + "example": "/spatial-render-config-size?limit=25&page=4" }, "prev": { - "example": "/sales-channel-tracking-order?limit=25&page=2" + "example": "/spatial-render-config-size?limit=25&page=2" } } } @@ -27727,7 +27720,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27742,12 +27735,12 @@ }, "post": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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", @@ -27766,14 +27759,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27785,7 +27778,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27800,7 +27793,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27816,15 +27809,15 @@ } } }, - "/search/sales-channel-tracking-order": { + "/search/spatial-render-config-size": { "post": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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", @@ -27852,7 +27845,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27866,7 +27859,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27884,7 +27877,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27901,20 +27894,20 @@ } } }, - "/sales-channel-tracking-order/{id}": { + "/spatial-render-config-size/{id}": { "get": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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_order", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -27924,7 +27917,7 @@ ], "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -27936,7 +27929,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27951,7 +27944,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -27968,17 +27961,17 @@ }, "delete": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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_order", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28009,17 +28002,17 @@ }, "patch": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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_order", + "description": "Identifier for the spatial_render_config_size", "required": true, "schema": { "type": "string", @@ -28037,18 +28030,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sales Channel Tracking Order resource.", + "description": "Partially update information about a Spatial Render Config Size resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } }, "responses": { "200": { - "description": "Detail of SalesChannelTrackingOrder", + "description": "Detail of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28060,7 +28053,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28075,7 +28068,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28094,15 +28087,15 @@ } } }, - "/aggregate/sales-channel-tracking-order": { + "/aggregate/spatial-render-config-size": { "post": { "tags": [ - "Sales Channel Tracking Order", + "Spatial Render Config Size", "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 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": { @@ -28126,7 +28119,7 @@ }, "responses": { "200": { - "description": "List of SalesChannelTrackingOrder", + "description": "List of SpatialRenderConfigSize", "content": { "application/vnd.api+json": { "schema": { @@ -28140,7 +28133,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28158,7 +28151,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SalesChannelTrackingOrder" + "$ref": "#/components/schemas/SpatialRenderConfigSize" } } } @@ -28175,15 +28168,15 @@ } } }, - "/spatial-render-config-size": { + "/spatial-scene": { "get": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialRenderConfigSizeList", + "operationId": "getSpatialSceneList", "parameters": [ { "name": "limit", @@ -28212,7 +28205,7 @@ ], "responses": { "200": { - "description": "List of Spatial Render Config Size resources.", + "description": "List of Spatial Scene resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28231,7 +28224,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } ] @@ -28245,16 +28238,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-render-config-size?limit=25" + "example": "/spatial-scene?limit=25" }, "last": { - "example": "/spatial-render-config-size?limit=25&page=11" + "example": "/spatial-scene?limit=25&page=11" }, "next": { - "example": "/spatial-render-config-size?limit=25&page=4" + "example": "/spatial-scene?limit=25&page=4" }, "prev": { - "example": "/spatial-render-config-size?limit=25&page=2" + "example": "/spatial-scene?limit=25&page=2" } } } @@ -28275,7 +28268,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28290,12 +28283,12 @@ }, "post": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialRenderConfigSize", + "operationId": "createSpatialScene", "parameters": [ { "name": "_response", @@ -28314,14 +28307,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28333,7 +28326,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28348,7 +28341,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28364,15 +28357,15 @@ } } }, - "/search/spatial-render-config-size": { + "/search/spatial-scene": { "post": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialRenderConfigSize", + "operationId": "searchSpatialScene", "parameters": [ { "name": "sw-include-search-info", @@ -28400,7 +28393,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28414,7 +28407,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28432,7 +28425,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28449,20 +28442,20 @@ } } }, - "/spatial-render-config-size/{id}": { + "/spatial-scene/{id}": { "get": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialRenderConfigSize", + "operationId": "getSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28472,7 +28465,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28484,7 +28477,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28499,7 +28492,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28516,17 +28509,17 @@ }, "delete": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialRenderConfigSize", + "operationId": "deleteSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28557,17 +28550,17 @@ }, "patch": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialRenderConfigSize", + "operationId": "updateSpatialScene", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_render_config_size", + "description": "Identifier for the spatial_scene", "required": true, "schema": { "type": "string", @@ -28585,18 +28578,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Render Config Size resource.", + "description": "Partially update information about a Spatial Scene resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } }, "responses": { "200": { - "description": "Detail of SpatialRenderConfigSize", + "description": "Detail of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28608,7 +28601,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28623,7 +28616,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28642,15 +28635,15 @@ } } }, - "/aggregate/spatial-render-config-size": { + "/aggregate/spatial-scene": { "post": { "tags": [ - "Spatial Render Config Size", + "Spatial Scene", "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 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": "aggregateSpatialScene", "requestBody": { "required": true, "content": { @@ -28674,7 +28667,7 @@ }, "responses": { "200": { - "description": "List of SpatialRenderConfigSize", + "description": "List of SpatialScene", "content": { "application/vnd.api+json": { "schema": { @@ -28688,7 +28681,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28706,7 +28699,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialRenderConfigSize" + "$ref": "#/components/schemas/SpatialScene" } } } @@ -28723,15 +28716,15 @@ } } }, - "/spatial-scene": { + "/spatial-scene-camera": { "get": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneList", + "operationId": "getSpatialSceneCameraList", "parameters": [ { "name": "limit", @@ -28760,7 +28753,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene resources.", + "description": "List of Spatial Scene Camera resources.", "content": { "application/vnd.api+json": { "schema": { @@ -28779,7 +28772,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } ] @@ -28793,16 +28786,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene?limit=25" + "example": "/spatial-scene-camera?limit=25" }, "last": { - "example": "/spatial-scene?limit=25&page=11" + "example": "/spatial-scene-camera?limit=25&page=11" }, "next": { - "example": "/spatial-scene?limit=25&page=4" + "example": "/spatial-scene-camera?limit=25&page=4" }, "prev": { - "example": "/spatial-scene?limit=25&page=2" + "example": "/spatial-scene-camera?limit=25&page=2" } } } @@ -28823,7 +28816,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28838,12 +28831,12 @@ }, "post": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialScene", + "operationId": "createSpatialSceneCamera", "parameters": [ { "name": "_response", @@ -28862,14 +28855,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28881,7 +28874,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28896,7 +28889,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28912,15 +28905,15 @@ } } }, - "/search/spatial-scene": { + "/search/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 Camera resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialScene", + "operationId": "searchSpatialSceneCamera", "parameters": [ { "name": "sw-include-search-info", @@ -28948,7 +28941,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -28962,7 +28955,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28980,7 +28973,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -28997,20 +28990,20 @@ } } }, - "/spatial-scene/{id}": { + "/spatial-scene-camera/{id}": { "get": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScene", + "operationId": "getSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -29020,7 +29013,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29032,7 +29025,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29047,7 +29040,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29064,17 +29057,17 @@ }, "delete": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialScene", + "operationId": "deleteSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -29105,17 +29098,17 @@ }, "patch": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 Camera resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialScene", + "operationId": "updateSpatialSceneCamera", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene", + "description": "Identifier for the spatial_scene_camera", "required": true, "schema": { "type": "string", @@ -29133,18 +29126,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene resource.", + "description": "Partially update information about a Spatial Scene Camera resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } }, "responses": { "200": { - "description": "Detail of SpatialScene", + "description": "Detail of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29156,7 +29149,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29171,7 +29164,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29190,15 +29183,15 @@ } } }, - "/aggregate/spatial-scene": { + "/aggregate/spatial-scene-camera": { "post": { "tags": [ - "Spatial Scene", + "Spatial Scene Camera", "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 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": "aggregateSpatialScene", + "operationId": "aggregateSpatialSceneCamera", "requestBody": { "required": true, "content": { @@ -29222,7 +29215,7 @@ }, "responses": { "200": { - "description": "List of SpatialScene", + "description": "List of SpatialSceneCamera", "content": { "application/vnd.api+json": { "schema": { @@ -29236,7 +29229,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29254,7 +29247,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScene" + "$ref": "#/components/schemas/SpatialSceneCamera" } } } @@ -29271,15 +29264,15 @@ } } }, - "/spatial-scene-camera": { + "/spatial-scene-group": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneCameraList", + "operationId": "getSpatialSceneGroupList", "parameters": [ { "name": "limit", @@ -29308,7 +29301,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Camera resources.", + "description": "List of Spatial Scene Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29327,7 +29320,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } ] @@ -29341,16 +29334,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-camera?limit=25" + "example": "/spatial-scene-group?limit=25" }, "last": { - "example": "/spatial-scene-camera?limit=25&page=11" + "example": "/spatial-scene-group?limit=25&page=11" }, "next": { - "example": "/spatial-scene-camera?limit=25&page=4" + "example": "/spatial-scene-group?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-camera?limit=25&page=2" + "example": "/spatial-scene-group?limit=25&page=2" } } } @@ -29371,7 +29364,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29386,12 +29379,12 @@ }, "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneCamera", + "operationId": "createSpatialSceneGroup", "parameters": [ { "name": "_response", @@ -29410,14 +29403,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29429,7 +29422,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29444,7 +29437,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29460,15 +29453,15 @@ } } }, - "/search/spatial-scene-camera": { + "/search/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 Group resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneCamera", + "operationId": "searchSpatialSceneGroup", "parameters": [ { "name": "sw-include-search-info", @@ -29496,7 +29489,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29510,7 +29503,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29528,7 +29521,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29545,20 +29538,20 @@ } } }, - "/spatial-scene-camera/{id}": { + "/spatial-scene-group/{id}": { "get": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneCamera", + "operationId": "getSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29568,7 +29561,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29580,7 +29573,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29595,7 +29588,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29612,17 +29605,17 @@ }, "delete": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneCamera", + "operationId": "deleteSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29653,17 +29646,17 @@ }, "patch": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 Group resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneCamera", + "operationId": "updateSpatialSceneGroup", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_camera", + "description": "Identifier for the spatial_scene_group", "required": true, "schema": { "type": "string", @@ -29681,18 +29674,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Camera resource.", + "description": "Partially update information about a Spatial Scene Group resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneCamera", + "description": "Detail of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29704,7 +29697,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29719,7 +29712,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29738,15 +29731,15 @@ } } }, - "/aggregate/spatial-scene-camera": { + "/aggregate/spatial-scene-group": { "post": { "tags": [ - "Spatial Scene Camera", + "Spatial Scene Group", "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 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": "aggregateSpatialSceneCamera", + "operationId": "aggregateSpatialSceneGroup", "requestBody": { "required": true, "content": { @@ -29770,7 +29763,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneCamera", + "description": "List of SpatialSceneGroup", "content": { "application/vnd.api+json": { "schema": { @@ -29784,7 +29777,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29802,7 +29795,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneCamera" + "$ref": "#/components/schemas/SpatialSceneGroup" } } } @@ -29819,15 +29812,15 @@ } } }, - "/spatial-scene-group": { + "/spatial-scene-light": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneGroupList", + "operationId": "getSpatialSceneLightList", "parameters": [ { "name": "limit", @@ -29856,7 +29849,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Group resources.", + "description": "List of Spatial Scene Light resources.", "content": { "application/vnd.api+json": { "schema": { @@ -29875,7 +29868,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } ] @@ -29889,16 +29882,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-group?limit=25" + "example": "/spatial-scene-light?limit=25" }, "last": { - "example": "/spatial-scene-group?limit=25&page=11" + "example": "/spatial-scene-light?limit=25&page=11" }, "next": { - "example": "/spatial-scene-group?limit=25&page=4" + "example": "/spatial-scene-light?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-group?limit=25&page=2" + "example": "/spatial-scene-light?limit=25&page=2" } } } @@ -29919,7 +29912,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29934,12 +29927,12 @@ }, "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneGroup", + "operationId": "createSpatialSceneLight", "parameters": [ { "name": "_response", @@ -29958,14 +29951,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -29977,7 +29970,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -29992,7 +29985,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30008,15 +30001,15 @@ } } }, - "/search/spatial-scene-group": { + "/search/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 Light resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneGroup", + "operationId": "searchSpatialSceneLight", "parameters": [ { "name": "sw-include-search-info", @@ -30044,7 +30037,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30058,7 +30051,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30076,7 +30069,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30093,20 +30086,20 @@ } } }, - "/spatial-scene-group/{id}": { + "/spatial-scene-light/{id}": { "get": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneGroup", + "operationId": "getSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -30116,7 +30109,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30128,7 +30121,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30143,7 +30136,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30160,17 +30153,17 @@ }, "delete": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneGroup", + "operationId": "deleteSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -30201,17 +30194,17 @@ }, "patch": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 Light resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneGroup", + "operationId": "updateSpatialSceneLight", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_group", + "description": "Identifier for the spatial_scene_light", "required": true, "schema": { "type": "string", @@ -30229,18 +30222,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Group resource.", + "description": "Partially update information about a Spatial Scene Light resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneGroup", + "description": "Detail of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30252,7 +30245,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30267,7 +30260,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30286,15 +30279,15 @@ } } }, - "/aggregate/spatial-scene-group": { + "/aggregate/spatial-scene-light": { "post": { "tags": [ - "Spatial Scene Group", + "Spatial Scene Light", "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 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": "aggregateSpatialSceneGroup", + "operationId": "aggregateSpatialSceneLight", "requestBody": { "required": true, "content": { @@ -30318,7 +30311,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneGroup", + "description": "List of SpatialSceneLight", "content": { "application/vnd.api+json": { "schema": { @@ -30332,7 +30325,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30350,7 +30343,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneGroup" + "$ref": "#/components/schemas/SpatialSceneLight" } } } @@ -30367,15 +30360,15 @@ } } }, - "/spatial-scene-light": { + "/spatial-scene-material": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLightList", + "operationId": "getSpatialSceneMaterialList", "parameters": [ { "name": "limit", @@ -30404,7 +30397,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Light resources.", + "description": "List of Spatial Scene Material resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30423,7 +30416,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } ] @@ -30437,16 +30430,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-light?limit=25" + "example": "/spatial-scene-material?limit=25" }, "last": { - "example": "/spatial-scene-light?limit=25&page=11" + "example": "/spatial-scene-material?limit=25&page=11" }, "next": { - "example": "/spatial-scene-light?limit=25&page=4" + "example": "/spatial-scene-material?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-light?limit=25&page=2" + "example": "/spatial-scene-material?limit=25&page=2" } } } @@ -30467,7 +30460,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30482,12 +30475,12 @@ }, "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneLight", + "operationId": "createSpatialSceneMaterial", "parameters": [ { "name": "_response", @@ -30506,14 +30499,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30525,7 +30518,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30540,7 +30533,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30556,15 +30549,15 @@ } } }, - "/search/spatial-scene-light": { + "/search/spatial-scene-material": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 Material resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneLight", + "operationId": "searchSpatialSceneMaterial", "parameters": [ { "name": "sw-include-search-info", @@ -30592,7 +30585,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30606,7 +30599,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30624,7 +30617,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30641,20 +30634,20 @@ } } }, - "/spatial-scene-light/{id}": { + "/spatial-scene-material/{id}": { "get": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneLight", + "operationId": "getSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30664,7 +30657,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30676,7 +30669,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30691,7 +30684,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30708,17 +30701,17 @@ }, "delete": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneLight", + "operationId": "deleteSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30749,17 +30742,17 @@ }, "patch": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 Material resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneLight", + "operationId": "updateSpatialSceneMaterial", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_light", + "description": "Identifier for the spatial_scene_material", "required": true, "schema": { "type": "string", @@ -30777,18 +30770,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Light resource.", + "description": "Partially update information about a Spatial Scene Material resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneLight", + "description": "Detail of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30800,7 +30793,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30815,7 +30808,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30834,15 +30827,15 @@ } } }, - "/aggregate/spatial-scene-light": { + "/aggregate/spatial-scene-material": { "post": { "tags": [ - "Spatial Scene Light", + "Spatial Scene Material", "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 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": "aggregateSpatialSceneLight", + "operationId": "aggregateSpatialSceneMaterial", "requestBody": { "required": true, "content": { @@ -30866,7 +30859,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneLight", + "description": "List of SpatialSceneMaterial", "content": { "application/vnd.api+json": { "schema": { @@ -30880,7 +30873,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30898,7 +30891,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneLight" + "$ref": "#/components/schemas/SpatialSceneMaterial" } } } @@ -30915,15 +30908,15 @@ } } }, - "/spatial-scene-material": { + "/spatial-scene-object": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterialList", + "operationId": "getSpatialSceneObjectList", "parameters": [ { "name": "limit", @@ -30952,7 +30945,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Material resources.", + "description": "List of Spatial Scene Object resources.", "content": { "application/vnd.api+json": { "schema": { @@ -30971,7 +30964,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } ] @@ -30985,16 +30978,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-material?limit=25" + "example": "/spatial-scene-object?limit=25" }, "last": { - "example": "/spatial-scene-material?limit=25&page=11" + "example": "/spatial-scene-object?limit=25&page=11" }, "next": { - "example": "/spatial-scene-material?limit=25&page=4" + "example": "/spatial-scene-object?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-material?limit=25&page=2" + "example": "/spatial-scene-object?limit=25&page=2" } } } @@ -31015,7 +31008,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31030,12 +31023,12 @@ }, "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialSceneMaterial", + "operationId": "createSpatialSceneObject", "parameters": [ { "name": "_response", @@ -31054,14 +31047,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31073,7 +31066,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31088,7 +31081,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31104,15 +31097,15 @@ } } }, - "/search/spatial-scene-material": { + "/search/spatial-scene-object": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 Object resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialSceneMaterial", + "operationId": "searchSpatialSceneObject", "parameters": [ { "name": "sw-include-search-info", @@ -31140,7 +31133,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31154,7 +31147,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31172,7 +31165,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31189,20 +31182,20 @@ } } }, - "/spatial-scene-material/{id}": { + "/spatial-scene-object/{id}": { "get": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialSceneMaterial", + "operationId": "getSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -31212,7 +31205,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31224,7 +31217,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31239,7 +31232,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31256,17 +31249,17 @@ }, "delete": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialSceneMaterial", + "operationId": "deleteSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -31297,17 +31290,17 @@ }, "patch": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 Object resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialSceneMaterial", + "operationId": "updateSpatialSceneObject", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_material", + "description": "Identifier for the spatial_scene_object", "required": true, "schema": { "type": "string", @@ -31325,18 +31318,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Material resource.", + "description": "Partially update information about a Spatial Scene Object resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneMaterial", + "description": "Detail of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31348,7 +31341,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31363,7 +31356,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31382,15 +31375,15 @@ } } }, - "/aggregate/spatial-scene-material": { + "/aggregate/spatial-scene-object": { "post": { "tags": [ - "Spatial Scene Material", + "Spatial Scene Object", "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 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": "aggregateSpatialSceneMaterial", + "operationId": "aggregateSpatialSceneObject", "requestBody": { "required": true, "content": { @@ -31414,7 +31407,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneMaterial", + "description": "List of SpatialSceneObject", "content": { "application/vnd.api+json": { "schema": { @@ -31428,7 +31421,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31446,7 +31439,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneMaterial" + "$ref": "#/components/schemas/SpatialSceneObject" } } } @@ -31463,15 +31456,15 @@ } } }, - "/spatial-scene-object": { + "/spatial-scene-primitive": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "getSpatialSceneObjectList", + "operationId": "getSpatialScenePrimitiveList", "parameters": [ { "name": "limit", @@ -31500,7 +31493,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Object resources.", + "description": "List of Spatial Scene Primitive resources.", "content": { "application/vnd.api+json": { "schema": { @@ -31519,7 +31512,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } ] @@ -31533,16 +31526,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-object?limit=25" + "example": "/spatial-scene-primitive?limit=25" }, "last": { - "example": "/spatial-scene-object?limit=25&page=11" + "example": "/spatial-scene-primitive?limit=25&page=11" }, "next": { - "example": "/spatial-scene-object?limit=25&page=4" + "example": "/spatial-scene-primitive?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-object?limit=25&page=2" + "example": "/spatial-scene-primitive?limit=25&page=2" } } } @@ -31563,7 +31556,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31578,12 +31571,12 @@ }, "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "createSpatialSceneObject", + "operationId": "createSpatialScenePrimitive", "parameters": [ { "name": "_response", @@ -31602,14 +31595,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31621,7 +31614,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31636,7 +31629,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31652,15 +31645,15 @@ } } }, - "/search/spatial-scene-object": { + "/search/spatial-scene-primitive": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "searchSpatialSceneObject", + "operationId": "searchSpatialScenePrimitive", "parameters": [ { "name": "sw-include-search-info", @@ -31688,7 +31681,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31702,7 +31695,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31720,7 +31713,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31737,20 +31730,20 @@ } } }, - "/spatial-scene-object/{id}": { + "/spatial-scene-primitive/{id}": { "get": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "getSpatialSceneObject", + "operationId": "getSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31760,7 +31753,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31772,7 +31765,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31787,7 +31780,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31804,17 +31797,17 @@ }, "delete": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "deleteSpatialSceneObject", + "operationId": "deleteSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31845,17 +31838,17 @@ }, "patch": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "updateSpatialSceneObject", + "operationId": "updateSpatialScenePrimitive", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_object", + "description": "Identifier for the spatial_scene_primitive", "required": true, "schema": { "type": "string", @@ -31873,18 +31866,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Object resource.", + "description": "Partially update information about a Spatial Scene Primitive resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } }, "responses": { "200": { - "description": "Detail of SpatialSceneObject", + "description": "Detail of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31896,7 +31889,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31911,7 +31904,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31930,15 +31923,15 @@ } } }, - "/aggregate/spatial-scene-object": { + "/aggregate/spatial-scene-primitive": { "post": { "tags": [ - "Spatial Scene Object", + "Spatial Scene Primitive", "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 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": "aggregateSpatialSceneObject", + "operationId": "aggregateSpatialScenePrimitive", "requestBody": { "required": true, "content": { @@ -31962,7 +31955,7 @@ }, "responses": { "200": { - "description": "List of SpatialSceneObject", + "description": "List of SpatialScenePrimitive", "content": { "application/vnd.api+json": { "schema": { @@ -31976,7 +31969,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -31994,7 +31987,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialSceneObject" + "$ref": "#/components/schemas/SpatialScenePrimitive" } } } @@ -32011,15 +32004,15 @@ } } }, - "/spatial-scene-primitive": { + "/sso-provider": { "get": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitiveList", + "operationId": "getSsoProviderList", "parameters": [ { "name": "limit", @@ -32048,7 +32041,7 @@ ], "responses": { "200": { - "description": "List of Spatial Scene Primitive resources.", + "description": "List of Sso Provider resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32067,7 +32060,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } ] @@ -32081,16 +32074,16 @@ "type": "object", "properties": { "first": { - "example": "/spatial-scene-primitive?limit=25" + "example": "/sso-provider?limit=25" }, "last": { - "example": "/spatial-scene-primitive?limit=25&page=11" + "example": "/sso-provider?limit=25&page=11" }, "next": { - "example": "/spatial-scene-primitive?limit=25&page=4" + "example": "/sso-provider?limit=25&page=4" }, "prev": { - "example": "/spatial-scene-primitive?limit=25&page=2" + "example": "/sso-provider?limit=25&page=2" } } } @@ -32111,7 +32104,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32126,12 +32119,12 @@ }, "post": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "createSpatialScenePrimitive", + "operationId": "createSsoProvider", "parameters": [ { "name": "_response", @@ -32150,14 +32143,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32169,7 +32162,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32184,7 +32177,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32200,15 +32193,15 @@ } } }, - "/search/spatial-scene-primitive": { + "/search/sso-provider": { "post": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 resources. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "searchSpatialScenePrimitive", + "operationId": "searchSsoProvider", "parameters": [ { "name": "sw-include-search-info", @@ -32236,7 +32229,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32250,7 +32243,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32268,7 +32261,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32285,20 +32278,20 @@ } } }, - "/spatial-scene-primitive/{id}": { + "/sso-provider/{id}": { "get": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "getSpatialScenePrimitive", + "operationId": "getSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -32308,7 +32301,7 @@ ], "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32320,7 +32313,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32335,7 +32328,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32352,17 +32345,17 @@ }, "delete": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "deleteSpatialScenePrimitive", + "operationId": "deleteSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -32393,17 +32386,17 @@ }, "patch": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 resource. Experimental API, not part of our backwards compatibility promise, thus this API can introduce breaking changes at any time.", "description": "", - "operationId": "updateSpatialScenePrimitive", + "operationId": "updateSsoProvider", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the spatial_scene_primitive", + "description": "Identifier for the sso_provider", "required": true, "schema": { "type": "string", @@ -32421,18 +32414,18 @@ } ], "requestBody": { - "description": "Partially update information about a Spatial Scene Primitive resource.", + "description": "Partially update information about a Sso Provider resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } }, "responses": { "200": { - "description": "Detail of SpatialScenePrimitive", + "description": "Detail of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32444,7 +32437,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32459,7 +32452,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32478,15 +32471,15 @@ } } }, - "/aggregate/spatial-scene-primitive": { + "/aggregate/sso-provider": { "post": { "tags": [ - "Spatial Scene Primitive", + "Sso Provider", "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 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": "aggregateSsoProvider", "requestBody": { "required": true, "content": { @@ -32510,7 +32503,7 @@ }, "responses": { "200": { - "description": "List of SpatialScenePrimitive", + "description": "List of SsoProvider", "content": { "application/vnd.api+json": { "schema": { @@ -32524,7 +32517,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32542,7 +32535,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SpatialScenePrimitive" + "$ref": "#/components/schemas/SsoProvider" } } } @@ -32559,15 +32552,15 @@ } } }, - "/sso-provider": { + "/sso-provider-customer": { "get": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "getSsoProviderList", + "operationId": "getSsoProviderCustomerList", "parameters": [ { "name": "limit", @@ -32596,7 +32589,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider resources.", + "description": "List of Sso Provider Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -32615,7 +32608,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } ] @@ -32629,16 +32622,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider?limit=25" + "example": "/sso-provider-customer?limit=25" }, "last": { - "example": "/sso-provider?limit=25&page=11" + "example": "/sso-provider-customer?limit=25&page=11" }, "next": { - "example": "/sso-provider?limit=25&page=4" + "example": "/sso-provider-customer?limit=25&page=4" }, "prev": { - "example": "/sso-provider?limit=25&page=2" + "example": "/sso-provider-customer?limit=25&page=2" } } } @@ -32659,7 +32652,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32674,12 +32667,12 @@ }, "post": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "createSsoProvider", + "operationId": "createSsoProviderCustomer", "parameters": [ { "name": "_response", @@ -32698,14 +32691,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32717,7 +32710,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32732,7 +32725,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32748,15 +32741,15 @@ } } }, - "/search/sso-provider": { + "/search/sso-provider-customer": { "post": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "searchSsoProvider", + "operationId": "searchSsoProviderCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -32784,7 +32777,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32798,7 +32791,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32816,7 +32809,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32833,20 +32826,20 @@ } } }, - "/sso-provider/{id}": { + "/sso-provider-customer/{id}": { "get": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "getSsoProvider", + "operationId": "getSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32856,7 +32849,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32868,7 +32861,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32883,7 +32876,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -32900,17 +32893,17 @@ }, "delete": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "deleteSsoProvider", + "operationId": "deleteSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32941,17 +32934,17 @@ }, "patch": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "updateSsoProvider", + "operationId": "updateSsoProviderCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider", + "description": "Identifier for the sso_provider_customer", "required": true, "schema": { "type": "string", @@ -32969,18 +32962,18 @@ } ], "requestBody": { - "description": "Partially update information about a Sso Provider resource.", + "description": "Partially update information about a Sso Provider Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } }, "responses": { "200": { - "description": "Detail of SsoProvider", + "description": "Detail of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -32992,7 +32985,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33007,7 +33000,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33026,15 +33019,15 @@ } } }, - "/aggregate/sso-provider": { + "/aggregate/sso-provider-customer": { "post": { "tags": [ - "Sso Provider", + "Sso Provider Customer", "Experimental" ], - "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 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": "aggregateSsoProvider", + "operationId": "aggregateSsoProviderCustomer", "requestBody": { "required": true, "content": { @@ -33058,7 +33051,7 @@ }, "responses": { "200": { - "description": "List of SsoProvider", + "description": "List of SsoProviderCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -33072,7 +33065,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33090,7 +33083,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProvider" + "$ref": "#/components/schemas/SsoProviderCustomer" } } } @@ -33107,15 +33100,14 @@ } } }, - "/sso-provider-customer": { + "/subscription": { "get": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resources.", "description": "", - "operationId": "getSsoProviderCustomerList", + "operationId": "getSubscriptionList", "parameters": [ { "name": "limit", @@ -33144,7 +33136,7 @@ ], "responses": { "200": { - "description": "List of Sso Provider Customer resources.", + "description": "List of Subscription resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33163,7 +33155,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } ] @@ -33177,16 +33169,16 @@ "type": "object", "properties": { "first": { - "example": "/sso-provider-customer?limit=25" + "example": "/subscription?limit=25" }, "last": { - "example": "/sso-provider-customer?limit=25&page=11" + "example": "/subscription?limit=25&page=11" }, "next": { - "example": "/sso-provider-customer?limit=25&page=4" + "example": "/subscription?limit=25&page=4" }, "prev": { - "example": "/sso-provider-customer?limit=25&page=2" + "example": "/subscription?limit=25&page=2" } } } @@ -33207,7 +33199,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33222,12 +33214,11 @@ }, "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resources.", "description": "", - "operationId": "createSsoProviderCustomer", + "operationId": "createSubscription", "parameters": [ { "name": "_response", @@ -33246,14 +33237,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33265,7 +33256,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33280,7 +33271,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33296,15 +33287,14 @@ } } }, - "/search/sso-provider-customer": { + "/search/subscription": { "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resources.", "description": "", - "operationId": "searchSsoProviderCustomer", + "operationId": "searchSubscription", "parameters": [ { "name": "sw-include-search-info", @@ -33332,7 +33322,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33346,7 +33336,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33364,7 +33354,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33381,20 +33371,19 @@ } } }, - "/sso-provider-customer/{id}": { + "/subscription/{id}": { "get": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resource.", "description": "", - "operationId": "getSsoProviderCustomer", + "operationId": "getSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -33404,7 +33393,7 @@ ], "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33416,7 +33405,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33431,7 +33420,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33448,17 +33437,16 @@ }, "delete": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resource.", "description": "", - "operationId": "deleteSsoProviderCustomer", + "operationId": "deleteSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the subscription", "required": true, "schema": { "type": "string", @@ -33489,17 +33477,16 @@ }, "patch": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resource.", "description": "", - "operationId": "updateSsoProviderCustomer", + "operationId": "updateSubscription", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the sso_provider_customer", + "description": "Identifier for the subscription", "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 resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } }, "responses": { "200": { - "description": "Detail of SsoProviderCustomer", + "description": "Detail of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33540,7 +33527,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33555,7 +33542,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33574,15 +33561,14 @@ } } }, - "/aggregate/sso-provider-customer": { + "/aggregate/subscription": { "post": { "tags": [ - "Sso Provider Customer", - "Experimental" + "Subscription" ], - "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 resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSsoProviderCustomer", + "operationId": "aggregateSubscription", "requestBody": { "required": true, "content": { @@ -33606,7 +33592,7 @@ }, "responses": { "200": { - "description": "List of SsoProviderCustomer", + "description": "List of Subscription", "content": { "application/vnd.api+json": { "schema": { @@ -33620,7 +33606,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33638,7 +33624,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SsoProviderCustomer" + "$ref": "#/components/schemas/Subscription" } } } @@ -33655,14 +33641,14 @@ } } }, - "/subscription": { + "/subscription-address": { "get": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "List with basic information of Subscription resources.", + "summary": "List with basic information of Subscription Address resources.", "description": "", - "operationId": "getSubscriptionList", + "operationId": "getSubscriptionAddressList", "parameters": [ { "name": "limit", @@ -33691,7 +33677,7 @@ ], "responses": { "200": { - "description": "List of Subscription resources.", + "description": "List of Subscription Address resources.", "content": { "application/vnd.api+json": { "schema": { @@ -33710,7 +33696,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } ] @@ -33724,16 +33710,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription?limit=25" + "example": "/subscription-address?limit=25" }, "last": { - "example": "/subscription?limit=25&page=11" + "example": "/subscription-address?limit=25&page=11" }, "next": { - "example": "/subscription?limit=25&page=4" + "example": "/subscription-address?limit=25&page=4" }, "prev": { - "example": "/subscription?limit=25&page=2" + "example": "/subscription-address?limit=25&page=2" } } } @@ -33754,7 +33740,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33769,11 +33755,11 @@ }, "post": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "Create a new Subscription resources.", + "summary": "Create a new Subscription Address resources.", "description": "", - "operationId": "createSubscription", + "operationId": "createSubscriptionAddress", "parameters": [ { "name": "_response", @@ -33792,14 +33778,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33811,7 +33797,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33826,7 +33812,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33842,14 +33828,14 @@ } } }, - "/search/subscription": { + "/search/subscription-address": { "post": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "Search for the Subscription resources.", + "summary": "Search for the Subscription Address resources.", "description": "", - "operationId": "searchSubscription", + "operationId": "searchSubscriptionAddress", "parameters": [ { "name": "sw-include-search-info", @@ -33877,7 +33863,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33891,7 +33877,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33909,7 +33895,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33926,19 +33912,19 @@ } } }, - "/subscription/{id}": { + "/subscription-address/{id}": { "get": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "Detailed information about a Subscription resource.", + "summary": "Detailed information about a Subscription Address resource.", "description": "", - "operationId": "getSubscription", + "operationId": "getSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -33948,7 +33934,7 @@ ], "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -33960,7 +33946,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33975,7 +33961,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -33992,16 +33978,16 @@ }, "delete": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "Delete a Subscription resource.", + "summary": "Delete a Subscription Address resource.", "description": "", - "operationId": "deleteSubscription", + "operationId": "deleteSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the subscription_address", "required": true, "schema": { "type": "string", @@ -34032,16 +34018,16 @@ }, "patch": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "Partially update information about a Subscription resource.", + "summary": "Partially update information about a Subscription Address resource.", "description": "", - "operationId": "updateSubscription", + "operationId": "updateSubscriptionAddress", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription", + "description": "Identifier for the subscription_address", "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 Address resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } }, "responses": { "200": { - "description": "Detail of Subscription", + "description": "Detail of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34082,7 +34068,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34097,7 +34083,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34116,14 +34102,14 @@ } } }, - "/aggregate/subscription": { + "/aggregate/subscription-address": { "post": { "tags": [ - "Subscription" + "Subscription Address" ], - "summary": "Aggregate for the Subscription resources.", + "summary": "Aggregate for the Subscription Address resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscription", + "operationId": "aggregateSubscriptionAddress", "requestBody": { "required": true, "content": { @@ -34147,7 +34133,7 @@ }, "responses": { "200": { - "description": "List of Subscription", + "description": "List of SubscriptionAddress", "content": { "application/vnd.api+json": { "schema": { @@ -34161,7 +34147,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34179,7 +34165,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Subscription" + "$ref": "#/components/schemas/SubscriptionAddress" } } } @@ -34196,14 +34182,14 @@ } } }, - "/subscription-address": { + "/subscription-customer": { "get": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "List with basic information of Subscription Address resources.", + "summary": "List with basic information of Subscription Customer resources.", "description": "", - "operationId": "getSubscriptionAddressList", + "operationId": "getSubscriptionCustomerList", "parameters": [ { "name": "limit", @@ -34232,7 +34218,7 @@ ], "responses": { "200": { - "description": "List of Subscription Address resources.", + "description": "List of Subscription Customer resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34251,7 +34237,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } ] @@ -34265,16 +34251,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-address?limit=25" + "example": "/subscription-customer?limit=25" }, "last": { - "example": "/subscription-address?limit=25&page=11" + "example": "/subscription-customer?limit=25&page=11" }, "next": { - "example": "/subscription-address?limit=25&page=4" + "example": "/subscription-customer?limit=25&page=4" }, "prev": { - "example": "/subscription-address?limit=25&page=2" + "example": "/subscription-customer?limit=25&page=2" } } } @@ -34295,7 +34281,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34310,11 +34296,11 @@ }, "post": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "Create a new Subscription Address resources.", + "summary": "Create a new Subscription Customer resources.", "description": "", - "operationId": "createSubscriptionAddress", + "operationId": "createSubscriptionCustomer", "parameters": [ { "name": "_response", @@ -34333,14 +34319,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34352,7 +34338,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34367,7 +34353,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34383,14 +34369,14 @@ } } }, - "/search/subscription-address": { + "/search/subscription-customer": { "post": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "Search for the Subscription Address resources.", + "summary": "Search for the Subscription Customer resources.", "description": "", - "operationId": "searchSubscriptionAddress", + "operationId": "searchSubscriptionCustomer", "parameters": [ { "name": "sw-include-search-info", @@ -34418,7 +34404,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34432,7 +34418,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34450,7 +34436,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34467,19 +34453,19 @@ } } }, - "/subscription-address/{id}": { + "/subscription-customer/{id}": { "get": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "Detailed information about a Subscription Address resource.", + "summary": "Detailed information about a Subscription Customer resource.", "description": "", - "operationId": "getSubscriptionAddress", + "operationId": "getSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -34489,7 +34475,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34501,7 +34487,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34516,7 +34502,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34533,16 +34519,16 @@ }, "delete": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "Delete a Subscription Address resource.", + "summary": "Delete a Subscription Customer resource.", "description": "", - "operationId": "deleteSubscriptionAddress", + "operationId": "deleteSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the subscription_customer", "required": true, "schema": { "type": "string", @@ -34573,16 +34559,16 @@ }, "patch": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "Partially update information about a Subscription Address resource.", + "summary": "Partially update information about a Subscription Customer resource.", "description": "", - "operationId": "updateSubscriptionAddress", + "operationId": "updateSubscriptionCustomer", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_address", + "description": "Identifier for the subscription_customer", "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 Customer resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionAddress", + "description": "Detail of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34623,7 +34609,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34638,7 +34624,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34657,14 +34643,14 @@ } } }, - "/aggregate/subscription-address": { + "/aggregate/subscription-customer": { "post": { "tags": [ - "Subscription Address" + "Subscription Customer" ], - "summary": "Aggregate for the Subscription Address resources.", + "summary": "Aggregate for the Subscription Customer resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionAddress", + "operationId": "aggregateSubscriptionCustomer", "requestBody": { "required": true, "content": { @@ -34688,7 +34674,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionAddress", + "description": "List of SubscriptionCustomer", "content": { "application/vnd.api+json": { "schema": { @@ -34702,7 +34688,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34720,7 +34706,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionAddress" + "$ref": "#/components/schemas/SubscriptionCustomer" } } } @@ -34737,14 +34723,14 @@ } } }, - "/subscription-customer": { + "/subscription-interval": { "get": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "List with basic information of Subscription Customer resources.", + "summary": "List with basic information of Subscription Interval resources.", "description": "", - "operationId": "getSubscriptionCustomerList", + "operationId": "getSubscriptionIntervalList", "parameters": [ { "name": "limit", @@ -34773,7 +34759,7 @@ ], "responses": { "200": { - "description": "List of Subscription Customer resources.", + "description": "List of Subscription Interval resources.", "content": { "application/vnd.api+json": { "schema": { @@ -34792,7 +34778,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } ] @@ -34806,16 +34792,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-customer?limit=25" + "example": "/subscription-interval?limit=25" }, "last": { - "example": "/subscription-customer?limit=25&page=11" + "example": "/subscription-interval?limit=25&page=11" }, "next": { - "example": "/subscription-customer?limit=25&page=4" + "example": "/subscription-interval?limit=25&page=4" }, "prev": { - "example": "/subscription-customer?limit=25&page=2" + "example": "/subscription-interval?limit=25&page=2" } } } @@ -34836,7 +34822,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34851,11 +34837,11 @@ }, "post": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "Create a new Subscription Customer resources.", + "summary": "Create a new Subscription Interval resources.", "description": "", - "operationId": "createSubscriptionCustomer", + "operationId": "createSubscriptionInterval", "parameters": [ { "name": "_response", @@ -34874,14 +34860,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34893,7 +34879,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34908,7 +34894,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34924,14 +34910,14 @@ } } }, - "/search/subscription-customer": { + "/search/subscription-interval": { "post": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "Search for the Subscription Customer resources.", + "summary": "Search for the Subscription Interval resources.", "description": "", - "operationId": "searchSubscriptionCustomer", + "operationId": "searchSubscriptionInterval", "parameters": [ { "name": "sw-include-search-info", @@ -34959,7 +34945,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -34973,7 +34959,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -34991,7 +34977,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35008,19 +34994,19 @@ } } }, - "/subscription-customer/{id}": { + "/subscription-interval/{id}": { "get": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "Detailed information about a Subscription Customer resource.", + "summary": "Detailed information about a Subscription Interval resource.", "description": "", - "operationId": "getSubscriptionCustomer", + "operationId": "getSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -35030,7 +35016,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35042,7 +35028,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35057,7 +35043,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35074,16 +35060,16 @@ }, "delete": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "Delete a Subscription Customer resource.", + "summary": "Delete a Subscription Interval resource.", "description": "", - "operationId": "deleteSubscriptionCustomer", + "operationId": "deleteSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription_interval", "required": true, "schema": { "type": "string", @@ -35114,16 +35100,16 @@ }, "patch": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "Partially update information about a Subscription Customer resource.", + "summary": "Partially update information about a Subscription Interval resource.", "description": "", - "operationId": "updateSubscriptionCustomer", + "operationId": "updateSubscriptionInterval", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_customer", + "description": "Identifier for the subscription_interval", "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 Interval resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionCustomer", + "description": "Detail of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35164,7 +35150,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35179,7 +35165,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35198,14 +35184,14 @@ } } }, - "/aggregate/subscription-customer": { + "/aggregate/subscription-interval": { "post": { "tags": [ - "Subscription Customer" + "Subscription Interval" ], - "summary": "Aggregate for the Subscription Customer resources.", + "summary": "Aggregate for the Subscription Interval resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionCustomer", + "operationId": "aggregateSubscriptionInterval", "requestBody": { "required": true, "content": { @@ -35229,7 +35215,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionCustomer", + "description": "List of SubscriptionInterval", "content": { "application/vnd.api+json": { "schema": { @@ -35243,7 +35229,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35261,7 +35247,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionCustomer" + "$ref": "#/components/schemas/SubscriptionInterval" } } } @@ -35278,14 +35264,14 @@ } } }, - "/subscription-interval": { + "/subscription-plan": { "get": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "List with basic information of Subscription Interval resources.", + "summary": "List with basic information of Subscription Plan resources.", "description": "", - "operationId": "getSubscriptionIntervalList", + "operationId": "getSubscriptionPlanList", "parameters": [ { "name": "limit", @@ -35314,7 +35300,7 @@ ], "responses": { "200": { - "description": "List of Subscription Interval resources.", + "description": "List of Subscription Plan resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35333,7 +35319,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } ] @@ -35347,16 +35333,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-interval?limit=25" + "example": "/subscription-plan?limit=25" }, "last": { - "example": "/subscription-interval?limit=25&page=11" + "example": "/subscription-plan?limit=25&page=11" }, "next": { - "example": "/subscription-interval?limit=25&page=4" + "example": "/subscription-plan?limit=25&page=4" }, "prev": { - "example": "/subscription-interval?limit=25&page=2" + "example": "/subscription-plan?limit=25&page=2" } } } @@ -35377,7 +35363,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35392,11 +35378,11 @@ }, "post": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "Create a new Subscription Interval resources.", + "summary": "Create a new Subscription Plan resources.", "description": "", - "operationId": "createSubscriptionInterval", + "operationId": "createSubscriptionPlan", "parameters": [ { "name": "_response", @@ -35415,14 +35401,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35434,7 +35420,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35449,7 +35435,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35465,14 +35451,14 @@ } } }, - "/search/subscription-interval": { + "/search/subscription-plan": { "post": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "Search for the Subscription Interval resources.", + "summary": "Search for the Subscription Plan resources.", "description": "", - "operationId": "searchSubscriptionInterval", + "operationId": "searchSubscriptionPlan", "parameters": [ { "name": "sw-include-search-info", @@ -35500,7 +35486,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35514,7 +35500,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35532,7 +35518,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35549,19 +35535,19 @@ } } }, - "/subscription-interval/{id}": { + "/subscription-plan/{id}": { "get": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "Detailed information about a Subscription Interval resource.", + "summary": "Detailed information about a Subscription Plan resource.", "description": "", - "operationId": "getSubscriptionInterval", + "operationId": "getSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35571,7 +35557,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35583,7 +35569,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35598,7 +35584,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35615,16 +35601,16 @@ }, "delete": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "Delete a Subscription Interval resource.", + "summary": "Delete a Subscription Plan resource.", "description": "", - "operationId": "deleteSubscriptionInterval", + "operationId": "deleteSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_plan", "required": true, "schema": { "type": "string", @@ -35655,16 +35641,16 @@ }, "patch": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "Partially update information about a Subscription Interval resource.", + "summary": "Partially update information about a Subscription Plan resource.", "description": "", - "operationId": "updateSubscriptionInterval", + "operationId": "updateSubscriptionPlan", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_interval", + "description": "Identifier for the subscription_plan", "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 Subscription Plan resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionInterval", + "description": "Detail of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35705,7 +35691,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35720,7 +35706,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35739,14 +35725,14 @@ } } }, - "/aggregate/subscription-interval": { + "/aggregate/subscription-plan": { "post": { "tags": [ - "Subscription Interval" + "Subscription Plan" ], - "summary": "Aggregate for the Subscription Interval resources.", + "summary": "Aggregate for the Subscription Plan resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionInterval", + "operationId": "aggregateSubscriptionPlan", "requestBody": { "required": true, "content": { @@ -35770,7 +35756,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionInterval", + "description": "List of SubscriptionPlan", "content": { "application/vnd.api+json": { "schema": { @@ -35784,7 +35770,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35802,7 +35788,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionInterval" + "$ref": "#/components/schemas/SubscriptionPlan" } } } @@ -35819,14 +35805,14 @@ } } }, - "/subscription-plan": { + "/swag-delay-action": { "get": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "List with basic information of Subscription Plan resources.", + "summary": "List with basic information of Swag Delay Action resources.", "description": "", - "operationId": "getSubscriptionPlanList", + "operationId": "getSwagDelayActionList", "parameters": [ { "name": "limit", @@ -35855,7 +35841,7 @@ ], "responses": { "200": { - "description": "List of Subscription Plan resources.", + "description": "List of Swag Delay Action resources.", "content": { "application/vnd.api+json": { "schema": { @@ -35874,7 +35860,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } ] @@ -35888,16 +35874,16 @@ "type": "object", "properties": { "first": { - "example": "/subscription-plan?limit=25" + "example": "/swag-delay-action?limit=25" }, "last": { - "example": "/subscription-plan?limit=25&page=11" + "example": "/swag-delay-action?limit=25&page=11" }, "next": { - "example": "/subscription-plan?limit=25&page=4" + "example": "/swag-delay-action?limit=25&page=4" }, "prev": { - "example": "/subscription-plan?limit=25&page=2" + "example": "/swag-delay-action?limit=25&page=2" } } } @@ -35918,7 +35904,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35933,11 +35919,11 @@ }, "post": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "Create a new Subscription Plan resources.", + "summary": "Create a new Swag Delay Action resources.", "description": "", - "operationId": "createSubscriptionPlan", + "operationId": "createSwagDelayAction", "parameters": [ { "name": "_response", @@ -35956,14 +35942,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -35975,7 +35961,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -35990,7 +35976,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36006,14 +35992,14 @@ } } }, - "/search/subscription-plan": { + "/search/swag-delay-action": { "post": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "Search for the Subscription Plan resources.", + "summary": "Search for the Swag Delay Action resources.", "description": "", - "operationId": "searchSubscriptionPlan", + "operationId": "searchSwagDelayAction", "parameters": [ { "name": "sw-include-search-info", @@ -36041,7 +36027,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -36055,7 +36041,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36073,7 +36059,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36090,19 +36076,19 @@ } } }, - "/subscription-plan/{id}": { + "/swag-delay-action/{id}": { "get": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "Detailed information about a Subscription Plan resource.", + "summary": "Detailed information about a Swag Delay Action resource.", "description": "", - "operationId": "getSubscriptionPlan", + "operationId": "getSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -36112,7 +36098,7 @@ ], "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -36124,7 +36110,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36139,7 +36125,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36156,16 +36142,16 @@ }, "delete": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "Delete a Subscription Plan resource.", + "summary": "Delete a Swag Delay Action resource.", "description": "", - "operationId": "deleteSubscriptionPlan", + "operationId": "deleteSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -36196,16 +36182,16 @@ }, "patch": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "Partially update information about a Subscription Plan resource.", + "summary": "Partially update information about a Swag Delay Action resource.", "description": "", - "operationId": "updateSubscriptionPlan", + "operationId": "updateSwagDelayAction", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier for the subscription_plan", + "description": "Identifier for the swag_delay_action", "required": true, "schema": { "type": "string", @@ -36223,18 +36209,18 @@ } ], "requestBody": { - "description": "Partially update information about a Subscription Plan resource.", + "description": "Partially update information about a Swag Delay Action resource.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } }, "responses": { "200": { - "description": "Detail of SubscriptionPlan", + "description": "Detail of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -36246,7 +36232,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36261,7 +36247,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36280,14 +36266,14 @@ } } }, - "/aggregate/subscription-plan": { + "/aggregate/swag-delay-action": { "post": { "tags": [ - "Subscription Plan" + "Swag Delay Action" ], - "summary": "Aggregate for the Subscription Plan resources.", + "summary": "Aggregate for the Swag Delay Action resources.", "description": "Available since: 6.6.10.0", - "operationId": "aggregateSubscriptionPlan", + "operationId": "aggregateSwagDelayAction", "requestBody": { "required": true, "content": { @@ -36311,7 +36297,7 @@ }, "responses": { "200": { - "description": "List of SubscriptionPlan", + "description": "List of SwagDelayAction", "content": { "application/vnd.api+json": { "schema": { @@ -36325,7 +36311,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36343,7 +36329,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SubscriptionPlan" + "$ref": "#/components/schemas/SwagDelayAction" } } } @@ -36360,14 +36346,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 +36382,7 @@ ], "responses": { "200": { - "description": "List of Swag Delay Action resources.", + "description": "List of Warehouse resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36415,7 +36401,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } ] @@ -36429,16 +36415,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 +36445,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36474,11 +36460,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 +36483,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 +36502,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36531,7 +36517,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36547,14 +36533,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 +36568,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36596,7 +36582,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36614,7 +36600,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36631,19 +36617,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 +36639,7 @@ ], "responses": { "200": { - "description": "Detail of SwagDelayAction", + "description": "Detail of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36665,7 +36651,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36680,7 +36666,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36697,16 +36683,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 +36723,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 +36750,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 +36773,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36802,7 +36788,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36821,14 +36807,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 +36838,7 @@ }, "responses": { "200": { - "description": "List of SwagDelayAction", + "description": "List of Warehouse", "content": { "application/vnd.api+json": { "schema": { @@ -36866,7 +36852,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36884,7 +36870,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/SwagDelayAction" + "$ref": "#/components/schemas/Warehouse" } } } @@ -36901,14 +36887,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 +36923,7 @@ ], "responses": { "200": { - "description": "List of Warehouse resources.", + "description": "List of Warehouse Group resources.", "content": { "application/vnd.api+json": { "schema": { @@ -36956,7 +36942,7 @@ { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } ] @@ -36970,16 +36956,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 +36986,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37015,11 +37001,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 +37024,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 +37043,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37072,7 +37058,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37088,14 +37074,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 +37109,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37137,7 +37123,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37155,7 +37141,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37172,19 +37158,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 +37180,7 @@ ], "responses": { "200": { - "description": "Detail of Warehouse", + "description": "Detail of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37206,7 +37192,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37221,7 +37207,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37238,16 +37224,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 +37264,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 +37291,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 +37314,7 @@ "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37343,7 +37329,7 @@ ], "properties": { "data": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37362,14 +37348,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": { @@ -37393,7 +37379,7 @@ }, "responses": { "200": { - "description": "List of Warehouse", + "description": "List of WarehouseGroup", "content": { "application/vnd.api+json": { "schema": { @@ -37407,7 +37393,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37425,7 +37411,7 @@ "data": { "type": "array", "items": { - "$ref": "#/components/schemas/Warehouse" + "$ref": "#/components/schemas/WarehouseGroup" } } } @@ -37442,262 +37428,94 @@ } } }, - "/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" - } - } - }, + "/_action/media/presign-upload": { "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" - ] - } - } + "Asset Management" ], + "summary": "Prepare a presigned upload", + "description": "Creates or reuses a media entity and returns a presigned S3 URL for direct browser-to-storage upload. The client uploads the file directly to the returned URL, then calls the finalize endpoint.", + "operationId": "presignUpload", "requestBody": { + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "object", + "required": [ + "fileName", + "extension", + "mimeType" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file without extension" + }, + "extension": { + "type": "string", + "description": "File extension, e.g. `jpg`, `png`, `pdf`" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file, e.g. `image/jpeg`" + }, + "mediaFolderId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media folder to place the new media in" + }, + "private": { + "type": "boolean", + "default": false, + "description": "Whether the media should be private" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of an existing media entity to replace. If omitted, a new entity is created." + } + } } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Presigned upload prepared successfully", "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" + "mediaId", + "url", + "path", + "expiresAt", + "isDuplicate" ], "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", - "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the media entity" }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - } - ] - } - }, - "application/json": { - "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" + "url": { + "type": "string", + "description": "Presigned URL to upload the file to via HTTP PUT" }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } + "path": { + "type": "string", + "description": "Storage path of the media file, required for the finalize call" + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "Expiration time of the presigned URL" + }, + "isDuplicate": { + "type": "boolean", + "description": "Whether a file with the same name already exists" } } } @@ -37705,186 +37523,102 @@ } }, "400": { + "description": "Bad request. The file extension is not supported or the file name is invalid.", "$ref": "#/components/responses/400" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/warehouse-group/{id}": { - "get": { - "tags": [ - "Warehouse Group" - ], - "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}$" - } - } - ], - "responses": { - "200": { - "description": "Detail of WarehouseGroup", + "404": { + "description": "The media entity with the given `mediaId` was not found.", + "$ref": "#/components/responses/404" + }, + "422": { + "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`) must not be blank.", "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" - } - } + "$ref": "#/components/schemas/failure" } } } - }, - "404": { - "$ref": "#/components/responses/404" - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "delete": { - "tags": [ - "Warehouse Group" - ], - "summary": "Delete a Warehouse Group resource.", - "description": "", - "operationId": "deleteWarehouseGroup", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier for the warehouse_group", - "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": { + } + }, + "/_action/media/{mediaId}/finalize-upload": { + "post": { "tags": [ - "Warehouse Group" + "Asset Management" ], - "summary": "Partially update information about a Warehouse Group resource.", - "description": "", - "operationId": "updateWarehouseGroup", + "summary": "Finalize a presigned upload", + "description": "Confirms that the file has been uploaded to storage via the presigned URL and updates the media entity with file metadata.", + "operationId": "finalizeUpload", "parameters": [ { - "name": "id", + "name": "mediaId", "in": "path", - "description": "Identifier for the warehouse_group", "required": true, + "description": "ID of the media entity to finalize", "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" } } ], "requestBody": { - "description": "Partially update information about a Warehouse Group resource.", + "required": true, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WarehouseGroup" + "type": "object", + "required": [ + "fileName", + "extension", + "mimeType", + "path" + ], + "properties": { + "fileName": { + "type": "string", + "description": "Name of the file without extension" + }, + "extension": { + "type": "string", + "description": "File extension, e.g. `jpg`, `png`, `pdf`" + }, + "mimeType": { + "type": "string", + "description": "MIME type of the file" + }, + "path": { + "type": "string", + "description": "Storage path returned by the presign-upload endpoint" + }, + "width": { + "type": "integer", + "description": "Image width in pixels (optional, for images only)" + }, + "height": { + "type": "integer", + "description": "Image height in pixels (optional, for images only)" + } + } } } } }, "responses": { "200": { - "description": "Detail of WarehouseGroup", + "description": "Upload finalized successfully", "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" + "mediaId" ], "properties": { - "data": { - "$ref": "#/components/schemas/WarehouseGroup" + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "description": "ID of the finalized media entity" } } } @@ -37892,93 +37626,22 @@ } }, "400": { + "description": "Bad request. The file extension is not supported, the storage path does not match, the file name is already taken, or the file could not be found on the remote storage.", "$ref": "#/components/responses/400" }, "404": { + "description": "The media entity with the given `mediaId` was not found.", "$ref": "#/components/responses/404" }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/aggregate/warehouse-group": { - "post": { - "tags": [ - "Warehouse Group" - ], - "summary": "Aggregate for the Warehouse Group resources.", - "description": "Available since: 6.6.10.0", - "operationId": "aggregateWarehouseGroup", - "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 WarehouseGroup", + "422": { + "description": "Validation error. Required fields (`fileName`, `extension`, `mimeType`, `path`) must not be blank.", "content": { - "application/vnd.api+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/success" - }, - { - "type": "object", - "properties": { - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } - } - ] - } - }, "application/json": { "schema": { - "type": "object", - "properties": { - "total": { - "type": "integer" - }, - "data": { - "type": "array", - "items": { - "$ref": "#/components/schemas/WarehouseGroup" - } - } - } + "$ref": "#/components/schemas/failure" } } } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" } } } @@ -51005,12 +50668,6 @@ "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, "stock": { "description": "Indicates the number of products available.", "type": "integer", @@ -51230,6 +50887,13 @@ "readOnly": true, "deprecated": true }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -52880,12 +52544,6 @@ "description": "When the value is set to true, the product is hidden when sold out.", "type": "boolean" }, - "availableStock": { - "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", - "type": "integer", - "format": "int64", - "readOnly": true - }, "stock": { "description": "Indicates the number of products available.", "type": "integer", @@ -53105,6 +52763,13 @@ "readOnly": true, "deprecated": true }, + "availableStock": { + "description": "Indicates the number of products still available. This value results from the stock minus the open orders.", + "type": "integer", + "format": "int64", + "readOnly": true, + "deprecated": true + }, "createdAt": { "type": "string", "format": "date-time", @@ -63886,6 +63551,37 @@ } }, "type": "object" + }, + "documentFiles": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document/0945359809dad1fbf3dea1c95a0da951/documentFiles" + } + } + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_file" + }, + "id": { + "type": "string", + "example": "aad3bfae9fe3322b72a0bfbdda842b11" + } + } + } + } + }, + "type": "object" } }, "type": "object" @@ -63981,6 +63677,12 @@ }, "documentA11yMediaFile": { "$ref": "#/components/schemas/Media" + }, + "documentFiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentFile" + } } }, "type": "object" @@ -64408,6 +64110,156 @@ }, "type": "object" }, + "DocumentFileJsonApi": { + "description": "Added since version: 6.7.10.0", + "allOf": [ + { + "$ref": "#/components/schemas/resource" + }, + { + "required": [ + "id", + "documentId", + "mediaId", + "documentFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentFormat": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "relationships": { + "properties": { + "document": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-file/5580291c9799ddf9960e32b951f5e86b/document" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "fdc3bdefb79cec8eb8211d2499e04704" + } + } + } + }, + "type": "object" + }, + "media": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/document-file/5580291c9799ddf9960e32b951f5e86b/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" + } + ] + }, + "DocumentFile": { + "description": "Added since version: 6.7.10.0", + "required": [ + "id", + "documentId", + "mediaId", + "documentFormat" + ], + "properties": { + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "mediaId": { + "type": "string", + "pattern": "^[0-9a-f]{32}$" + }, + "documentFormat": { + "type": "string" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "document": { + "$ref": "#/components/schemas/Document" + }, + "media": { + "$ref": "#/components/schemas/Media" + } + }, + "type": "object" + }, "DocumentTypeJsonApi": { "description": "Added since version: 6.0.0.0", "allOf": [ @@ -70190,6 +70042,35 @@ } }, "type": "object" + }, + "documentFile": { + "properties": { + "links": { + "type": "object", + "properties": { + "related": { + "type": "string", + "format": "uri-reference", + "example": "/media/3b563524fdb17b4a86590470d40bef74/documentFile" + } + } + }, + "data": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "document_file" + }, + "id": { + "type": "string", + "pattern": "^[0-9a-f]{32}$", + "example": "e6fc751fcb387f6f87970b7fed0b489f" + } + } + } + }, + "type": "object" } }, "type": "object" @@ -70658,6 +70539,9 @@ "items": { "$ref": "#/components/schemas/AppShippingMethod" } + }, + "documentFile": { + "$ref": "#/components/schemas/DocumentFile" } }, "type": "object" @@ -83361,6 +83245,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -83371,9 +83258,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -83490,6 +83374,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -83500,9 +83387,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -96110,6 +95994,11 @@ "customFields": { "type": "object" }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -96412,6 +96301,11 @@ "customFields": { "type": "object" }, + "position": { + "description": "Numerical value that indicates the order in which the defined salutations must be displayed in the frontend.", + "type": "integer", + "format": "int64" + }, "createdAt": { "type": "string", "format": "date-time", @@ -109698,6 +109592,10 @@ "disableExtensionManagement": { "type": "boolean", "description": "True if runtime extension management is disabled." + }, + "presignedUploadSupported": { + "type": "boolean", + "description": "Whether presigned S3 upload is available. True when presigned upload is enabled and an S3 filesystem is configured." } }, "required": [ @@ -110665,39 +110563,62 @@ "description": "Price object", "properties": { "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { - "description": "", + "description": "Gross price for the associated currency.", "type": "number" }, "net": { - "description": "", + "description": "Net price for the associated currency.", "type": "number" }, "linked": { - "description": "", + "description": "Whether gross and net prices are linked through the tax configuration.", "type": "boolean" }, + "percentage": { + "description": "Discount percentage relative to the list price for the gross and net amounts. `null` when no list price is set.", + "type": [ + "object", + "null" + ], + "properties": { + "gross": { + "description": "Discount percentage relative to the gross list price.", + "type": "number" + }, + "net": { + "description": "Discount percentage relative to the net list price.", + "type": "number" + } + }, + "required": [ + "gross", + "net" + ] + }, "listPrice": { - "description": "", + "description": "Reference list price for displaying discounts.", "type": "object", "properties": { "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { - "description": "", + "description": "Gross list price for the associated currency.", "type": "number" }, "net": { - "description": "", + "description": "Net list price for the associated currency.", "type": "number" }, "linked": { - "description": "", + "description": "Whether gross and net list prices are linked through the tax configuration.", "type": "boolean" } }, @@ -110708,23 +110629,24 @@ ] }, "regulationPrice": { - "description": "", + "description": "Reference price used for legal price disclosures.", "type": "object", "properties": { "currencyId": { + "description": "Unique identity of the associated currency.", "type": "string", "pattern": "^[0-9a-f]{32}$" }, "gross": { - "description": "", + "description": "Gross regulation price for the associated currency.", "type": "number" }, "net": { - "description": "", + "description": "Net regulation price for the associated currency.", "type": "number" }, "linked": { - "description": "", + "description": "Whether gross and net regulation prices are linked through the tax configuration.", "type": "boolean" } }, @@ -111887,6 +111809,10 @@ "name": "Document Base Config Sales Channel", "description": "The endpoint for operations on Document Base Config Sales Channel" }, + { + "name": "Document File", + "description": "The endpoint for operations on Document File" + }, { "name": "Document Type", "description": "The endpoint for operations on Document Type" diff --git a/SwagCommercial-adminapi.summary.json b/SwagCommercial-adminapi.summary.json index 7228d8d..071f3b2 100644 --- a/SwagCommercial-adminapi.summary.json +++ b/SwagCommercial-adminapi.summary.json @@ -3,6 +3,8 @@ "/_action/create-employee", "/_action/custom-price", "/_action/invite-employee", + "/_action/media/presign-upload", + "/_action/media/{mediaId}/finalize-upload", "/_action/quote/{quoteId}/comment", "/_action/quote/{quoteId}/lineItem", "/_action/quote/{quoteId}/product/{productId}", @@ -62,6 +64,7 @@ "/aggregate/bundle-item", "/aggregate/custom-price", "/aggregate/customer-specific-features", + "/aggregate/document-file", "/aggregate/media-ai-tag", "/aggregate/order-product-warehouse", "/aggregate/order-return", @@ -78,8 +81,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", @@ -152,6 +153,8 @@ "/custom-price/{id}", "/customer-specific-features", "/customer-specific-features/{id}", + "/document-file", + "/document-file/{id}", "/media-ai-tag", "/media-ai-tag/{id}", "/order-product-warehouse", @@ -189,10 +192,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", @@ -227,6 +226,7 @@ "/search/bundle-item", "/search/custom-price", "/search/customer-specific-features", + "/search/document-file", "/search/media-ai-tag", "/search/order-product-warehouse", "/search/order-return", @@ -243,8 +243,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", @@ -466,6 +464,8 @@ "DocumentBaseConfigJsonApi", "DocumentBaseConfigSalesChannel", "DocumentBaseConfigSalesChannelJsonApi", + "DocumentFile", + "DocumentFileJsonApi", "DocumentJsonApi", "DocumentType", "DocumentTypeJsonApi", From da1833e9d86fcb26a0b44036e7634c4042d3dce8 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 4 May 2026 13:59:26 +0200 Subject: [PATCH 63/63] [create-pull-request] automated change (#492) Co-authored-by: shopwareBot --- adminapi.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/adminapi.json b/adminapi.json index 5c70bb4..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.9.0" + "version": "6.7.9.1" }, "servers": [ { @@ -106476,6 +106476,9 @@ "$ref": "#/components/schemas/Price" } }, + "customFields": { + "type": "object" + }, "quantityStart": { "description": "Starting range of quantity of an item.", "type": "integer", @@ -106486,9 +106489,6 @@ "type": "integer", "format": "int64" }, - "customFields": { - "type": "object" - }, "createdAt": { "type": "string", "format": "date-time", @@ -106609,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", @@ -106619,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",